Update inventory count for a single item at one ship node

This request updates the inventory for an item, with the item global trade item number (GTIN) as the primary item identifier.

Use an availability code to identify how inventory quantity is managed for an item.

The following are valid availability codes:

CodeUse
AAUse for an item with infinite or unlimited inventory. Quantity is not required when set to AA.
ACUse for standard or normal inventory updates.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Distribution facility distributor identifier.

This parameter identifies the facility from which the inventory is requested.

Facility identifiers are autogenerated during account creation, when adding new facilities, and when updating existing facilities in Supplier Center. Take care to use the latest value for your desired facility.

Body Params

Request fields

string
required

Global Trade Item Number in 14-digit (GTIN-14) format.

If the value is fewer than 14 digits, add zeros at the beginning to lengthen the value to 14 digits.

string
enum
required

Specifies the availability of the item.

Valid values are:

ValueMeaning
AAThe code used for an item with infinite inventory. If you use AA as the availability code, you do not need to provide inventory for the item.
ACThe code used for standard inventory updates. Assign this code to an item with non-infinite inventory.
Allowed:
quantity
object
required

Contains information about the quantity of items in inventory.

Headers
string

Identifier that tracks the consumer request by channel.

Use the consumer channel type received during your onboarding.

Contact your system administrator or developer management for the correct WM_CONSUMER.CHANNEL.TYPE value.

string
required

Unique identifier for each API call, used to track and debug issues.

Use a randomly generated GUID for this ID.

string
required

Access token returned by the Create access token request.

This value is required for token-based authentication.

Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json