Inventory API
The Inventory API provides for item reservation and near-realtime determination of availability to secure products for ordering.
Inventory URI Summary
Inventory URIs use the service identifier inventory.
|
Operation |
Action |
URI Template |
URI Example |
Transaction Type |
Unique RequestID Needed for Duplicate Detection? |
Non-URI Request / Payload |
Response |
|---|---|---|---|---|---|---|---|
| Determine Eligibility for Associate Delivery | POST | /v M.m/stores/STOREID/inventory/associatedeliveryeligibility |
Note: Used with Omnichannel and Store Fulfillment. Makes a call to inventory service for associate delivery eligibility for items. |
No | XML |
200 + XML response |
|
|
POST |
/vM.m/stores/STOREID/inventory/quantity/get.xml |
/v1.0/stores/ABCD/inventory/quantity/get.xml |
Get available-to-sell (promise) quantity for one or more line items. |
No |
XML |
200 + XML response |
|
| Get Instore Inventory Quantity | POST | /vM.m/stores/STOREID/inventory/quantity/instore/get.xml | /v1.0/stores/ABCD/inventory/quantity/instore/get.xml |
Note: Used with Omnichannel and Store Fulfillment. Get instore quantity for an item at one or more stores |
No | XML | 200 + XML response |
|
POST |
/vM.m/stores/STOREID/inventory/details/get.xml |
/v1.0/stores/ABCD/inventory/details/get.xml |
Get estimated delivery date and ship-from address per line item. |
No |
XML |
200 + XML response |
|
|
POST |
/vM.m/stores/STOREID/inventory/allocations/create.xml |
/v1.0/stores/ABCD/inventory/allocations/create.xml |
Create an inventory reservation for one or more line items. |
No |
XML |
200 + XML response |
|
|
POST |
/vM.m/stores/STOREID/inventory/allocations/delete.xml |
/v1.0/stores/ABCD/inventory/allocations/delete.xml |
Delete an inventory reservation after the allocation is made but before the EP order create call. |
Yes |
XML |
200 + XML response |
URI domain name: Radial recommends using the new domain at apg.radial.com. To connect to production Radial APIs, use the following form of the URL:
https://apg.radial.com/v1.0/proxyname/storecode/function
You should have received the applicable information for proxyname, storecode, and function from your Radial representative.
Note: The old domain will still be in operation until further notice from Radial. For more information on Radial API URIs, see API Requests and Responses.
Error Response Messages
When a request results in an unrecoverable error, the Inventory Service returns an error response message instead of an operation-specific response message. An error response message has a type and descriptive details. The Inventory Service defines two error types:
- BAD REQUEST – The request sent to the Inventory Service is either invalid or does not validate against the API XSD.
- INTERNAL ERROR – An unrecoverable system error or business error occurred while processing the request, such as:
- A required, dependent Radial service is not available.
- An invalid store ID was sent on the request.
- An unanticipated error occurred while processing the request.