Choose a version:

fulfillmentCreate

mutation

Requires write_assigned_fulfillment_orders access scope, write_merchant_managed_fulfillment_orders access scope or write_third_party_fulfillment_orders access scope. Also: The user must have fulfill_and_ship_orders permission.

Creates a fulfillment for one or more FulfillmentOrder objects. The fulfillment orders are associated with the same Order and are assigned to the same Location.

Use this mutation to mark items as fulfilled when they're ready to ship. You can specify tracking information, customer notification preferences, and which FulfillmentOrderLineItem objects to fulfill from each fulfillment order. If you don't specify line items, then the mutation fulfills all items in the fulfillment order.

Learn more about building fulfillment solutions.

Anchor to Arguments

Arguments

Anchor to fulfillmentfulfillment

•FulfillmentInput!

required

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

Anchor to messagemessage

•String

An optional message for the fulfillment request.

Was this section helpful?

Anchor to FulfillmentCreatePayload returnsFulfillmentCreatePayload returns

Anchor to fulfillmentfulfillment •Fulfillment: The created fulfillment.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

fulfillmentCreate reference

Mutation Reference

mutation fulfillmentCreate($fulfillment: FulfillmentInput!, $message: String) {

fulfillmentCreate(fulfillment: $fulfillment, message: $message) {

fulfillment {

# Fulfillment fields

}

userErrors {

field

message

}

Input

{

"fulfillment": {

"trackingInfo": {

"number": "<your-number>",

"url": "https://example.myshopify.com",

"company": "<your-company>",

"numbers": [

"<your-numbers>"

"urls": [

"https://example.myshopify.com"

]

"notifyCustomer": true,

"lineItemsByFulfillmentOrder": [

{

"fulfillmentOrderId": "gid://shopify/<objectName>/10079785100",

"fulfillmentOrderLineItems": [

{}

]

}

"originAddress": {

"address1": "<your-address1>",

"address2": "<your-address2>",

"city": "<your-city>",

"zip": "<your-zip>",

"provinceCode": "<your-provinceCode>",

"countryCode": "<your-countryCode>"

}

"message": "<your-message>"

}

Variables

{
  "fulfillment": {
    "trackingInfo": {
      "number": "<your-number>",
      "url": "https://example.myshopify.com",
      "company": "<your-company>",
      "numbers": [
        "<your-numbers>"
      ],
      "urls": [
        "https://example.myshopify.com"
      ]
    },
    "notifyCustomer": true,
    "lineItemsByFulfillmentOrder": [
      {
        "fulfillmentOrderId": "gid://shopify/<objectName>/10079785100",
        "fulfillmentOrderLineItems": [
          {}
        ]
      }
    ],
    "originAddress": {
      "address1": "<your-address1>",
      "address2": "<your-address2>",
      "city": "<your-city>",
      "zip": "<your-zip>",
      "provinceCode": "<your-provinceCode>",
      "countryCode": "<your-countryCode>"
    }
  },
  "message": "<your-message>"
}

Schema

input FulfillmentInput {
  trackingInfo: FulfillmentTrackingInput
  notifyCustomer: Boolean
  lineItemsByFulfillmentOrder: [FulfillmentOrderLineItemsInput!]!
  originAddress: FulfillmentOriginAddressInput
}

input FulfillmentTrackingInput {
  number: String
  url: URL
  company: String
  numbers: [String!]
  urls: [URL!]
}

input FulfillmentOrderLineItemsInput {
  fulfillmentOrderId: ID!
  fulfillmentOrderLineItems: [FulfillmentOrderLineItemInput!]
}

input FulfillmentOriginAddressInput {
  address1: String
  address2: String
  city: String
  zip: String
  provinceCode: String
  countryCode: String!
}