Description

Create one or multiple fulfillments.

If you don't specify quantity in line items, the default is all fulfillable quantity.

If you don't specify line items at all, it is assumed that you want to ship everything that corresponds to order. Most shops will ship things in one go and they don't need to think about complexity of shipping things in multiple steps this way.

The fulfillment will be applied immediately if it's correct, otherwise it will be created in a "cancelled" state.

Use "type" to restrict automatic fulfillment to a particular type. By default it will do "physical".

Permission bit: "fulfillments.create"

Topic: Order Fulfillments

Arguments

data: [OrderFulfillmentCreate!]!

Main argument for mutations.

order_id: String!

Unique order identifier. See also: Unique Identifiers

Example: "or_EQzGqWoY"

shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"

type: FulfillmentType

When automatically creating a fulfillment, use only items from given category

Example: "physical"

Data Argument Fields

email: Boolean

Whether to notify customer about fulfillment creation or not

Example: false

line_items: [OrderFulfillmentLineItemCreate!]

Array of line items associated with the fulfillment

pickup_inventory_location_id: String

Destination pickup inventory location

Valid when: pickup_inventory_location_id matches regexp pattern: ^il_

scheduled_fulfillment_id: String

Scheduled fulfillment to use when creating this fulfillment. Requires scheduled_fulfillment_line_items.

Valid when: scheduled_fulfillment_id matches regexp pattern: ^sf_

scheduled_fulfillment_line_items: [ScheduledFulfillmentReserveLineItemCreate!]

Specifies where to allocate unreserved items at

shipping_provider_type: ShippingProviderType

Type of the shipping provider

subscription_id: String

This fulfullment is associated with the given subscription.

Valid when: subscription_id matches regexp pattern: ^ss_

tracking_company: String

The name of the shipping company

Example: "Ship & Co"

Valid when: tracking_company's length doesn't exceed 250 characters

tracking_number: String

Shipping number, provided by the shipping company

Example: "1Z2345"

Valid when: tracking_number's length doesn't exceed 250 characters

tracking_url: String

The URLs to track the fulfillment

Example: "http://www.google.com/search?q=1Z2345"

Valid when: tracking_url's length doesn't exceed 250 characters

Result

[OrderFulfillment!]

Preview (typescript)

Loading module