Adjust Inventory

Required permission: write_inventory

Adjust the inventory of a product.

Without lpn_id, the adjustment applies to the loose stock (not on an LPN) at the location. If the product is only on LPNs at that location, a negative adjustment returns a 400 asking for lpn_id.

With lpn_id, the adjustment applies to the stock on that LPN (license plate). This requires an organization API key and LPNs enabled for the organization (otherwise the request returns a 403). The LPN must belong to your organization, must not be archived, and must be at location_id. A negative quantity cannot be more than the LPN's available quantity for the product (on hand minus the quantity locked for picking or other tasks). At a mixed-lot location, product_lot_id is required unless the LPN holds exactly one lot of the product.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

An object containing the fields to adjust the inventory.

integer
required

The ID of the product to adjust.

integer
required

The ID of the location to adjust.

integer
required

The quantity to adjust. This can be a positive or negative integer.

boolean

Whether the inventory being adjusted is damaged.

integer

The ID of a pre-defined inventory adjustment reason.

string

The reason for the inventory adjustment.

integer

The ID of the product lot which the inventory is being adjusted for.

string

A note about the inventory adjustment.

integer

The ID of the LPN (license plate) whose stock is adjusted. The LPN must be at location_id. Omit to adjust loose stock. Organization API keys only.

Responses

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