Newer Version Available

This content describes an older version of this product. View Latest

Availability Records, Upload

Asynchronously upload inventory data to Omnichannel Inventory and check the status of upload jobs.

Available resources are:

Resource Description
/commerce/oci/availability-records/uploads POST - Upload an inventory availability data file to Omnichannel Inventory.
/commerce/oci/availability-records/uploads/uploadId GET - Retrieve the status of an inventory availability upload job.
Resource
1/commerce/oci/availability-records/uploads
Available version
51.0
Requires Chatter
No
HTTP methods
POST
Request parameters for POST
Parameter Name Type Description Required or Optional Available Version
fileUpload Binary JSON file containing inventory availability data. Required 51.0
Use this JSON format for the data file:

Don’t separate location and inventory record entries with commas.

Note

1{
2  "location":"Warehouse-A",  // location identifier
3  "mode":"UPDATE"  // must be UPDATE (other operations might be available in future releases)
4}
5{
6  "recordId":"0a87539d-f3dd-47bc-91c7-9c752e39dbe0",  // unique identifier for the inventory record
7  "onHand":10,
8  "sku":"12389156",
9  "effectiveDate":"2020-12-08T14:05:22.790896-07:00",
10  "futures":[  // list of future restocks
11    {
12    "quantity":1,
13    "expectedDate":"2021-04-18T14:05:22.781-07:00"
14    },
15    {
16    "quantity":5,
17    "expectedDate":"2021-05-18T14:05:22.781-07:00"
18    }
19  ],
20  "safetyStockCount":0
21}
22{
23  "recordId":"0a87539d-f3dd-47bc-91c7-9c752e312345",
24  "onHand":10,
25  "sku":"9485728",
26  "effectiveDate":"2020-12-08T14:05:22.790896-07:00",
27  "futures":[
28    {
29    "quantity":10,
30    "expectedDate":"2021-04-18T14:05:22.781-07:00"
31    }
32  ],
33  "safetyStockCount":0
34}
35{
36  "location":"Warehouse-B",
37  "mode":"UPDATE"
38}
39{
40  "recordId":"0a87539d-f3dd-47bc-91c7-9c75abc123de",
41  "onHand":10,
42  "sku":"12389156",
43  "effectiveDate":"2020-12-08T14:05:22.790896-07:00",
44  "futures":[
45    {
46    "quantity":1,
47    "expectedDate":"2021-04-18T14:05:22.781-07:00"
48    }
49  ],
50  "safetyStockCount":0
51}
52{
53  "recordId":"0a87539d-f3dd-47bc-91c7-9c75abc98765",
54  "onHand":10,
55  "sku":"9386720",
56  "effectiveDate":"2020-12-08T14:05:22.790896-07:00",
57  "futures":[
58    {
59    "quantity":5,
60    "expectedDate":"2021-04-18T14:05:22.781-07:00"
61    }
62  ],
63  "safetyStockCount":0
64}
Response body for POST
OCI Upload Inventory Availability Output
Resource
1/commerce/oci/availability-records/uploads/uploadId
Available version
51.0
Requires Chatter
No
HTTP methods
GET
Response body for GET
OCI Upload Inventory Availability Status Output