Apex Developer Guide
jNewer Version Available
OmnichannelInventoryService Class
Namespace
OmnichannelInventoryService Methods
createReservation(createReservationInputRepresentation)
API Version
51.0
Requires Chatter
No
Signature
public static ConnectApi.OCICreateReservationOutputRepresentation createReservation(ConnectApi.OCICreateReservationInputRepresentation createReservationInputRepresentation)
Parameters
- createReservationInputRepresentation
- Type: ConnectApi.OCICreateReservationInputRepresentation
- Data to reserve inventory at one or more Omnichannel Inventory locations or location groups.
Return Value
fulfillReservation(fulfillReservationInputRepresentation)
API Version
51.0
Requires Chatter
No
Signature
public static ConnectApi.OCIFulfillReservationOutputRepresentation fulfillReservation(ConnectApi.OCIFulfillReservationInputRepresentation fulfillReservationInputRepresentation)
Parameters
- fulfillReservationInputRepresentation
- Type: ConnectApi.OCIFulfillReservationInputRepresentation
- Wraps a list of inventory reservations to fulfill.
Return Value
getInventoryAvailability(inventoryAvailabilityInputRepresentation)
API Version
51.0
Requires Chatter
No
Signature
public static ConnectApi.OCIGetInventoryAvailabilityOutputRepresentation getInventoryAvailability(ConnectApi.OCIGetInventoryAvailabilityInputRepresentation inventoryAvailabilityInputRepresentation)
Parameters
- inventoryAvailabilityInputRepresentation
- Type: ConnectApi.OCIGetInventoryAvailabilityInputRepresentation
- Details of a request to retrieve inventory availability.
Return Value
Type: ConnectApi.OCIGetInventoryAvailabilityOutputRepresentation
getInventoryAvailabilityUploadStatus(uploadId)
API Version
51.0
Requires Chatter
No
Signature
public static ConnectApi.OCIUploadInventoryAvailabilityStatusOutputRepresentation getInventoryAvailabilityUploadStatus(String uploadId)
Parameters
- uploadId
- Type: String
- The uploadId of the upload job.
Return Value
Type: ConnectApi.OCIUploadInventoryAvailabilityStatusOutputRepresentation
getPublishLocationStructureStatus(uploadId)
API Version
51.0
Requires Chatter
No
Signature
public static ConnectApi.OCIPublishLocationStructureStatusOutputRepresentation getPublishLocationStructureStatus(String uploadId)
Parameters
- uploadId
- Type: String
- The uploadId of the publish job.
Return Value
Type: ConnectApi.OCIPublishLocationStructureStatusOutputRepresentation
publishLocationStructure()
API Version
51.0
Requires Chatter
No
Signature
public static ConnectApi.OCIPublishLocationStructureOutputRepresentation publishLocationStructure()
Return Value
Type: ConnectApi.OCIPublishLocationStructureOutputRepresentation
releaseReservation(releaseReservationInputRepresentation)
API Version
51.0
Requires Chatter
No
Signature
public static ConnectApi.OCIReleaseReservationOutputRepresentation releaseReservation(ConnectApi.OCIReleaseReservationInputRepresentation releaseReservationInputRepresentation)
Parameters
- releaseReservationInputRepresentation
- Type: ConnectApi.OCIReleaseReservationInputRepresentation
- Details of one or more inventory reservations to release.
Return Value
submitInventoryAvailabilityUpload(fileUpload)
API Version
51.0
Requires Chatter
No
Signature
public static ConnectApi.OCIUploadInventoryAvailabilityOutputRepresentation submitInventoryAvailabilityUpload(ConnectApi.BinaryInput fileUpload)
Parameters
- fileUpload
- Type: ConnectApi.BinaryInput
- JSON file containing inventory availability data.
Return Value
Type: ConnectApi.OCIUploadInventoryAvailabilityOutputRepresentation
Usage
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}transferReservation(transferReservationInputRepresentation)
API Version
51.0
Requires Chatter
No
Signature
public static ConnectApi.OCITransferReservationOutputRepresentation transferReservation(ConnectApi.OCITransferReservationInputRepresentation transferReservationInputRepresentation)
Parameters
- transferReservationInputRepresentation
- Type: ConnectApi.OCITransferReservationInputRepresentation
- Wraps a list of inventory reservation transfers and specifies whether a single failure cancels the entire list.