Skip to main content

RegisterWarehouseInput

Autogenerated input type of RegisterWarehouse

input RegisterWarehouseInput {
  address: AddressInput
  brandId: ID @deprecated
  clientMutationId: String
  companyId: ID
  default: Boolean
  email: Email
  externalData: WarehouseExternalDataInput
  fulfillmentIntegrationId: ID
  managed: Boolean @deprecated
  name: String!
  priority: Int
  processFulfillments: Boolean @deprecated
  residential: Boolean
  sourceFulfillmentIntegrationId: ID
  sourceIntegrationId: ID
  status: StatusEnum
}

Fields​

RegisterWarehouseInput.address ● AddressInput input common​

The address of the warehouse as a structured input.

RegisterWarehouseInput.brandId ● ID deprecated scalar common​

DEPRECATED

This argument will be removed in the future. Brand is becoming a product-only attribute. Use company context instead. If provided, warehouse will be registered in brand's company context.

The ID of the brand that the warehouse belongs to.

RegisterWarehouseInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

RegisterWarehouseInput.companyId ● ID scalar common​

The ID of the company that owns the warehouse. Performer must be a member of the company and be allowed to register a warehouse for it.

RegisterWarehouseInput.default ● Boolean scalar common​

Whether the warehouse is the default warehouse for the brand. If true, the warehouse will be set as the default warehouse for the brand and all other warehouses for the brand will be set to false.

RegisterWarehouseInput.email ● Email scalar common​

The building's primary email address.

RegisterWarehouseInput.externalData ● WarehouseExternalDataInput input warehouses​

External data to be stored with the warehouse.

RegisterWarehouseInput.fulfillmentIntegrationId ● ID scalar common​

The ID of the fulfillment integration used by the warehouse.

RegisterWarehouseInput.managed ● Boolean deprecated scalar common​

DEPRECATED

Legacy alias for processFulfillments.

Whether the warehouse is managed by the system.

RegisterWarehouseInput.name ● String! non-null scalar common​

The name of the warehouse.

RegisterWarehouseInput.priority ● Int scalar common​

The priority of the warehouse. Warehouses with higher priority are used first.

RegisterWarehouseInput.processFulfillments ● Boolean deprecated scalar common​

DEPRECATED

V2 fulfillment shipment rules use allocationRequired on the fulfillment.

Legacy setting for whether Endless actively processes fulfillments for this building.

RegisterWarehouseInput.residential ● Boolean scalar common​

Whether the warehouse is a residential building, such as a house or apartment.

RegisterWarehouseInput.sourceFulfillmentIntegrationId ● ID scalar common​

The ID of the integration that is the source of fulfillment data for this warehouse. Cannot be set alongside fulfillment_integration_id.

RegisterWarehouseInput.sourceIntegrationId ● ID scalar common​

The ID of the source integration that manages the warehouse.

RegisterWarehouseInput.status ● StatusEnum enum common​

Member Of​

registerWarehouse mutation