Description

Create one or multiple scheduled fulfillments.

Permission bit: "scheduled_fulfillments.create"

Topic: Scheduled Fulfillments

Arguments

data: [ScheduledFulfillmentCreate!]!

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"

Data Argument Fields

email: Boolean

Whether to notify customer about fulfillment creation or not

Example: false

line_items: [ScheduledFulfillmentLineItemCreate!]!

Array of line items associated with the fulfillment

name: String

Human-friendly description of the scheduled fulfillment

Example: "Pending fulfillment as per subscription schedule"

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

pickup_inventory_location_id: String

Destination pickup inventory location

Valid when: pickup_inventory_location_id matches regexp pattern: ^il_

scheduled_at: String

Date and time this fulfillment is scheduled for

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

shipping_provider_type: ShippingProviderType

Type of the shipping provider

subscription_id: String

Subscription associated with this scheduled fulfillment

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

[ScheduledFulfillment!]

Preview (typescript)

Loading module