Skip to main content

AllocateFulfillmentInput

Autogenerated input type of AllocateFulfillment

input AllocateFulfillmentInput {
  allocationInformation: JSON!
  brandId: ID
  clientMutationId: String
  externalId: String
  fulfillmentContainers: [JSON!]
  fulfillmentId: ID
  fulfillmentIntegrationId: ID
  fulfillmentItems: [JSON!]
  fulfillmentOrderNumber: String
  metadata: JSON
  orderId: ID!
  warehouseId: ID!
}

Fields​

AllocateFulfillmentInput.allocationInformation ● JSON! non-null scalar​

Information about the inventory allocation for this fulfillment.

AllocateFulfillmentInput.brandId ● ID scalar​

The brand ID. This parameter is optional, but if not provided, you should provide the header 'X-Brand-Id' with the brand ID.

AllocateFulfillmentInput.clientMutationId ● String scalar​

A unique identifier for the client performing the mutation.

AllocateFulfillmentInput.externalId ● String scalar​

External system reference ID for this fulfillment.

AllocateFulfillmentInput.fulfillmentContainers ● [JSON!] list scalar​

The containers that are part of the fulfillment.

AllocateFulfillmentInput.fulfillmentId ● ID scalar​

The ID of an existing fulfillment to allocate. If provided, the fulfillment must be in 'draft' state. If not provided, a new fulfillment will be created in 'allocated' state.

AllocateFulfillmentInput.fulfillmentIntegrationId ● ID scalar​

The ID of the fulfillment integration to use for this fulfillment.

AllocateFulfillmentInput.fulfillmentItems ● [JSON!] list scalar​

The items that are part of the fulfillment. Each item should include an allocation_item_id.

AllocateFulfillmentInput.fulfillmentOrderNumber ● String scalar​

Custom fulfillment order number.

AllocateFulfillmentInput.metadata ● JSON scalar​

The metadata that is part of the fulfillment. This metadata can be used to store additional information about the fulfillment.

AllocateFulfillmentInput.orderId ● ID! non-null scalar​

The ID of the order to allocate a fulfillment for. The order must be in 'accepted' state.

AllocateFulfillmentInput.warehouseId ● ID! non-null scalar​

The ID of the warehouse where the fulfillment will be processed.

Member Of​

allocateFulfillment mutation