fulfillmentCreate
mutation

Choose a version:

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 many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.

Anchor to section titled 'Arguments'

Arguments

Anchor to fulfillment fulfillment FulfillmentInput! required: The input fields used to create a fulfillment from fulfillment orders.
Anchor to message message String: An optional message for the fulfillment request.

Was this section helpful?

Anchor to section titled 'FulfillmentCreatePayload returns'

FulfillmentCreatePayload returns

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

Was this section helpful?

Code examples for MUTATION: fulfillmentCreate

Query Reference for MUTATION: fulfillmentCreate

"mutation fulfillmentCreate($fulfillment: FulfillmentInput!) {\n  fulfillmentCreate(fulfillment: $fulfillment) {\n    fulfillment {\n      # Fulfillment fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: fulfillmentCreate

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

Schema Reference for MUTATION: fulfillmentCreate

"input FulfillmentInput {\n  lineItemsByFulfillmentOrder: [FulfillmentOrderLineItemsInput!]!\n  notifyCustomer: Boolean\n  originAddress: FulfillmentOriginAddressInput\n  trackingInfo: FulfillmentTrackingInput\n}\n\ninput FulfillmentOrderLineItemsInput {\n  fulfillmentOrderId: ID!\n  fulfillmentOrderLineItems: [FulfillmentOrderLineItemInput!]\n}\n\ninput FulfillmentOriginAddressInput {\n  address1: String\n  address2: String\n  city: String\n  countryCode: String!\n  provinceCode: String\n  zip: String\n}\n\ninput FulfillmentTrackingInput {\n  company: String\n  number: String\n  numbers: [String!]\n  url: URL\n  urls: [URL!]\n}\n"

Display Examples for MUTATION: fulfillmentCreate

[]

fulfillmentCreatemutation

Arguments

FulfillmentCreatePayload returns

fulfillmentCreate
mutation