Update inventory by adding new property
This endpoint does not override all the existing properties, rather it updates inventory by adding new properties or by updating the existing inventory properties that are specified in the request body. Inventory is identified based on the combination of location number, channel ID, and item ID or item SKU.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The x-site-context
header is a JSON object that contains information about the source you wish to pull from. The mandatory account
is the 24 character identifier found in Copilot. The channel
(Sales channel ID), stage
(environment name), and date
attributes can be used to further narrow the scope of your data source.
Body
Sales channel ID. This field is used to identify where the business operations are being held.
Item ID
Location number is used to identify the warehouse or location where the inventory is going to be kept
SKU of the item
Custom attribute of the inventory
Inventory restock date
Maximum restock inventory quantity
Inventory counter (also known as inventory position) configured by the merchant
Infinite inventory flag.<br /> true
indicates that the inventory can be consumed any number of times as per need<br />false
indicates that the inventory cannot be used infinitely, and has a limit to be consumed
Inventory type. It is a classifier attribute that provides flexibility to define types.
The amount of time between when a purchase order is placed to replenish products and when the order is received in the warehouse.
Inventory quantity to mark as low stock at the location
First ship date of inventory
Maximum quanity of inventory for first-ship
Region where inventory is managed
Reserved inventory quantity at the location
Inventory segment
Vendor ID
Response
Custom inventory attributes configured by the merchant
Sales channel ID. This field is used to identify where the business operations are being held.
Inventory counter (also known as inventory position) configured by the merchant
Inventory ID
Infinite inventory flag.<br /> true
indicates that the inventory can be consumed any number of times as per need<br />false
indicates that the inventory cannot be used infinitely, and has a limit to be consumed
Type of inventory
Item ID for which inventory is updated
The amount of time between when a purchase order is placed to replenish products and when the order is received in the warehouse
Location number is used to identify the warehouse or location where the inventory is kept
SKU of the item
Vendor ID
View quantity of inventory, based on pre configured value. For example, 'availableToPurchase' can be a custom attribute configured by merchants.