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-04/fulfillment_orders/1025578663/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please.",
"fulfillment_order_line_items": [
{
"id": 1025578680,
"quantity": 1
},
{
"id": 1025578681,
"quantity": 1
}
]
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1025578663,
"shop_id": 690933842,
"order_id": 1073459992,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578651,
"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": 1025578663,
"quantity": 1,
"line_item_id": 1071823236,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578681,
"shop_id": 690933842,
"fulfillment_order_id": 1025578663,
"quantity": 1,
"line_item_id": 1071823237,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578682,
"shop_id": 690933842,
"fulfillment_order_id": 1025578663,
"quantity": 1,
"line_item_id": 1071823238,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
},
"submitted_fulfillment_order": {
"id": 1025578664,
"shop_id": 690933842,
"order_id": 1073459992,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578652,
"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": 1025578664,
"quantity": 1,
"line_item_id": 1071823236,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578684,
"shop_id": 690933842,
"fulfillment_order_id": 1025578664,
"quantity": 1,
"line_item_id": 1071823237,
"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-06-29T12:33:53-04:00",
"kind": "fulfillment_request"
}
]
},
"unsubmitted_fulfillment_order": {
"id": 1025578665,
"shop_id": 690933842,
"order_id": 1073459992,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578653,
"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": 1025578685,
"shop_id": 690933842,
"fulfillment_order_id": 1025578665,
"quantity": 1,
"line_item_id": 1071823238,
"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/1025578666/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please."
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1025578666,
"shop_id": 690933842,
"order_id": 1073459993,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578654,
"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": 1025578686,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823239,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578687,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823240,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578688,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823241,
"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-06-29T12:33:56-04:00",
"kind": "fulfillment_request"
}
]
},
"submitted_fulfillment_order": {
"id": 1025578666,
"shop_id": 690933842,
"order_id": 1073459993,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578654,
"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": 1025578686,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823239,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578687,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823240,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578688,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823241,
"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-06-29T12:33:56-04: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-04/fulfillment_orders/1025578667/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": 1025578667,
"shop_id": 690933842,
"order_id": 1073459994,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "accepted",
"status": "in_progress",
"supported_actions": [
"request_cancellation",
"create_fulfillment"
],
"destination": {
"id": 1025578655,
"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": 1025578689,
"shop_id": 690933842,
"fulfillment_order_id": 1025578667,
"quantity": 1,
"line_item_id": 1071823242,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578690,
"shop_id": 690933842,
"fulfillment_order_id": 1025578667,
"quantity": 1,
"line_item_id": 1071823243,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578691,
"shop_id": 690933842,
"fulfillment_order_id": 1025578667,
"quantity": 1,
"line_item_id": 1071823244,
"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-04/fulfillment_orders/1025578668/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": 1025578668,
"shop_id": 690933842,
"order_id": 1073459995,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "rejected",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"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": 1025578692,
"shop_id": 690933842,
"fulfillment_order_id": 1025578668,
"quantity": 1,
"line_item_id": 1071823245,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578693,
"shop_id": 690933842,
"fulfillment_order_id": 1025578668,
"quantity": 1,
"line_item_id": 1071823246,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578694,
"shop_id": 690933842,
"fulfillment_order_id": 1025578668,
"quantity": 1,
"line_item_id": 1071823247,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
Version 2020-04
(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-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/1025578663/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please.",
"fulfillment_order_line_items": [
{
"id": 1025578680,
"quantity": 1
},
{
"id": 1025578681,
"quantity": 1
}
]
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1025578663,
"shop_id": 690933842,
"order_id": 1073459992,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578651,
"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": 1025578663,
"quantity": 1,
"line_item_id": 1071823236,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578681,
"shop_id": 690933842,
"fulfillment_order_id": 1025578663,
"quantity": 1,
"line_item_id": 1071823237,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578682,
"shop_id": 690933842,
"fulfillment_order_id": 1025578663,
"quantity": 1,
"line_item_id": 1071823238,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
},
"submitted_fulfillment_order": {
"id": 1025578664,
"shop_id": 690933842,
"order_id": 1073459992,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578652,
"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": 1025578664,
"quantity": 1,
"line_item_id": 1071823236,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578684,
"shop_id": 690933842,
"fulfillment_order_id": 1025578664,
"quantity": 1,
"line_item_id": 1071823237,
"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-06-29T12:33:53-04:00",
"kind": "fulfillment_request"
}
]
},
"unsubmitted_fulfillment_order": {
"id": 1025578665,
"shop_id": 690933842,
"order_id": 1073459992,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578653,
"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": 1025578685,
"shop_id": 690933842,
"fulfillment_order_id": 1025578665,
"quantity": 1,
"line_item_id": 1071823238,
"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/1025578666/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please."
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1025578666,
"shop_id": 690933842,
"order_id": 1073459993,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578654,
"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": 1025578686,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823239,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578687,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823240,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578688,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823241,
"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-06-29T12:33:56-04:00",
"kind": "fulfillment_request"
}
]
},
"submitted_fulfillment_order": {
"id": 1025578666,
"shop_id": 690933842,
"order_id": 1073459993,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578654,
"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": 1025578686,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823239,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578687,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823240,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578688,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823241,
"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-06-29T12:33:56-04: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/1025578667/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": 1025578667,
"shop_id": 690933842,
"order_id": 1073459994,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "accepted",
"status": "in_progress",
"supported_actions": [
"request_cancellation",
"create_fulfillment"
],
"destination": {
"id": 1025578655,
"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": 1025578689,
"shop_id": 690933842,
"fulfillment_order_id": 1025578667,
"quantity": 1,
"line_item_id": 1071823242,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578690,
"shop_id": 690933842,
"fulfillment_order_id": 1025578667,
"quantity": 1,
"line_item_id": 1071823243,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578691,
"shop_id": 690933842,
"fulfillment_order_id": 1025578667,
"quantity": 1,
"line_item_id": 1071823244,
"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/1025578668/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": 1025578668,
"shop_id": 690933842,
"order_id": 1073459995,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "rejected",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"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": 1025578692,
"shop_id": 690933842,
"fulfillment_order_id": 1025578668,
"quantity": 1,
"line_item_id": 1071823245,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578693,
"shop_id": 690933842,
"fulfillment_order_id": 1025578668,
"quantity": 1,
"line_item_id": 1071823246,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578694,
"shop_id": 690933842,
"fulfillment_order_id": 1025578668,
"quantity": 1,
"line_item_id": 1071823247,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}
Version 2020-07
(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/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-04/fulfillment_orders/1025578663/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please.",
"fulfillment_order_line_items": [
{
"id": 1025578680,
"quantity": 1
},
{
"id": 1025578681,
"quantity": 1
}
]
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1025578663,
"shop_id": 690933842,
"order_id": 1073459992,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "closed",
"supported_actions": [],
"destination": {
"id": 1025578651,
"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": 1025578663,
"quantity": 1,
"line_item_id": 1071823236,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578681,
"shop_id": 690933842,
"fulfillment_order_id": 1025578663,
"quantity": 1,
"line_item_id": 1071823237,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578682,
"shop_id": 690933842,
"fulfillment_order_id": 1025578663,
"quantity": 1,
"line_item_id": 1071823238,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
},
"submitted_fulfillment_order": {
"id": 1025578664,
"shop_id": 690933842,
"order_id": 1073459992,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578652,
"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": 1025578664,
"quantity": 1,
"line_item_id": 1071823236,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578684,
"shop_id": 690933842,
"fulfillment_order_id": 1025578664,
"quantity": 1,
"line_item_id": 1071823237,
"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-06-29T12:33:53-04:00",
"kind": "fulfillment_request"
}
]
},
"unsubmitted_fulfillment_order": {
"id": 1025578665,
"shop_id": 690933842,
"order_id": 1073459992,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "unsubmitted",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"destination": {
"id": 1025578653,
"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": 1025578685,
"shop_id": 690933842,
"fulfillment_order_id": 1025578665,
"quantity": 1,
"line_item_id": 1071823238,
"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/1025578666/fulfillment_request.json
{
"fulfillment_request": {
"message": "Fulfill this ASAP please."
}
}
View Response
HTTP/1.1 200 OK
{
"original_fulfillment_order": {
"id": 1025578666,
"shop_id": 690933842,
"order_id": 1073459993,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578654,
"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": 1025578686,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823239,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578687,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823240,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578688,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823241,
"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-06-29T12:33:56-04:00",
"kind": "fulfillment_request"
}
]
},
"submitted_fulfillment_order": {
"id": 1025578666,
"shop_id": 690933842,
"order_id": 1073459993,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "submitted",
"status": "open",
"supported_actions": [
"cancel_fulfillment_order"
],
"destination": {
"id": 1025578654,
"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": 1025578686,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823239,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578687,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823240,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578688,
"shop_id": 690933842,
"fulfillment_order_id": 1025578666,
"quantity": 1,
"line_item_id": 1071823241,
"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-06-29T12:33:56-04: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-04/fulfillment_orders/1025578667/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": 1025578667,
"shop_id": 690933842,
"order_id": 1073459994,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "accepted",
"status": "in_progress",
"supported_actions": [
"request_cancellation",
"create_fulfillment"
],
"destination": {
"id": 1025578655,
"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": 1025578689,
"shop_id": 690933842,
"fulfillment_order_id": 1025578667,
"quantity": 1,
"line_item_id": 1071823242,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578690,
"shop_id": 690933842,
"fulfillment_order_id": 1025578667,
"quantity": 1,
"line_item_id": 1071823243,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578691,
"shop_id": 690933842,
"fulfillment_order_id": 1025578667,
"quantity": 1,
"line_item_id": 1071823244,
"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-04/fulfillment_orders/1025578668/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": 1025578668,
"shop_id": 690933842,
"order_id": 1073459995,
"assigned_location_id": 48752903,
"fulfillment_service_handle": "shipwire-app",
"request_status": "rejected",
"status": "open",
"supported_actions": [
"request_fulfillment",
"create_fulfillment"
],
"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": 1025578692,
"shop_id": 690933842,
"fulfillment_order_id": 1025578668,
"quantity": 1,
"line_item_id": 1071823245,
"inventory_item_id": 39072856,
"fulfillable_quantity": 1,
"variant_id": 39072856
},
{
"id": 1025578693,
"shop_id": 690933842,
"fulfillment_order_id": 1025578668,
"quantity": 1,
"line_item_id": 1071823246,
"inventory_item_id": 457924702,
"fulfillable_quantity": 1,
"variant_id": 457924702
},
{
"id": 1025578694,
"shop_id": 690933842,
"fulfillment_order_id": 1025578668,
"quantity": 1,
"line_item_id": 1071823247,
"inventory_item_id": 49148385,
"fulfillable_quantity": 1,
"variant_id": 49148385
}
],
"outgoing_requests": []
}
}