Inventory Advice - JSON Specification

Summary

Use this format to send updates on the current state of inventory at the SKU level.

NameDescription
RootThe top level document
InventoryThe facility for which the inventory is being reported. Generally, this is the warehouse.
Item

A single SKU & disposition

If you are only sending inventory quantities without a disposition code then you should have one Item for each SKU in your inventory.

If you are only sending inventory quantities with a disposition code then you should have one Item for each SKU / disposition pair your inventory.

For example, if you might send [{"sku": "123", "quantity": 10, "disposition_code":"DMG"}, {"sku": "123", "quantity": 1000, "disposition_code":"AVAIL"}]

NameData TypeDescriptionRequired
doc_typeStringAlways inventory_advice_json
inventoriesArray<Inventory>Array of Inventories (usually one per warehouse)
versionStringThe version of the specification being used.
NameData TypeDescriptionRequired
customer_idStringThe identifier of the entity the inventory belongs to.
customer_location_idStringThe location ID used by the customer that corresponds to the location_id. This is genreally used by third party warehouses to capture the location_id from the customer's ERP system.
inventory_dateStringThe date/time for which the inventory information is valid. This is usually the date/time when the file was generated.
itemsArray<Item>Array of Items (usually one per sku / disposition code pair)
location_idStringThe location ID of the facility / inventory set as defined by the warehousing provider.
transmission_uidStringA one-time unique identifying code for this transmission of the inventory in question. Used for tracing and logging purposes.
NameData TypeDescriptionRequired
disposition_codeStringThe state of the inventory
disposition_descriptionStringA human readable description of the disposition_code
quantityDecimalThe number of units in inventory.
skuStringStock Keeping Unit number. The lowest level of detail at which all products are the same.
unit_of_measureStringUnit of measure code used for maintaining product inventory.
unit_of_measure_descriptionStringDescription of the unit of measure.
upcStringUniversal Product Code number

Example

With disposition codes 

Without disposition codes