Skip to main content
POST
Create or update inventory

Authorizations

Authorization
string
header
required

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

Body

application/json
inventory
StoreInventoryInputSerializer · object[]
required

List of store inventory to create or update

Response

OK

id
string
required
productId
string
required

The product ID associated with this inventory item

Example:

"prod_123"

storeLocationId
string
required

The store location ID where this inventory is located

Example:

"store_001"

quantity
integer
required

The quantity of the product in stock

Example:

50

available
boolean
required

Whether the product is available for purchase

Example:

true

externalProductId
string | null

The external product ID from an external system

Example:

"ext_001"

externalStoreLocationId
string | null

The external store ID from an external system

Example:

"ext_store_002"

valueCents
integer | null

The price of the product in cents

Example:

299

currency
string | null

The currency code for the product price

Example:

"USD"

location
LocationDataOutputSerializer · object | null

The location data for the product in the store

Example:
details
StoreInventoryDetailsOutputSerializer · object | null

Additional inventory details

Example:
providerConfigs
InventoryProviderConfigOutputSerializer · object[] | null

Provider-specific configurations for this inventory item

Example: