Update inventory position or create inventory

This endpoint updates inventory position (also known as counter) as per specified request body, Or it creates inventory if inventory does not exist, and thereby updates the counter. Inventory is identified based on the combination of location number, channel ID, and item ID or item SKU.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context

string

required

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

application/json

itemId

integer

Item ID whose inventory is to be updated

locationNum

integer

Location number is used to identify the warehouse or location where the inventory is kept

channelId

string

Channel ID. This field is used to identify where the business operations are being held.

leadTime

string

The amount of time between when a purchase order is placed to replenish products and when the order is received in the warehouse

counters

object

Represents inventory position

attributes

object

Custom attributes for inventory

Response

200 - application/json

virtualCounters

object

View quantity of inventory, based on pre configured value. For example, 'availableToPurchase' can be a custom attribute configured by merchants.

id

string

Inventory ID

sku

string

SKU of the item

itemId

integer

Item ID for which inventory is updated

locationNum

integer

Location number is used to identify the warehouse or location where the inventory is kept

channelId

string

Sales channel ID. This field is used to identify where the business operations are being held.

vendorId

string

Vendor ID

leadTime

string

The amount of time between when a purchase order is placed to replenish products and when the order is received in the warehouse

inventoryType

string

Type of inventory

infiniteInventory

boolean

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

counters

object

Inventory counter (also known as inventory position) configured by the merchant

attributes

object

Custom inventory attributes configured by the merchant