Sign in
InventoryProducts

Create an Inventory Product Adjustment

This endpoint creates an adjustment for the given inventory product.

post/inventory/products/{productId}/adjustments

Request body

quantitynumber required

The amount of the adjustment, which may be positive or negative.

reason_codestring required

The preset reason code for the adjustment.

reason_descriptionstring nullable required

A free-text description of the reason for the adjustment.

location_idstring uuid nullable required

Identifier of the stock location the adjustment is recorded against. For positive adjustments stock is added at this location; for negative adjustments stock is removed from it. Pass null if the site uses a single, default location.

Example request

{
  "quantity": 10.5,
  "reason_code": "Professional Use",
  "reason_description": "Stock used for professional use"
}

Response

The inventory product adjustment was successfully retrieved

Example response

{
  "data": {
    "quantity": 10.5,
    "reason_code": "Professional Use",
    "reason_description": "Stock used for professional use",
    "created_at": "2024-05-01T00:00:00Z"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.