Adjust Inventory

This endpoint adjusts inventory levels for stock reconciliation, damage, or other reasons.

POST /v1/inventory_items/:id/adjust

cURL

curl --location --request POST 'https://api.stateset.com/v1/inventory_items/:id/adjust' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "inventory_item_id": "inv_abc123",
    "adjustment_type": "reconciliation",
    "quantity_change": -5,
    "reason": "Physical count showed 5 less than system",
    "warehouse_id": "wh_east_01",
    "location_id": "loc_a1_shelf_3",
    "reference_number": "COUNT_2024_001",
    "cost_adjustment": -125.00
}'

Response

{
  "id": "adj_xyz789",
  "inventory_item_id": "inv_abc123",
  "adjustment_type": "reconciliation",
  "quantity_before": 100,
  "quantity_after": 95,
  "quantity_change": -5,
  "cost_impact": -125.00,
  "reason": "Physical count showed 5 less than system",
  "warehouse_id": "wh_east_01",
  "location_id": "loc_a1_shelf_3",
  "reference_number": "COUNT_2024_001",
  "adjusted_by": "user_123",
  "adjusted_at": "2024-01-15T14:30:00Z",
  "success": true
}

Body

inventory_item_id · string

The unique identifier of the inventory item to adjust

adjustment_type · string

The type of adjustment (e.g., “reconciliation”, “damage”, “theft”, “expiration”, “return”, “manual”)

quantity_change · number

The quantity to adjust (positive for increase, negative for decrease)

reason · string

Detailed reason for the adjustment

warehouse_id · string

The warehouse where the adjustment is being made

location_id · string

The specific location within the warehouse

reference_number · string

Reference number for tracking (e.g., count sheet number, incident report)

cost_adjustment · number

The cost impact of this adjustment for accounting purposes

Response

id · string

The unique identifier of the adjustment record

inventory_item_id · string

The inventory item that was adjusted

adjustment_type · string

The type of adjustment performed

quantity_before · number

The quantity before adjustment

quantity_after · number

The quantity after adjustment

quantity_change · number

The actual quantity change applied

cost_impact · number

The financial impact of this adjustment

adjusted_by · string

The user who performed the adjustment

adjusted_at · string

Timestamp when the adjustment was made

success · boolean

Indicates whether the adjustment was successful

Error Responses

error · object

Error object containing details about what went wrong

Show properties

code · string

Error code (e.g., “insufficient_stock”, “invalid_quantity”, “warehouse_not_found”)

message · string

Human-readable error message

details · object

Additional error details

cURL

curl --location --request POST 'https://api.stateset.com/v1/inventory_items/:id/adjust' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "inventory_item_id": "inv_abc123",
    "adjustment_type": "reconciliation",
    "quantity_change": -5,
    "reason": "Physical count showed 5 less than system",
    "warehouse_id": "wh_east_01",
    "location_id": "loc_a1_shelf_3",
    "reference_number": "COUNT_2024_001",
    "cost_adjustment": -125.00
}'

Response

{
  "id": "adj_xyz789",
  "inventory_item_id": "inv_abc123",
  "adjustment_type": "reconciliation",
  "quantity_before": 100,
  "quantity_after": 95,
  "quantity_change": -5,
  "cost_impact": -125.00,
  "reason": "Physical count showed 5 less than system",
  "warehouse_id": "wh_east_01",
  "location_id": "loc_a1_shelf_3",
  "reference_number": "COUNT_2024_001",
  "adjusted_by": "user_123",
  "adjusted_at": "2024-01-15T14:30:00Z",
  "success": true
}