We're constantly trying to improve your support experience, and your feedback is extremely valuable to us.

Please take a moment to tell us about your experience today.
Sign up for future Help Center user research studies.

fulfillmentCreate

Version 2019-04

Creates a fulfillment for an order.

Required access

write_fulfillments access scope

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

input ( FulfillmentInput! ) required

The input fields used to create a fulfillment.

Input Fields

lineItems ([FulfillmentLineItemInput!])

The line items to be fulfilled.

locationId (ID!) Required

The ID of the location from which the items will be fulfilled.

notifyCustomer (Boolean)

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

orderId (ID!) Required

The ID of the order to be fulfilled.

shippingMethod (String)

A reference to the shipping method, such as Free Shipping.

trackingCompany (String)

The name of the tracking company.

trackingNumbers ([String!])

Tracking numbers associated with the fulfillment.

trackingUrls ([String!])

The URLs to track the fulfillment.

Return Fields

fulfillment (Fulfillment)

The created fulfillment.

order (Order)

The order for which the fulfillment is created.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Latest)

Creates a fulfillment for an order.

Required access

write_fulfillments access scope

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

input ( FulfillmentInput! ) required

The input fields used to create a fulfillment.

Input Fields

lineItems ([FulfillmentLineItemInput!])

The line items to be fulfilled.

locationId (ID!) Required

The ID of the location from which the items will be fulfilled.

notifyCustomer (Boolean)

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

orderId (ID!) Required

The ID of the order to be fulfilled.

shippingMethod (String)

A reference to the shipping method, such as Free Shipping.

trackingCompany (String)

The name of the tracking company.

trackingNumbers ([String!])

Tracking numbers associated with the fulfillment.

trackingUrls ([String!])

The URLs to track the fulfillment.

Return Fields

fulfillment (Fulfillment)

The created fulfillment.

order (Order)

The order for which the fulfillment is created.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Release candidate)

Creates a fulfillment for an order.

Required access

write_fulfillments access scope

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

input ( FulfillmentInput! ) required

The input fields used to create a fulfillment.

Input Fields

lineItems ([FulfillmentLineItemInput!])

The line items to be fulfilled.

locationId (ID!) Required

The ID of the location from which the items will be fulfilled.

notifyCustomer (Boolean)

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

orderId (ID!) Required

The ID of the order to be fulfilled.

shippingMethod (String)

A reference to the shipping method, such as Free Shipping.

trackingCompany (String)

The name of the tracking company.

trackingNumbers ([String!])

Tracking numbers associated with the fulfillment.

trackingUrls ([String!])

The URLs to track the fulfillment.

Return Fields

fulfillment (Fulfillment)

The created fulfillment.

order (Order)

The order for which the fulfillment is created.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up