PATCH
/
inventory

Authorizations

Authorization
string
header
required

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
channelId
string
required

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

itemId
integer
required

Item ID

locationNum
integer
required

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

sku
string
required

SKU of the item

attributes
object

Custom attribute of the inventory

backOrderDate
string

Inventory restock date

backOrderLimit
integer

Maximum restock inventory quantity

counters
object

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

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

inventoryType
string

Inventory type. It is a classifier attribute that provides flexibility to define types.

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.

lowStock
integer

Inventory quantity to mark as low stock at the location

preOrderDate
string

First ship date of inventory

preOrderLimit
integer

Maximum quanity of inventory for first-ship

region
string

Region where inventory is managed

safetyStock
integer

Reserved inventory quantity at the location

segment
string

Inventory segment

vendorId
string

Vendor ID

Response

200 - application/json
attributes
object

Custom inventory attributes configured by the merchant

channelId
string

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

counters
object

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

id
string

Inventory ID

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

inventoryType
string

Type of inventory

itemId
integer

Item ID for which inventory is updated

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

locationNum
integer

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

sku
string

SKU of the item

vendorId
string

Vendor ID

virtualCounters
object

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