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 | null
required

Null when the row was skipped.

Example:

"inv_123"

productId
string | null
required

The product ID associated with this inventory item. Null when the row was skipped.

Example:

"prod_123"

externalProductId
string | null
required

The external product ID from an external system

Example:

"ext_001"

storeLocationId
string | null
required

The store location ID where this inventory is located. Null when the row was skipped.

Example:

"store_001"

externalStoreLocationId
string | null
required

The external store ID from an external system

Example:

"ext_store_002"

quantity
integer | null
required

The quantity of the product in stock. Null when the row was skipped.

Example:

50

available
boolean | null
required

Whether the product is available for purchase. Null when the row was skipped.

Example:

true

errorCode
string | null
required

Set when this row was skipped (unknown product or store location); null on success.

Example:

"MISSING_RESOURCE"

errorMessage
string | null
required

Why the row was skipped; null on success.

Example:

"Product 'ext_001' not found."

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

providerConfigs
InventoryProviderConfigOutputSerializer · object[] | null

Provider-specific configurations for this inventory item