FulfillmentOrder
The FulfillmentOrder resource represents either an item or a group of items in an order that are to be fulfilled from the same location. There can be more than one fulfillment order for an order at a given location.
What you can do with FulfillmentOrder
The Shopify API lets you do the following with the FulfillmentOrder resource. More detailed versions of these general actions may be available:
- GET /admin/api/2020-01/orders/{order_id}/fulfillment_orders.json Retrieves a list of fulfillment orders for a specific order
- GET /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}.json Retrieves a specific fulfillment order
- POST /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancel.json Cancel a fulfillment order
- POST /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/close.json Marks a fulfillment order as incomplete
- POST /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/move.json Moves a fulfillment order to a new location
FulfillmentOrder properties
assigned_location_id |
The ID of the location that has been assigned to do the work. |
destination |
The destination where the items should be sent.
|
id |
An ID for the fulfillment order. |
line_items |
Represents line items belonging to a fulfillment order:
|
order_id |
The ID of the order that's associated with the fulfillment order. |
request_status |
The request status of the fulfillment order. Valid values:
|
shop_id |
The ID of the shop that's associated with the fulfillment order. |
status |
The status of the fulfillment order. Valid values:
|
supported_actions |
The actions that can be performed on this fulfillment order. |
merchant_requests |
A list of requests sent by the merchant to the fulfillment service for this fulfillment order.
|
assigned_location |
The fulfillment order's assigned location. This is the location expected to perform fulfillment.
|
Endpoints
order_id
|
The ID of the order that is associated with the fulfillment orders. |
Retrieve a list of all fulfillment orders for an order
GET /admin/api/2020-01/orders/450789469/fulfillment_orders.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_orders": [
{
"id": 1046000823,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578657,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578672,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
]
}
Get a single fulfillment order by its ID
GET /admin/api/2020-01/fulfillment_orders/1046000824.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000824,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578658,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578673,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
Cancel a fulfillment order
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000825,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "submitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578659,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578674,
"shop_id": 690933842,
"fulfillment_order_id": 1046000825,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
},
"replacement_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578660,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578675,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
message
|
An optional reason for marking the fulfillment order as incomplete. |
Transition a fulfillment order from in progress to incomplete
POST /admin/api/2020-01/fulfillment_orders/1046000828/close.json
{
"fulfillment_order": {
"message": "Not enough inventory to complete this work."
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000828,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "closed",
"status": "incomplete",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578662,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
new_location_id
|
The id of the location to which the fulfillment order will be moved. |
Move a fulfillment order to a new location
POST /admin/api/2020-01/fulfillment_orders/1046000829/move.json
{
"fulfillment_order": {
"new_location_id": 905684977
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000829,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 487838322,
"fulfillment_service_handle": "manual",
"request_status": "submitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578663,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000829,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
},
"moved_fulfillment_order": {
"id": 1046000830,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 905684977,
"fulfillment_service_handle": "manual",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"create_fulfillment",
"move"
],
"destination": {
"id": 1025578664,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000830,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": "50 Rideau Street",
"address2": null,
"city": "Ottawa",
"country_code": "CA",
"location_id": 905684977,
"name": "50 Rideau Street",
"phone": null,
"province": "Ontario",
"zip": "K1N 9J7"
},
"merchant_requests": []
},
"remaining_fulfillment_order": null
}
The FulfillmentOrder resource represents either an item or a group of items in an order that are to be fulfilled from the same location. There can be more than one fulfillment order for an order at a given location.
What you can do with FulfillmentOrder
The Shopify API lets you do the following with the FulfillmentOrder resource. More detailed versions of these general actions may be available:
- GET /admin/api/2020-04/orders/{order_id}/fulfillment_orders.json Retrieves a list of fulfillment orders for a specific order
- GET /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}.json Retrieves a specific fulfillment order
- POST /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancel.json Cancel a fulfillment order
- POST /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/close.json Marks a fulfillment order as incomplete
- POST /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/move.json Moves a fulfillment order to a new location
FulfillmentOrder properties
assigned_location_id |
The ID of the location that has been assigned to do the work. |
destination |
The destination where the items should be sent.
|
id |
An ID for the fulfillment order. |
line_items |
Represents line items belonging to a fulfillment order:
|
order_id |
The ID of the order that's associated with the fulfillment order. |
request_status |
The request status of the fulfillment order. Valid values:
|
shop_id |
The ID of the shop that's associated with the fulfillment order. |
status |
The status of the fulfillment order. Valid values:
|
supported_actions |
The actions that can be performed on this fulfillment order. |
merchant_requests |
A list of requests sent by the merchant to the fulfillment service for this fulfillment order.
|
assigned_location |
The fulfillment order's assigned location. This is the location expected to perform fulfillment.
|
Endpoints
order_id
|
The ID of the order that is associated with the fulfillment orders. |
Retrieve a list of all fulfillment orders for an order
GET /admin/api/2020-04/orders/450789469/fulfillment_orders.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_orders": [
{
"id": 1046000823,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578657,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578672,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
]
}
Get a single fulfillment order by its ID
GET /admin/api/2020-04/fulfillment_orders/1046000824.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000824,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578658,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578673,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
Cancel a fulfillment order
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000825,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "submitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578659,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578674,
"shop_id": 690933842,
"fulfillment_order_id": 1046000825,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
},
"replacement_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578660,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578675,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
message
|
An optional reason for marking the fulfillment order as incomplete. |
Transition a fulfillment order from in progress to incomplete
POST /admin/api/2020-04/fulfillment_orders/1046000828/close.json
{
"fulfillment_order": {
"message": "Not enough inventory to complete this work."
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000828,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "closed",
"status": "incomplete",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578662,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
new_location_id
|
The id of the location to which the fulfillment order will be moved. |
Move a fulfillment order to a new location
POST /admin/api/2020-04/fulfillment_orders/1046000829/move.json
{
"fulfillment_order": {
"new_location_id": 905684977
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000829,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 487838322,
"fulfillment_service_handle": "manual",
"request_status": "submitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578663,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000829,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
},
"moved_fulfillment_order": {
"id": 1046000830,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 905684977,
"fulfillment_service_handle": "manual",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"create_fulfillment",
"move"
],
"destination": {
"id": 1025578664,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000830,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": "50 Rideau Street",
"address2": null,
"city": "Ottawa",
"country_code": "CA",
"location_id": 905684977,
"name": "50 Rideau Street",
"phone": null,
"province": "Ontario",
"zip": "K1N 9J7"
},
"merchant_requests": []
},
"remaining_fulfillment_order": null
}
The FulfillmentOrder resource represents either an item or a group of items in an order that are to be fulfilled from the same location. There can be more than one fulfillment order for an order at a given location.
What you can do with FulfillmentOrder
The Shopify API lets you do the following with the FulfillmentOrder resource. More detailed versions of these general actions may be available:
- GET /admin/api/2020-07/orders/{order_id}/fulfillment_orders.json Retrieves a list of fulfillment orders for a specific order
- GET /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}.json Retrieves a specific fulfillment order
- POST /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancel.json Cancel a fulfillment order
- POST /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/close.json Marks a fulfillment order as incomplete
- POST /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/move.json Moves a fulfillment order to a new location
FulfillmentOrder properties
assigned_location_id |
The ID of the location that has been assigned to do the work. |
destination |
The destination where the items should be sent.
|
id |
An ID for the fulfillment order. |
line_items |
Represents line items belonging to a fulfillment order:
|
order_id |
The ID of the order that's associated with the fulfillment order. |
request_status |
The request status of the fulfillment order. Valid values:
|
shop_id |
The ID of the shop that's associated with the fulfillment order. |
status |
The status of the fulfillment order. Valid values:
|
supported_actions |
The actions that can be performed on this fulfillment order. |
merchant_requests |
A list of requests sent by the merchant to the fulfillment service for this fulfillment order.
|
assigned_location |
The fulfillment order's assigned location. This is the location expected to perform fulfillment.
|
Endpoints
order_id
|
The ID of the order that is associated with the fulfillment orders. |
Retrieve a list of all fulfillment orders for an order
GET /admin/api/2020-07/orders/450789469/fulfillment_orders.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_orders": [
{
"id": 1046000823,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578657,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578672,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
]
}
Get a single fulfillment order by its ID
GET /admin/api/2020-07/fulfillment_orders/1046000824.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000824,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578658,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578673,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
Cancel a fulfillment order
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000825,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "submitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578659,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578674,
"shop_id": 690933842,
"fulfillment_order_id": 1046000825,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
},
"replacement_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578660,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578675,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
message
|
An optional reason for marking the fulfillment order as incomplete. |
Transition a fulfillment order from in progress to incomplete
POST /admin/api/2020-07/fulfillment_orders/1046000828/close.json
{
"fulfillment_order": {
"message": "Not enough inventory to complete this work."
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000828,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "closed",
"status": "incomplete",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578662,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
new_location_id
|
The id of the location to which the fulfillment order will be moved. |
Move a fulfillment order to a new location
POST /admin/api/2020-07/fulfillment_orders/1046000829/move.json
{
"fulfillment_order": {
"new_location_id": 905684977
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000829,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 487838322,
"fulfillment_service_handle": "manual",
"request_status": "submitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578663,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000829,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
},
"moved_fulfillment_order": {
"id": 1046000830,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 905684977,
"fulfillment_service_handle": "manual",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"create_fulfillment",
"move"
],
"destination": {
"id": 1025578664,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000830,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": "50 Rideau Street",
"address2": null,
"city": "Ottawa",
"country_code": "CA",
"location_id": 905684977,
"name": "50 Rideau Street",
"phone": null,
"province": "Ontario",
"zip": "K1N 9J7"
},
"merchant_requests": []
},
"remaining_fulfillment_order": null
}
The FulfillmentOrder resource represents either an item or a group of items in an order that are to be fulfilled from the same location. There can be more than one fulfillment order for an order at a given location.
What you can do with FulfillmentOrder
The Shopify API lets you do the following with the FulfillmentOrder resource. More detailed versions of these general actions may be available:
- GET /admin/api/2020-10/orders/{order_id}/fulfillment_orders.json Retrieves a list of fulfillment orders for a specific order
- GET /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}.json Retrieves a specific fulfillment order
- POST /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancel.json Cancel a fulfillment order
- POST /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/close.json Marks a fulfillment order as incomplete
- POST /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/move.json Moves a fulfillment order to a new location
FulfillmentOrder properties
assigned_location_id |
The ID of the location that has been assigned to do the work. |
destination |
The destination where the items should be sent.
|
id |
An ID for the fulfillment order. |
line_items |
Represents line items belonging to a fulfillment order:
|
order_id |
The ID of the order that's associated with the fulfillment order. |
request_status |
The request status of the fulfillment order. Valid values:
|
shop_id |
The ID of the shop that's associated with the fulfillment order. |
status |
The status of the fulfillment order. Valid values:
|
supported_actions |
The actions that can be performed on this fulfillment order. |
merchant_requests |
A list of requests sent by the merchant to the fulfillment service for this fulfillment order.
|
assigned_location |
The fulfillment order's assigned location. This is the location expected to perform fulfillment.
|
Endpoints
order_id
|
The ID of the order that is associated with the fulfillment orders. |
Retrieve a list of all fulfillment orders for an order
GET /admin/api/2020-10/orders/450789469/fulfillment_orders.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_orders": [
{
"id": 1046000823,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578657,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578672,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
]
}
Get a single fulfillment order by its ID
GET /admin/api/2020-10/fulfillment_orders/1046000824.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000824,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578658,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578673,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
Cancel a fulfillment order
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000825,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "submitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578659,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578674,
"shop_id": 690933842,
"fulfillment_order_id": 1046000825,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
},
"replacement_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578660,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578675,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
message
|
An optional reason for marking the fulfillment order as incomplete. |
Transition a fulfillment order from in progress to incomplete
POST /admin/api/2020-10/fulfillment_orders/1046000828/close.json
{
"fulfillment_order": {
"message": "Not enough inventory to complete this work."
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000828,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "closed",
"status": "incomplete",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578662,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
new_location_id
|
The id of the location to which the fulfillment order will be moved. |
Move a fulfillment order to a new location
POST /admin/api/2020-10/fulfillment_orders/1046000829/move.json
{
"fulfillment_order": {
"new_location_id": 905684977
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000829,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 487838322,
"fulfillment_service_handle": "manual",
"request_status": "submitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578663,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000829,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
},
"moved_fulfillment_order": {
"id": 1046000830,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 905684977,
"fulfillment_service_handle": "manual",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"create_fulfillment",
"move"
],
"destination": {
"id": 1025578664,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000830,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": "50 Rideau Street",
"address2": null,
"city": "Ottawa",
"country_code": "CA",
"location_id": 905684977,
"name": "50 Rideau Street",
"phone": null,
"province": "Ontario",
"zip": "K1N 9J7"
},
"merchant_requests": []
},
"remaining_fulfillment_order": null
}
The FulfillmentOrder resource represents either an item or a group of items in an order that are to be fulfilled from the same location. There can be more than one fulfillment order for an order at a given location.
What you can do with FulfillmentOrder
The Shopify API lets you do the following with the FulfillmentOrder resource. More detailed versions of these general actions may be available:
- GET /admin/api/2021-01/orders/{order_id}/fulfillment_orders.json Retrieves a list of fulfillment orders for a specific order
- GET /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}.json Retrieves a specific fulfillment order
- POST /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancel.json Cancel a fulfillment order
- POST /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/close.json Marks a fulfillment order as incomplete
- POST /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/move.json Moves a fulfillment order to a new location
- POST /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/open.json Marks the fulfillment order as open
- POST /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/reschedule.json Reschedules the fulfill_at time of a scheduled fulfillment order
FulfillmentOrder properties
assigned_location_id |
The ID of the location that has been assigned to do the work. |
destination |
The destination where the items should be sent.
|
fulfill_at |
The datetime (in UTC) when the fulfillment order is ready for fulfillment.
When this datetime is reached, a |
id |
An ID for the fulfillment order. |
line_items |
Represents line items belonging to a fulfillment order:
|
order_id |
The ID of the order that's associated with the fulfillment order. |
request_status |
The request status of the fulfillment order. Valid values:
|
shop_id |
The ID of the shop that's associated with the fulfillment order. |
status |
The status of the fulfillment order. Valid values:
|
supported_actions |
The actions that can be performed on this fulfillment order. |
merchant_requests |
A list of requests sent by the merchant to the fulfillment service for this fulfillment order.
|
assigned_location |
The fulfillment order's assigned location. This is the location expected to perform fulfillment.
|
Endpoints
order_id
|
The ID of the order that is associated with the fulfillment orders. |
Retrieve a list of all fulfillment orders for an order
GET /admin/api/2021-01/orders/450789469/fulfillment_orders.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_orders": [
{
"id": 1046000823,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578657,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578672,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
]
}
Get a single fulfillment order by its ID
GET /admin/api/2021-01/fulfillment_orders/1046000824.json
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000824,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578658,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578673,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
Cancel a fulfillment order
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000825,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "submitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578659,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578674,
"shop_id": 690933842,
"fulfillment_order_id": 1046000825,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
},
"replacement_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578660,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578675,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
message
|
An optional reason for marking the fulfillment order as incomplete. |
Transition a fulfillment order from in progress to incomplete
POST /admin/api/2021-01/fulfillment_orders/1046000828/close.json
{
"fulfillment_order": {
"message": "Not enough inventory to complete this work."
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000828,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "closed",
"status": "incomplete",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578662,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
new_location_id
|
The id of the location to which the fulfillment order will be moved. |
Move a fulfillment order to a new location
POST /admin/api/2021-01/fulfillment_orders/1046000829/move.json
{
"fulfillment_order": {
"new_location_id": 905684977
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000829,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 487838322,
"fulfillment_service_handle": "manual",
"request_status": "submitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578663,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000829,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
},
"moved_fulfillment_order": {
"id": 1046000830,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 905684977,
"fulfillment_service_handle": "manual",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"create_fulfillment",
"move"
],
"destination": {
"id": 1025578664,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000830,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"assigned_location": {
"address1": "50 Rideau Street",
"address2": null,
"city": "Ottawa",
"country_code": "CA",
"location_id": 905684977,
"name": "50 Rideau Street",
"phone": null,
"province": "Ontario",
"zip": "K1N 9J7"
},
"merchant_requests": []
},
"remaining_fulfillment_order": null
}
fulfill_at
datetime.
Transition a fulfillment order from scheduled to open
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000831,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578665,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"company": null,
"country": "United States",
"email": "bob.norman@hostmail.com",
"first_name": "Bob",
"last_name": "Norman",
"phone": "555-625-1199",
"province": "Kentucky",
"zip": "40202"
},
"line_items": [
{
"id": 1025578680,
"shop_id": 690933842,
"fulfillment_order_id": 1046000831,
"quantity": 1,
"line_item_id": 518995019,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"fulfill_at": null,
"assigned_location": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"merchant_requests": []
}
}
fulfill_at
time of a scheduled fulfillment order.
This endpoint is used to manage the time a scheduled fulfillment order will be marked as ready for fulfillment.
Update the fulfill_at time of a scheduled fulfillment order
POST /admin/api/2021-01/fulfillment_orders/1046000832/reschedule.json
{
"fulfillment_order": {
"new_fulfill_at": "2022-02-01"
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000832,
"shop_id": 690933842,
"order_id": 450789469,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "mars-fulfillment",
"request_status": "unsubmitted",