Skip to main content
PUT
Upsert Inventory by External IDs

Authorizations

X-Authorization
string
header
required

API Scope: "Inventory (write)"

Path Parameters

productExternalId
string
required

The identifier used by an external source to identify the product.

Maximum string length: 64
Example:

"ex4mpl3-pr0duct"

variantExternalId
string
required

The identifier used by an external source to identify the product variant.

Maximum string length: 64
Example:

"ex4mpl3-pr0duct-v4r14nt"

locationExternalId
string
required

The identifier used by an external source to identify the location.

Maximum string length: 64
Example:

"ex4mpl3-l0c4t10n"

Body

application/json
available_count
integer<int64>
required

The number of product_variants available at location.

Example:

42

Response

Success

inventory
object
required