API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

fulfillmentCreate mutation

Version unstable

Deprecation warning

Use the new fulfillmentOrder APIs to manage fulfillments.

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

Argument Description
input ( FulfillmentInput! ) required

The input fields used to create a fulfillment.

FulfillmentInput fields

  • createAsOpen (Boolean)

    Indicates whether fulfillment should be created in an OPEN state.

  • 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 2021-04 (Release candidate)

Deprecation warning

Use the new fulfillmentOrder APIs to manage fulfillments.

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

Argument Description
input ( FulfillmentInput! ) required

The input fields used to create a fulfillment.

FulfillmentInput 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 2021-01 (Latest)

Deprecation warning

Use the new fulfillmentOrder APIs to manage fulfillments.

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

Argument Description
input ( FulfillmentInput! ) required

The input fields used to create a fulfillment.

FulfillmentInput 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 2020-10

Deprecation warning

Use the new fulfillmentOrder APIs to manage fulfillments.

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

Argument Description
input ( FulfillmentInput! ) required

The input fields used to create a fulfillment.

FulfillmentInput 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 2020-07

Deprecation warning

Use the new fulfillmentOrder APIs to manage fulfillments.

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

Argument Description
input ( FulfillmentInput! ) required

The input fields used to create a fulfillment.

FulfillmentInput 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 2020-04

Deprecation warning

Use the new fulfillmentOrder APIs to manage fulfillments.

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

Argument Description
input ( FulfillmentInput! ) required

The input fields used to create a fulfillment.

FulfillmentInput 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 2020-01 (Unsupported)

Deprecation warning

Use the new fulfillmentOrder APIs to manage fulfillments.

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

Argument Description
input ( FulfillmentInput! ) required

The input fields used to create a fulfillment.

FulfillmentInput 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 (Unsupported)

Deprecation warning

Use the new fulfillmentOrder APIs to manage fulfillments.

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

Argument Description
input ( FulfillmentInput! ) required

The input fields used to create a fulfillment.

FulfillmentInput 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 (Unsupported)

Deprecation warning

Use the new fulfillmentOrder APIs to manage fulfillments.

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

Argument Description
input ( FulfillmentInput! ) required

The input fields used to create a fulfillment.

FulfillmentInput 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-04 (Unsupported)

Deprecation warning

Use the new fulfillmentOrder APIs to manage fulfillments.

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

Argument Description
input ( FulfillmentInput! ) required

The input fields used to create a fulfillment.

FulfillmentInput 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.