fulfillmentCreateV2 mutation

Version 2020-04 (Release candidate)

Creates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

fulfillment ( FulfillmentV2Input! ) required

The input fields used to create a fulfillment from fulfillment orders.

message ( String )

An optional message for the fulfillment request.

FulfillmentV2Input fields

lineItemsByFulfillmentOrder ([FulfillmentOrderLineItemsInput!]!) Required

Pairs of fulfillment_order_id and fulfillment_order_line_items that represent the fulfillment order line items that have to be fulfilled for each fulfillment order. For any given pair, if the fulfillment order line items are left blank then all the fulfillment order line items of the associated fulfillment order ID will be fulfilled.

notifyCustomer (Boolean)

Whether the customer is notified. If set to true, a notification is sent when the fulfillment is created.

trackingInfo (FulfillmentTrackingInput)

The fulfillment's tracking information, including a tracking URL, a tracking number, and the company associated with the fulfillment.

Return fields

fulfillment (Fulfillment)

The created fulfillment.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-01 (Latest)

Creates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

fulfillment ( FulfillmentV2Input! ) required

The input fields used to create a fulfillment from fulfillment orders.

message ( String )

An optional message for the fulfillment request.

FulfillmentV2Input fields

lineItemsByFulfillmentOrder ([FulfillmentOrderLineItemsInput!]!) Required

Pairs of fulfillment_order_id and fulfillment_order_line_items that represent the fulfillment order line items that have to be fulfilled for each fulfillment order. For any given pair, if the fulfillment order line items are left blank then all the fulfillment order line items of the associated fulfillment order ID will be fulfilled.

notifyCustomer (Boolean)

Whether the customer is notified. If set to true, a notification is sent when the fulfillment is created.

trackingInfo (FulfillmentTrackingInput)

The fulfillment's tracking information, including a tracking URL, a tracking number, and the company associated with the fulfillment.

Return fields

fulfillment (Fulfillment)

The created fulfillment.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.