fulfillmentOrderSubmitFulfillmentRequest mutation

Sends a fulfillment request to the fulfillment service of a fulfillment order.

Required access

write_third_party_fulfillment_orders access scope.

On this page

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.

mutation fulfillmentOrderSubmitFulfillmentRequest($id: ID!) { fulfillmentOrderSubmitFulfillmentRequest(id: $id) { 
  1. <font style="color:#1F61A0;">originalFulfillmentOrder</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">submittedFulfillmentOrder</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">id</font>
  11. <font style="color:#555555;">}</font>
  13. <font style="color:#1F61A0;">unsubmittedFulfillmentOrder</font> <font style="color:#555555;">{</font>
  15.   <font style="color:#1F61A0;">id</font>
  17. <font style="color:#555555;">}</font>
  19. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  21.   <font style="color:#1F61A0;">field</font>
  23.   <font style="color:#1F61A0;">message</font>
  25. <font style="color:#555555;">}</font>
} } { “id”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=” }

Arguments

Argument Description
fulfillmentOrderLineItems
(
[[FulfillmentOrderLineItemInput!]](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillmentorderlineiteminput)

)		 The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment.
id
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID of the fulfillment order associated with fulfillment request.
message
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 An optional message for the fulfillment request.
notifyCustomer
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Whether the customer should be notified when fulfillments are created for this fulfillment order.
shippingMethod
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 A reference to the ShippingMethod code, such as FREE_SHIPPING.

FulfillmentOrderLineItemInput fields

  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)) REQUIRED
    The ID of the fulfillment order line item.
  • quantity ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)) REQUIRED
    The quantity of the fulfillment order line item.

Return fields

  • originalFulfillmentOrder ([FulfillmentOrder](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillmentorder))
    The original fulfillment order intended to request fulfillment for.
  • submittedFulfillmentOrder ([FulfillmentOrder](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillmentorder))
    The fulfillment order that was submitted to the fulfillment service. This will be the same as the original fulfillment order field. The exception to this is partial fulfillment requests or fulfillment request for cancelled or incomplete fulfillment orders.
  • unsubmittedFulfillmentOrder ([FulfillmentOrder](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillmentorder))
    This field will only be present for partial fulfillment requests. This will represent the new fulfillment order with the remaining line items not submitted to the fulfillment service.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.