fulfillmentCreate mutation

Deprecation warning

Use the new fulfillmentOrder APIs to manage fulfillments.

Creates a fulfillment for an order.

Required access

write_fulfillments access scope.

On this page

• Interactive example
• Arguments
• FulfillmentInput fields
• Return fields

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.

<font style="color:#1F61A0;">fulfillment</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">id</font>
<font style="color:#555555;">}</font>
<font style="color:#1F61A0;">order</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">id</font>
<font style="color:#555555;">}</font>
<font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">field</font>
  <font style="color:#1F61A0;">message</font>
<font style="color:#555555;">}</font>

<font style="color:#8B2BB9;">"orderId"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font><font style="color:#555555;">,</font>
<font style="color:#8B2BB9;">"locationId"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font>

Arguments

FulfillmentInput fields

• lineItems ([[FulfillmentLineItemInput!]](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillmentlineiteminput))
  The line items to be fulfilled.
• locationId ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)) REQUIRED
  The ID of the location from which the items will be fulfilled.
• notifyCustomer ([Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the customer is notified. If set to true, a notification is sent when the fulfillment is created.
• orderId ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)) REQUIRED
  The ID of the order to be fulfilled.
• shippingMethod ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  A reference to the shipping method, such as Free Shipping.
• trackingCompany ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The name of the tracking company.
• trackingNumbers ([[String!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Tracking numbers associated with the fulfillment.
• trackingUrls ([[String!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The URLs to track the fulfillment.

Return fields

• fulfillment ([Fulfillment](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillment))
  The created fulfillment.
• order ([Order](https://shopify.dev/docs/admin-api/graphql/reference/orders/order))
  The order for which the fulfillment is created.
• userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
  List of errors that occurred executing the mutation.