Radial Integration | 2016

Retail Order Management > Inventory Management > Inventory API

Inventory API

The Inventory API provides for item reservation and near-realtime determination of availability to secure products for ordering.

Inventory API calls have the following restrictions:

This API is not meant for high-volume service calls that check item status en masse (for example, family pages and category pages) or with high frequency (for example, product pages). Such high-volume usage can degrade site and system performance to unacceptable levels.
This API should not call for an inventory quantity or reservation for items that have unlimited inventory (for example, warranties, virtual gift cards, and online gift certificates). Quantities returned for these items might be zero, which can negatively impact the operation of the webstore.

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
Get Inventory Quantity	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	Get instore quantity for an item at one or more stores	No	XML	200 + XML response
Get Inventory Details	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
Create Inventory Allocations	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
Delete Inventory Allocations	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
Get Inventory Locations Quantity	GET	/gsi-inventory-service/locations.json?sourceID=source&sourceType=type&network=fulfillmentnetwork&itemID=item	/gsi-inventory-service/locations.json? sourceId=TMSUS& sourceType=CHANNEL& network=SN& itemId=12-3456789	Get inventory locations for the specified item in the specified sales channel.			XML or JSON response

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.

Copyright © 2017 Radial. All rights reserved.