PApaymongo
Inventory Items

Get an inventory item

Retrieve a single inventory item by id. Merchants authenticate with a secret key; internal services must pass ?livemode explicitly.

get/v1/inventory_items/{id}

Request

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

Path parameters

idstring required

Item id

Query parameters

livemodeboolean

Required for S2S callers; ignored for merchant secret-key callers

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.