PApaymongo
Availability

Get stock availability

Look up available stock per requested variant across its non-disabled warehouses, optionally filtered to a set of warehouses. Read-only; a variant with no items still appears with a zero total.

post/v1/availability

Request

  • Base URL
    https://inventories-api.paymongo.com
  • URL
    https://inventories-api.paymongo.com/v1/availability
  • Auth
    • HTTP basic
    • or HTTP bearer

Request body

livemodeboolean

LiveMode is required for S2S callers; ignored for merchant secret-key callers.

Example request

{
  "items": [
    {
      "variant_id": "prdvar_abc123",
      "warehouse_ids": [
        "ww_abc123"
      ]
    }
  ],
  "livemode": true
}

Response

OK

has_moreboolean

Example response

{
  "data": [
    {
      "available": 90,
      "variant_id": "prdvar_abc123",
      "warehouses": [
        {
          "available": 90,
          "inventory_item_id": "invitem_abc123",
          "warehouse_id": "ww_abc123"
        }
      ]
    }
  ]
}

Changes

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