PApaymongo
Inventory Items

Apply an absolute stock count

Set an item's on_hand count to an absolute value, recorded as one correction movement. A count equal to the current on_hand succeeds without writing a movement. Refused when the count would fall below held.

post/v1/inventory_items/{id}/counts

Request

  • Base URL
    https://inventories-api.paymongo.com
  • URL
    https://inventories-api.paymongo.com/v1/inventory_items/{id}/counts
  • Auth
    HTTP basic

Path parameters

idstring required

Item id

Request body

on_handinteger required

OnHand is a pointer so binding's "required" check does not mistake a legitimate zero count for an absent field: an empty body must 400, not silently zero the item's stock.

Example request

{
  "on_hand": 95
}

Response

OK

has_moreboolean

Example response

{
  "data": {
    "available": 90,
    "created_at": 1752000000,
    "held": 10,
    "id": "invitem_abc123",
    "livemode": true,
    "low_stock_threshold": 5,
    "on_hand": 100,
    "updated_at": 1752000000,
    "variant_id": "prdvar_abc123",
    "warehouse_id": "ww_abc123"
  }
}

Changes

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