Skip to main content

sendFulfillment

Sends a fulfillment in the V2 fulfillments state machine.

Sends a fulfillment for orders in the "accepted" state that have been allocated. The fulfillment will transition from "allocated" to "sent" state when sent to the fulfillment integration.

Requirements​

  • User must have send_fulfillment permission
  • Valid brand context must be provided (via argument or X-Brand-Id header)
  • Order must exist and be in "accepted" state (for V2 orders)
  • Fulfillment must exist and be in "allocated" state
  • Fulfillment integration must exist and be active
  • Fulfillment integration ID is required

Arguments​

  • fulfillment_id (required): The ID of the fulfillment to send
  • order_id (required): The ID of the order the fulfillment belongs to
  • warehouse_id (required): The ID of the warehouse where the fulfillment is processed
  • fulfillment_integration_id (required): The ID of the fulfillment integration to send to
  • external_id (optional): External system reference ID returned from the integration
  • metadata (optional): JSON metadata for the fulfillment

Behavior​

  • Sends fulfillment with "sent" status
  • Updates fulfillment_integration_id and external_id
  • Returns the sent fulfillment
sendFulfillment(
  input: SendFulfillmentInput!
): OrderFulfillment!

Arguments​

sendFulfillment.input ● SendFulfillmentInput! non-null input​

Parameters for SendFulfillment

Type​

OrderFulfillment object​

This type represents an order fulfillment. An order can have multiple fulfillments, each one associated with a warehouse and a party that fulfilled the order.