Skip to content

Inventory Adjust Stock

Adjust inventory stock levels for products. Supports adding and consuming stock via the adjustmentType field. Multiple adjustments can be submitted in a single request (maximum 100 per request).

  • add — increases current stock; offsets existing backorder first
  • consume — decreases current stock; creates backorder if quantity exceeds available stock

POST /procurement/v1/inventory/adjust-stock

Authentication

Include your API key in the X-API-KEY header.

Request example

{
  "adjustments": [
    {
      "partnerSku": "SKU-001",
      "adjustmentType": "consume",
      "quantity": 25,
      "referenceId": "JOB-12345"
    },
    {
      "partnerSku": "SKU-002",
      "adjustmentType": "add",
      "quantity": 100,
      "referenceId": "PO-5678"
    }
  ]
}

Success response example

{
  "updates": [
    {
      "partnerSku": "SKU-001",
      "success": true,
      "message": "Stock consumed successfully",
      "previousQuantity": 770,
      "newQuantity": 745,
      "backorderQuantity": 0
    },
    {
      "partnerSku": "SKU-002",
      "success": true,
      "message": "Stock added successfully",
      "previousQuantity": 50,
      "newQuantity": 150,
      "backorderQuantity": 0
    }
  ]
}

Error response example

{
  "success": false,
  "data": [
    {
      "partnerSku": "SKU-001",
      "success": false,
      "message": "No inventory item found for partnerSku: SKU-001"
    }
  ]
}

Request

Parameter Type Description
adjustments (required) array Array of adjustment items. Maximum 100 items per request.
partnerSku (required) string The partner SKU identifying the product. Sample: SKU-001.
adjustmentType (required) string Type of stock adjustment. Allowed values: add, consume. Sample: consume.
quantity (required) integer Number of units to add or consume. Must be greater than 0. Sample: 25.
referenceId (optional) string External reference ID for idempotency and traceability. Duplicate requests with the same referenceId within 5 minutes are rejected. Sample: JOB-12345.

Success response

Parameter Type Description
updates array Array of results, one per adjustment item.
updates[].partnerSku string The partner SKU that was adjusted. Sample: SKU-001.
updates[].success boolean Whether this individual adjustment succeeded. Sample: true.
updates[].message string Human-readable result message. Sample: Stock consumed successfully.
updates[].previousQuantity integer Stock quantity before the adjustment. Sample: 770.
updates[].newQuantity integer Stock quantity after the adjustment. Sample: 745.
updates[].backorderQuantity integer Current backorder quantity after the adjustment. Sample: 0.

Error response

Parameter Type Description
success boolean false when one or more adjustments failed. Sample: false.
data array Array of results with error details per item.
data[].partnerSku string The partner SKU that failed. Sample: SKU-001.
data[].success boolean false for failed items. Sample: false.
data[].message string Error description. Sample: No inventory item found for partnerSku: SKU-001.

HTTP Status Codes

Status Description
200 Request processed (check individual item success flags for results)
400 Validation error (empty adjustments, invalid adjustmentType, etc.)
403 Invalid or missing API key