Adjust Applicable Committed Stock
https://api.flxpoint.com/fulfillment-requests/{fulfillmentRequestId}/committed-stockUse this when you want to update fulfillment request data through the API.
This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.
This endpoint will intelligently reconcile and adjust/release all applicable committed stock for the Fulfillment Request. The cases in which these occurr are as follows :
- Shipments : Will automatically release any committed stock for associated shipments that have not yet had their shipped quantity released.
- Canceled & Voided : Will automatically release all committed stock in the case that the Fulfillment Request is now canceled or voided.
- Line Item Qty Change : If a Fulfillment Request prior to being processed has any quantities modified this endpoint will reconcile the difference between what is already committed and what was modified and will then either release or add the difference.
This endpoint will not double/over release when interacted with multiple times (it's idempotent). This makes it safe to call even if you are unsure of whether or not all stock has been appropriately released.
Request
Example request
/fulfillment-requests/{fulfillmentRequestId}/committed-stockcurl -X PATCH "https://api.flxpoint.com/fulfillment-requests/{fulfillmentRequestId}/committed-stock" \
-H "Accept: application/json" \
-H "X-API-TOKEN: YOUR_TOKEN"Responses
200OK
No schema documented for this status.
204No Content
No schema documented for this status.
401Unauthorized
No schema documented for this status.
404Not Found
No schema documented for this status.
OpenAPI fragment
{
"patch": {
"summary": "Adjust Applicable Committed Stock",
"description": "This endpoint will intelligently reconcile and adjust/release all applicable committed stock for the Fulfillment Request. The cases in which these occurr are as follows : \n\n - Shipments : Will automatically release any committed stock for associated shipments that have not yet had their shipped quantity released.\n\n - Canceled & Voided : Will automatically release all committed stock in the case that the Fulfillment Request is now canceled or voided.\n\n - Line Item Qty Change : If a Fulfillment Request prior to being processed has any quantities modified this endpoint will reconcile the difference between what is already committed and what was modified and will then either release or add the difference.\n\nThis endpoint will not double/over release when interacted with multiple times (it's idempotent). This makes it safe to call even if you are unsure of whether or not all stock has been appropriately released.",
"parameters": [],
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
},
"404": {
"description": "Not Found"
}
}
}
}