You are here:
Omnichannel Inventory Connect REST APIs
Connect your inventory management process by connecting your Omnichannel Inventory service to Salesforce Platform apps. Use the Connect REST APIs to import and upload inventory files, access real-time inventory availability, and manage reservations.
Required Editions
| View supported editions. |
This table lists the Connect REST APIs for Omnichannel Inventory.
| API | Description | Resource |
|---|---|---|
| Availability Records, Batch Update | Update a batch of inventory records to Omnichannel Inventory. Add a new inventory record or update on hand, future quantity, future date, safety stock count, and shipping eligibility to an existing inventory record. Supports partial success. For example, when 10 items are sent and two fail, the failed items show in the error section. |
/commerce/oci/availability-records/actions/batch-update |
| Availability Records, Get Availability | Retrieve inventory availability data for one or more products at one or more inventory locations or location groups. | /commerce/oci/availability/availability-records/actions/get-availability |
| Availability Records, Upload | Upload an inventory availability data file to Omnichannel Inventory. | /commerce/oci/availability-records/uploads |
| Inventory, Check Availability | Get information about inventory availability for products in locations or location groups in your commerce inventory system. Provides available to fulfill, available to order, and on hand quantity information. | /commerce/inventory/check-availability |
| Inventory, Levels | Get information about inventory levels for products in locations and location groups in your commerce inventory system. | /commerce/inventory/levels |
| Location Graph, Upload | Asynchronously publish information about your inventory locations and location groups to Omnichannel Inventory. The publish includes records whose IsEnabled and ShouldSyncWithOci fields are both true. This method returns an ID that you can use to retrieve the status of the publish job. | /commerce/oci/location-graph/uploads |
| Reservations, Create | Create an inventory reservation in Omnichannel Inventory. | /commerce/oci/reservation/actions/reservations |
| Reservations, Fulfill | Fulfill one or more inventory reservations. | /commerce/oci/reservation/actions/fulfillments |
| Reservations, Release | Release one or more existing inventory reservations to free up that inventory. | /commerce/oci/reservation/actions/releases |
| Reservations, Transfer | Transfer one or more inventory reservations between locations or location groups. This API doesn’t change physical quantities, but reduces the reserved quantity at the source and increases it at the destination. | /commerce/oci/reservation/actions/transfers |
| Reservations, Update | Update an existing reservation in Omnichannel Inventory. Add, remove, and update quantities for existing SKUs in the reservation. | /commerce/oci/reservation/actions/update |
Did this article solve your issue?
Let us know so we can improve!
