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

FulfillmentInput input object

Version unstable

The input fields used to create a fulfillment.

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

Version 2021-01 (Release candidate)

The input fields used to create a fulfillment.

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

Version 2020-10 (Latest)

The input fields used to create a fulfillment.

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

Version 2020-07

The input fields used to create a fulfillment.

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

Version 2020-04

The input fields used to create a fulfillment.

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

Version 2020-01

The input fields used to create a fulfillment.

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

Version 2019-10 (Unsupported)

The input fields used to create a fulfillment.

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

Version 2019-07 (Unsupported)

The input fields used to create a fulfillment.

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

Version 2019-04 (Unsupported)

The input fields used to create a fulfillment.

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