Use this format to send updates on the current state of inventory at the SKU level.
| Name | Description |
|---|---|
| Root | The top level document |
| Inventory | The 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 If you are only sending inventory quantities with a disposition code then you should have one For example, if you might send |
| Name | Data Type | Description | Required |
|---|---|---|---|
doc_type | String | Always inventory_advice_json | |
inventories | Array<Inventory> | Array of Inventories (usually one per warehouse) | |
version | String | The version of the specification being used. |
| Name | Data Type | Description | Required |
|---|---|---|---|
customer_id | String | The identifier of the entity the inventory belongs to. | |
customer_location_id | String | The 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_date | String | The date/time for which the inventory information is valid. This is usually the date/time when the file was generated. | |
items | Array<Item> | Array of Items (usually one per sku / disposition code pair) | |
location_id | String | The location ID of the facility / inventory set as defined by the warehousing provider. | |
transmission_uid | String | A one-time unique identifying code for this transmission of the inventory in question. Used for tracing and logging purposes. |
| Name | Data Type | Description | Required |
|---|---|---|---|
disposition_code | String | The state of the inventory | |
disposition_description | String | A human readable description of the disposition_code | |
quantity | Decimal | The number of units in inventory. | |
sku | String | Stock Keeping Unit number. The lowest level of detail at which all products are the same. | |
unit_of_measure | String | Unit of measure code used for maintaining product inventory. | |
unit_of_measure_description | String | Description of the unit of measure. | |
upc | String | Universal Product Code number |