FulfillmentRequest
Version 2020-01
The FulfillmentRequest resource represents a fulfillment request made by the merchant to a fulfillment service for a fulfillment order.
What you can do with FulfillmentRequest
The Shopify API lets you do the following with the FulfillmentRequest resource. More detailed versions of these general actions may be available:
- POST /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json Sends a fulfillment request
- POST /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json Accepts a fulfillment request
- POST /admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json Rejects a fulfillment request
Endpoints
POST
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json
Sends a fulfillment request to the fulfillment service of a fulfillment order.
| message
|
An optional message for the fulfillment request. |
| fulfillment_order_line_items
|
The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment. |
Sends a fulfillment request to the fulfillment service of a fulfillment order for the specified line items
POST /admin/api/2020-01/fulfillment_orders/1046000823/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please.",
"fulfillment_order_line_items": [
{
"id": 1025578671,
"quantity": 1
},
{
"id": 1025578672,
"quantity": 1
}
]
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000823,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578656,
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578671,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823198,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578672,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823199,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578673,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823200,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
},
"submitted_fulfillment_order": {
"id": 1046000824,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578674,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 1071823198,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578675,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 1071823199,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:34-05:00",
"kind": "fulfillment_request"
}
]
},
"unsubmitted_fulfillment_order": {
"id": 1046000825,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578676,
"shop_id": 690933842,
"fulfillment_order_id": 1046000825,
"quantity": 1,
"line_item_id": 1071823200,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
Sends a fulfillment request to the fulfillment service for all line items on the fulfillment order if fulfillment_order_line_items is left blank
POST /admin/api/2020-01/fulfillment_orders/1046000826/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please."
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 1073459978,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823201,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823202,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823203,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:37-05:00",
"kind": "fulfillment_request"
}
]
},
"submitted_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 1073459978,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823201,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823202,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823203,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:37-05:00",
"kind": "fulfillment_request"
}
]
},
"unsubmitted_fulfillment_order": null
}
POST
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json
Accepts a fulfillment request sent to a fulfillment service for a fulfillment order.
| message
|
An optional reason for accepting the fulfillment request. |
Accepts a fulfillment request sent to a fulfillment service and updates the fulfillment order
POST /admin/api/2020-01/fulfillment_orders/1046000827/fulfillment_request/accept.json
{
"fulfillment_request": {
"message": "We will start processing your fulfillment on the next business day."
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000827,
"shop_id": 690933842,
"order_id": 1073459979,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "accepted",
"status": "in_progress",
"supported_actions": [
"request_cancellation",
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578680,
"shop_id": 690933842,
"fulfillment_order_id": 1046000827,
"quantity": 1,
"line_item_id": 1071823204,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578681,
"shop_id": 690933842,
"fulfillment_order_id": 1046000827,
"quantity": 1,
"line_item_id": 1071823205,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578682,
"shop_id": 690933842,
"fulfillment_order_id": 1046000827,
"quantity": 1,
"line_item_id": 1071823206,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
POST
/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json
Rejects a fulfillment request sent to a fulfillment service for a fulfillment order.
| message
|
An optional reason for rejecting the fulfillment request. |
Rejects a fulfillment request sent to a fulfillment service and updates the fulfillment order
POST /admin/api/2020-01/fulfillment_orders/1046000828/fulfillment_request/reject.json
{
"fulfillment_request": {
"message": "Not enough inventory on hand to complete the work."
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000828,
"shop_id": 690933842,
"order_id": 1073459980,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "rejected",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578661,
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578683,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 1071823207,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578684,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 1071823208,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578685,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 1071823209,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
Version 2020-04
The FulfillmentRequest resource represents a fulfillment request made by the merchant to a fulfillment service for a fulfillment order.
What you can do with FulfillmentRequest
The Shopify API lets you do the following with the FulfillmentRequest resource. More detailed versions of these general actions may be available:
- POST /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json Sends a fulfillment request
- POST /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json Accepts a fulfillment request
- POST /admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json Rejects a fulfillment request
Endpoints
POST
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json
Sends a fulfillment request to the fulfillment service of a fulfillment order.
| message
|
An optional message for the fulfillment request. |
| fulfillment_order_line_items
|
The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment. |
Sends a fulfillment request to the fulfillment service of a fulfillment order for the specified line items
POST /admin/api/2020-04/fulfillment_orders/1046000823/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please.",
"fulfillment_order_line_items": [
{
"id": 1025578671,
"quantity": 1
},
{
"id": 1025578672,
"quantity": 1
}
]
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000823,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578656,
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578671,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823198,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578672,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823199,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578673,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823200,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
},
"submitted_fulfillment_order": {
"id": 1046000824,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578674,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 1071823198,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578675,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 1071823199,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:34-05:00",
"kind": "fulfillment_request"
}
]
},
"unsubmitted_fulfillment_order": {
"id": 1046000825,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578676,
"shop_id": 690933842,
"fulfillment_order_id": 1046000825,
"quantity": 1,
"line_item_id": 1071823200,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
Sends a fulfillment request to the fulfillment service for all line items on the fulfillment order if fulfillment_order_line_items is left blank
POST /admin/api/2020-04/fulfillment_orders/1046000826/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please."
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 1073459978,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823201,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823202,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823203,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:37-05:00",
"kind": "fulfillment_request"
}
]
},
"submitted_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 1073459978,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823201,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823202,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823203,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:37-05:00",
"kind": "fulfillment_request"
}
]
},
"unsubmitted_fulfillment_order": null
}
POST
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json
Accepts a fulfillment request sent to a fulfillment service for a fulfillment order.
| message
|
An optional reason for accepting the fulfillment request. |
Accepts a fulfillment request sent to a fulfillment service and updates the fulfillment order
POST /admin/api/2020-04/fulfillment_orders/1046000827/fulfillment_request/accept.json
{
"fulfillment_request": {
"message": "We will start processing your fulfillment on the next business day."
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000827,
"shop_id": 690933842,
"order_id": 1073459979,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "accepted",
"status": "in_progress",
"supported_actions": [
"request_cancellation",
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578680,
"shop_id": 690933842,
"fulfillment_order_id": 1046000827,
"quantity": 1,
"line_item_id": 1071823204,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578681,
"shop_id": 690933842,
"fulfillment_order_id": 1046000827,
"quantity": 1,
"line_item_id": 1071823205,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578682,
"shop_id": 690933842,
"fulfillment_order_id": 1046000827,
"quantity": 1,
"line_item_id": 1071823206,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
POST
/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json
Rejects a fulfillment request sent to a fulfillment service for a fulfillment order.
| message
|
An optional reason for rejecting the fulfillment request. |
Rejects a fulfillment request sent to a fulfillment service and updates the fulfillment order
POST /admin/api/2020-04/fulfillment_orders/1046000828/fulfillment_request/reject.json
{
"fulfillment_request": {
"message": "Not enough inventory on hand to complete the work."
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000828,
"shop_id": 690933842,
"order_id": 1073459980,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "rejected",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578661,
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578683,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 1071823207,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578684,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 1071823208,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578685,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 1071823209,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
Version 2020-07
The FulfillmentRequest resource represents a fulfillment request made by the merchant to a fulfillment service for a fulfillment order.
What you can do with FulfillmentRequest
The Shopify API lets you do the following with the FulfillmentRequest resource. More detailed versions of these general actions may be available:
- POST /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json Sends a fulfillment request
- POST /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json Accepts a fulfillment request
- POST /admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json Rejects a fulfillment request
Endpoints
POST
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json
Sends a fulfillment request to the fulfillment service of a fulfillment order.
| message
|
An optional message for the fulfillment request. |
| fulfillment_order_line_items
|
The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment. |
Sends a fulfillment request to the fulfillment service of a fulfillment order for the specified line items
POST /admin/api/2020-07/fulfillment_orders/1046000823/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please.",
"fulfillment_order_line_items": [
{
"id": 1025578671,
"quantity": 1
},
{
"id": 1025578672,
"quantity": 1
}
]
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000823,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578656,
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578671,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823198,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578672,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823199,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578673,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823200,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
},
"submitted_fulfillment_order": {
"id": 1046000824,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578674,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 1071823198,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578675,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 1071823199,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:34-05:00",
"kind": "fulfillment_request"
}
]
},
"unsubmitted_fulfillment_order": {
"id": 1046000825,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578676,
"shop_id": 690933842,
"fulfillment_order_id": 1046000825,
"quantity": 1,
"line_item_id": 1071823200,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
Sends a fulfillment request to the fulfillment service for all line items on the fulfillment order if fulfillment_order_line_items is left blank
POST /admin/api/2020-07/fulfillment_orders/1046000826/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please."
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 1073459978,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823201,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823202,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823203,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:37-05:00",
"kind": "fulfillment_request"
}
]
},
"submitted_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 1073459978,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823201,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823202,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823203,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:37-05:00",
"kind": "fulfillment_request"
}
]
},
"unsubmitted_fulfillment_order": null
}
POST
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json
Accepts a fulfillment request sent to a fulfillment service for a fulfillment order.
| message
|
An optional reason for accepting the fulfillment request. |
Accepts a fulfillment request sent to a fulfillment service and updates the fulfillment order
POST /admin/api/2020-07/fulfillment_orders/1046000827/fulfillment_request/accept.json
{
"fulfillment_request": {
"message": "We will start processing your fulfillment on the next business day."
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000827,
"shop_id": 690933842,
"order_id": 1073459979,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "accepted",
"status": "in_progress",
"supported_actions": [
"request_cancellation",
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578680,
"shop_id": 690933842,
"fulfillment_order_id": 1046000827,
"quantity": 1,
"line_item_id": 1071823204,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578681,
"shop_id": 690933842,
"fulfillment_order_id": 1046000827,
"quantity": 1,
"line_item_id": 1071823205,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578682,
"shop_id": 690933842,
"fulfillment_order_id": 1046000827,
"quantity": 1,
"line_item_id": 1071823206,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
POST
/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json
Rejects a fulfillment request sent to a fulfillment service for a fulfillment order.
| message
|
An optional reason for rejecting the fulfillment request. |
Rejects a fulfillment request sent to a fulfillment service and updates the fulfillment order
POST /admin/api/2020-07/fulfillment_orders/1046000828/fulfillment_request/reject.json
{
"fulfillment_request": {
"message": "Not enough inventory on hand to complete the work."
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000828,
"shop_id": 690933842,
"order_id": 1073459980,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "rejected",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578661,
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578683,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 1071823207,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578684,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 1071823208,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578685,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 1071823209,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
Version 2020-10
(Latest)
The FulfillmentRequest resource represents a fulfillment request made by the merchant to a fulfillment service for a fulfillment order.
What you can do with FulfillmentRequest
The Shopify API lets you do the following with the FulfillmentRequest resource. More detailed versions of these general actions may be available:
- POST /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json Sends a fulfillment request
- POST /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json Accepts a fulfillment request
- POST /admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json Rejects a fulfillment request
Endpoints
POST
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json
Sends a fulfillment request to the fulfillment service of a fulfillment order.
| message
|
An optional message for the fulfillment request. |
| fulfillment_order_line_items
|
The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment. |
Sends a fulfillment request to the fulfillment service of a fulfillment order for the specified line items
POST /admin/api/2020-10/fulfillment_orders/1046000823/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please.",
"fulfillment_order_line_items": [
{
"id": 1025578671,
"quantity": 1
},
{
"id": 1025578672,
"quantity": 1
}
]
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000823,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578656,
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578671,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823198,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578672,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823199,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578673,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823200,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
},
"submitted_fulfillment_order": {
"id": 1046000824,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578674,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 1071823198,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578675,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 1071823199,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:34-05:00",
"kind": "fulfillment_request"
}
]
},
"unsubmitted_fulfillment_order": {
"id": 1046000825,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578676,
"shop_id": 690933842,
"fulfillment_order_id": 1046000825,
"quantity": 1,
"line_item_id": 1071823200,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
Sends a fulfillment request to the fulfillment service for all line items on the fulfillment order if fulfillment_order_line_items is left blank
POST /admin/api/2020-10/fulfillment_orders/1046000826/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please."
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 1073459978,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823201,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823202,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823203,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:37-05:00",
"kind": "fulfillment_request"
}
]
},
"submitted_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 1073459978,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823201,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823202,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823203,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:37-05:00",
"kind": "fulfillment_request"
}
]
},
"unsubmitted_fulfillment_order": null
}
POST
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json
Accepts a fulfillment request sent to a fulfillment service for a fulfillment order.
| message
|
An optional reason for accepting the fulfillment request. |
Accepts a fulfillment request sent to a fulfillment service and updates the fulfillment order
POST /admin/api/2020-10/fulfillment_orders/1046000827/fulfillment_request/accept.json
{
"fulfillment_request": {
"message": "We will start processing your fulfillment on the next business day."
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000827,
"shop_id": 690933842,
"order_id": 1073459979,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "accepted",
"status": "in_progress",
"supported_actions": [
"request_cancellation",
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578680,
"shop_id": 690933842,
"fulfillment_order_id": 1046000827,
"quantity": 1,
"line_item_id": 1071823204,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578681,
"shop_id": 690933842,
"fulfillment_order_id": 1046000827,
"quantity": 1,
"line_item_id": 1071823205,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578682,
"shop_id": 690933842,
"fulfillment_order_id": 1046000827,
"quantity": 1,
"line_item_id": 1071823206,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
POST
/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json
Rejects a fulfillment request sent to a fulfillment service for a fulfillment order.
| message
|
An optional reason for rejecting the fulfillment request. |
Rejects a fulfillment request sent to a fulfillment service and updates the fulfillment order
POST /admin/api/2020-10/fulfillment_orders/1046000828/fulfillment_request/reject.json
{
"fulfillment_request": {
"message": "Not enough inventory on hand to complete the work."
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000828,
"shop_id": 690933842,
"order_id": 1073459980,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "rejected",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578661,
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578683,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 1071823207,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578684,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 1071823208,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578685,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 1071823209,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
Version 2021-01
(Release candidate)
The FulfillmentRequest resource represents a fulfillment request made by the merchant to a fulfillment service for a fulfillment order.
What you can do with FulfillmentRequest
The Shopify API lets you do the following with the FulfillmentRequest resource. More detailed versions of these general actions may be available:
- POST /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json Sends a fulfillment request
- POST /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json Accepts a fulfillment request
- POST /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json Rejects a fulfillment request
Endpoints
POST
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json
Sends a fulfillment request to the fulfillment service of a fulfillment order.
| message
|
An optional message for the fulfillment request. |
| fulfillment_order_line_items
|
The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment. |
Sends a fulfillment request to the fulfillment service of a fulfillment order for the specified line items
POST /admin/api/2021-01/fulfillment_orders/1046000823/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please.",
"fulfillment_order_line_items": [
{
"id": 1025578671,
"quantity": 1
},
{
"id": 1025578672,
"quantity": 1
}
]
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000823,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578656,
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578671,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823198,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578672,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823199,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578673,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823200,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
},
"submitted_fulfillment_order": {
"id": 1046000824,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578674,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 1071823198,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578675,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 1071823199,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:34-05:00",
"kind": "fulfillment_request"
}
]
},
"unsubmitted_fulfillment_order": {
"id": 1046000825,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578676,
"shop_id": 690933842,
"fulfillment_order_id": 1046000825,
"quantity": 1,
"line_item_id": 1071823200,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
Sends a fulfillment request to the fulfillment service for all line items on the fulfillment order if fulfillment_order_line_items is left blank
POST /admin/api/2021-01/fulfillment_orders/1046000826/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please."
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 1073459978,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823201,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823202,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823203,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:37-05:00",
"kind": "fulfillment_request"
}
]
},
"submitted_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 1073459978,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823201,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823202,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823203,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:37-05:00",
"kind": "fulfillment_request"
}
]
},
"unsubmitted_fulfillment_order": null
}
POST
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json
Accepts a fulfillment request sent to a fulfillment service for a fulfillment order.
| message
|
An optional reason for accepting the fulfillment request. |
Accepts a fulfillment request sent to a fulfillment service and updates the fulfillment order
POST /admin/api/2021-01/fulfillment_orders/1046000827/fulfillment_request/accept.json
{
"fulfillment_request": {
"message": "We will start processing your fulfillment on the next business day."
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000827,
"shop_id": 690933842,
"order_id": 1073459979,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "accepted",
"status": "in_progress",
"supported_actions": [
"request_cancellation",
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578680,
"shop_id": 690933842,
"fulfillment_order_id": 1046000827,
"quantity": 1,
"line_item_id": 1071823204,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578681,
"shop_id": 690933842,
"fulfillment_order_id": 1046000827,
"quantity": 1,
"line_item_id": 1071823205,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578682,
"shop_id": 690933842,
"fulfillment_order_id": 1046000827,
"quantity": 1,
"line_item_id": 1071823206,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
POST
/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json
Rejects a fulfillment request sent to a fulfillment service for a fulfillment order.
| message
|
An optional reason for rejecting the fulfillment request. |
Rejects a fulfillment request sent to a fulfillment service and updates the fulfillment order
POST /admin/api/2021-01/fulfillment_orders/1046000828/fulfillment_request/reject.json
{
"fulfillment_request": {
"message": "Not enough inventory on hand to complete the work."
}
}
View Response
HTTP/1.1 200 OK
{
"fulfillment_order": {
"id": 1046000828,
"shop_id": 690933842,
"order_id": 1073459980,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "rejected",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578661,
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578683,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 1071823207,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578684,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 1071823208,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578685,
"shop_id": 690933842,
"fulfillment_order_id": 1046000828,
"quantity": 1,
"line_item_id": 1071823209,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
Version unstable
The FulfillmentRequest resource represents a fulfillment request made by the merchant to a fulfillment service for a fulfillment order.
What you can do with FulfillmentRequest
The Shopify API lets you do the following with the FulfillmentRequest resource. More detailed versions of these general actions may be available:
- POST /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json Sends a fulfillment request
- POST /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json Accepts a fulfillment request
- POST /admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.json Rejects a fulfillment request
Endpoints
POST
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillment_request.json
Sends a fulfillment request to the fulfillment service of a fulfillment order.
| message
|
An optional message for the fulfillment request. |
| fulfillment_order_line_items
|
The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment. |
Sends a fulfillment request to the fulfillment service of a fulfillment order for the specified line items
POST /admin/api/unstable/fulfillment_orders/1046000823/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please.",
"fulfillment_order_line_items": [
{
"id": 1025578671,
"quantity": 1
},
{
"id": 1025578672,
"quantity": 1
}
]
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000823,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578656,
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578671,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823198,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578672,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823199,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578673,
"shop_id": 690933842,
"fulfillment_order_id": 1046000823,
"quantity": 1,
"line_item_id": 1071823200,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
},
"submitted_fulfillment_order": {
"id": 1046000824,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578674,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 1071823198,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578675,
"shop_id": 690933842,
"fulfillment_order_id": 1046000824,
"quantity": 1,
"line_item_id": 1071823199,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:34-05:00",
"kind": "fulfillment_request"
}
]
},
"unsubmitted_fulfillment_order": {
"id": 1046000825,
"shop_id": 690933842,
"order_id": 1073459977,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578676,
"shop_id": 690933842,
"fulfillment_order_id": 1046000825,
"quantity": 1,
"line_item_id": 1071823200,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
Sends a fulfillment request to the fulfillment service for all line items on the fulfillment order if fulfillment_order_line_items is left blank
POST /admin/api/unstable/fulfillment_orders/1046000826/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please."
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 1073459978,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823201,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823202,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823203,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:37-05:00",
"kind": "fulfillment_request"
}
]
},
"submitted_fulfillment_order": {
"id": 1046000826,
"shop_id": 690933842,
"order_id": 1073459978,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"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"
},
"origin": {
"address1": null,
"address2": null,
"city": null,
"country_code": "DE",
"location_id": 48752903,
"name": "Apple Api Shipwire",
"phone": null,
"province": null,
"zip": null
},
"line_items": [
{
"id": 1025578677,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823201,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578678,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823202,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578679,
"shop_id": 690933842,
"fulfillment_order_id": 1046000826,
"quantity": 1,
"line_item_id": 1071823203,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": [
{
"message": "Fulfill this ASAP please.",
"request_options": {
"notify_customer": false
},
"sent_at": "2020-11-04T19:49:37-05:00",
"kind": "fulfillment_request"
}
]
},
"unsubmitted_fulfillment_order": null
}
POST
/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.json
Accepts a fulfillment request sent to a fulfillment service for a fulfillment order.
| message
|
An optional reason for accepting the fulfillment request. |
Accepts a fulfillment request sent to a fulfillment service and updates the fulfillment order
POST /admin/api/unstable/fulfil