You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Current »
Fulfillment orders
List of of all fulfillment orders. Returns fulfillment orders assigned to merchant-managed locations, third-party fulfillment service locations, or all kinds of locations together.
Field | Description |
---|
Created at | Date and time when the fulfillment order was created. |
Fulfill at | The date and time at which the fulfillment order will be fulfillable. |
Fulfill by | The latest date and time by which all items in the fulfillment order need to be fulfilled. |
ID | Globally unique ID. |
Request status | The request status of the fulfillment order. |
Status | The status of the fulfillment order. |
Updated at | The date and time when the fulfillment order was last updated. |
Fulfillment orders / Delivery method
Delivery method of this fulfillment order.
Field | Description |
---|
ID | Globally unique ID. |
Max delivery date time | The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location. |
Method type | The type of the delivery method. |
Min delivery date time | The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location. |
Fulfillment orders / Destination
The destination where the items should be sent.
Field | Description |
---|
Address 1 | The first line of the address of the destination. |
Address 2 | The second line of the address of the destination. |
City | The city of the destination. |
Company | The company of the destination. |
Country code | The two-letter country code of the destination. |
Email | The email of the customer at the destination. |
First name | The first name of the customer at the destination. |
ID | Globally unique ID. |
Last name | The last name of the customer at the destination. |
Phone | The phone number of the customer at the destination. |
Province | The province of the destination. |
Zip | The ZIP code of the destination. |
Fulfillment orders / Fulfillment holds
The fulfillment holds applied on the fulfillment order.
Field | Description |
---|
Reason | The reason for the fulfillment hold. |
Reason notes | Additional information about the fulfillment hold reason. |
Fulfillment orders / Fulfillments
A list of fulfillments for the fulfillment order.
Field | Description |
---|
Created at | The date and time when the fulfillment was created. |
Delivered at | The date that this fulfillment was delivered. |
Display status | Human readable display status for this fulfillment. |
Estimated delivery at | The estimated date that this fulfillment will arrive. |
In transit at | The date and time when the fulfillment went into transit. |
Legacy resource ID | The ID of the corresponding resource in the REST Admin API. |
Name | Human readable reference identifier for this fulfillment. |
Requires shipping | Whether any of the line items in the fulfillment require shipping. |
Status | The status of the fulfillment. |
Total quantity | Sum of all line item quantities for the fulfillment. |
Updated at | The date and time when the fulfillment was last modified. |
Fulfillment orders / International duties
The duties delivery method of this fulfillment order.
Field | Description |
---|
Incoterm | The method of duties payment. Example values: DDP, DAP. |
Fulfillment orders / Line items
A list of the fulfillment order's line items.
Field | Description |
---|
Inventory Item Id | The ID of the inventory item. |
Product title | The title of the product. |
Remaining quantity | The number of units remaining to be fulfilled. |
Requires shipping | Whether physical shipping is required for the variant |
SKU | The variant SKU number. |
Total quantity | The total number of units to be fulfilled. |
Variant title | The name of the variant. |
Vendor | The name of the vendor who made the variant. |
Fulfillment orders / Line items / Original unit price set
The variant unit price without discounts applied, in shop and presentment currencies.
Field | Description |
---|
Presentment money amount | Amount in presentment currency. |
Presentment money currency code | Currency code of the amount in presentment currency. |
Shop money amount | Amount in shop currency. |
Shop money currency code | Currency code of the amount in shop currency. |
Fulfillment orders / Line items / Warnings
A list of the fulfillment order's line item warnings.
Field | Description |
---|
Description | The description of warning. |
Title | The title of warning. |
Fulfillment orders / Line items / Weight
A list of the fulfillment order's line items weight.
Field | Description |
---|
Weight Unit | The unit of measurement for `value`. |
Weight Value | The weight value using the unit system specified with `unit`. |
Fulfillment orders / Order
The order that's associated with the fulfillment order.
Field | Description |
---|
Order ID | Globally unique ID. |
Fulfillment orders / Supported actions
The actions that can be performed on this fulfillment order.
Field | Description |
---|
Action | The action value. |
External URL | The external URL to be used to initiate the fulfillment process outside Shopify. |