---
title: "Get stock availability"
method: POST
path: "/v1/availability"
tags: ["Availability"]
---

# Get stock availability

`POST /v1/availability`

## Request

- Base URL: `https://inventories-api.paymongo.com`
- URL: `https://inventories-api.paymongo.com/v1/availability`
- Auth: one of:
  - HTTP basic
  - HTTP bearer

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.

## Request body

- AvailabilityRequestDTO: Variants to check; body carries livemode for S2S callers
  - `items` AvailabilityLineRequestDTO[], required: Items is capped at 100 lines, mirroring the hold line cap; each line costs one query.
    - `variant_id` string, required
    - `warehouse_ids` string[]
  - `livemode` boolean: LiveMode is required for S2S callers; ignored for merchant secret-key callers.

## Response `200`

OK

- object: Standard response containing data and its metadata if any
  - `data` AvailabilityResponseDTO[]
    - `available` integer
    - `variant_id` string
    - `warehouses` WarehouseAvailabilityResponseDTO[]
      - `available` integer
      - `inventory_item_id` string
      - `warehouse_id` string
  - `has_more` boolean

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/paymongo/apis/inventories.md) - [All operations](https://skmtc.dev/paymongo/apis/inventories/llms.txt) - [OpenAPI document](https://skmtc.dev/paymongo/apis/inventories/revisions/7307fa6b0b16?raw)
