- FulfillmentRequest
- What you can do with FulfillmentRequest
- Endpoints
- Sends a fulfillment request to the fulfillment service of a fulfillment order for the specified line items
- Sends a fulfillment request to the fulfillment service for all line items on the fulfillment order if fulfillment_order_line_items is left blank
- Accepts a fulfillment request sent to a fulfillment service and updates the fulfillment order
- Rejects a fulfillment request sent to a fulfillment service and updates the fulfillment order
FulfillmentRequest
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.jsonSends a fulfillment request
- POST /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/accept.jsonAccepts a fulfillment request
- POST /admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillment_request/reject.jsonRejects 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/1046000821/fulfillment_request.json
{
“fulfillment_request”: {
"message": "Fulfill this ASAP please.",
"fulfillment_order_line_items": [
{
"id": 1025578669,
"quantity": 1
},
{
"id": 1025578670,
"quantity": 1
}
]
}
}
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/1046000824/fulfillment_request.json
{
“fulfillment_request”: {
"message": "Fulfill this ASAP please."
}
}
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/1046000825/fulfillment_request/accept.json
{
“fulfillment_request”: {
"message": "We will start processing your fulfillment on the next business day."
}
}
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/1046000826/fulfillment_request/reject.json
{
“fulfillment_request”: {
"message": "Not enough inventory on hand to complete the work."
}
}