Routing, Hold Capacity

Hold fulfillment order capacity at a location. Holding capacity at a location reserves a space for a fulfillment order that you’ll assign to it.

Resource

1/commerce/order-management/routing/fulfillment-order-capacity/actions/hold-capacity

Available version

55.0

HTTP methods

POST

Request body for POST

Hold FO Capacity Input

Root XML tag

<holdFOCapacityInput>

JSON example

1{
2  "holdFOCapacityRequests": [
3    {
4      "capacityRequests": [
5        {
6          "actionRequestId" : "FOCapacityInteractionId1",
7          "locationId": "LOC-1"
8        },
9        {
10          "actionRequestId" : "FOCapacityInteractionId2",
11          "locationId": "LOC-1"
12        },
13        {
14          "actionRequestId" : "FOCapacityInteractionId3",
15          "locationId": "LOC-2"
16        }
17      ],
18      "allOrNothing": false
19    },
20    {
21      "capacityRequests": [
22        {
23          "actionRequestId" : "FOCapacityInteractionId4",
24          "locationId": "LOC-1"
25        },
26        {
27          "actionRequestId" : "FOCapacityInteractionId5",
28          "locationId": "LOC-1"
29        }
30      ],
31      "allOrNothing":true
32    }
33  ]
34}

Properties

Name	Type	Description	Required or Optional	Available Version
`holdFOCapacityRequests`	Hold FO Capacity Request Input[]	List of requests to hold fulfillment order capacity at one or more locations.	Required	55.0

Response body for POST

Hold FO Capacity Output

Connect REST API Developer Guide

Routing, Hold Capacity