GET
Get available stock

Authorizations

x-api-key
string
header
required

Query Parameters

warehouse_code
string
required

Code of the warehouse to read stock from, e.g. BOG-2. See warehouse codes.

sku
string[]

SKUs to include. Send several SKUs as a JSON array in a single parameter, URL-encoded: sku=["SKU-001","SKU-002"]. A single SKU can be sent as plain text (sku=SKU-001). Repeating the parameter (sku=A&sku=B) does not work: only the last value is used. When you send SKUs, the page size is capped at the number of SKUs sent.

Required string length: 1 - 100
page
integer
default:1

Page number, starting at 1.

Required range: x >= 1
per_page
integer
default:10

Number of products per page.

Required range: 1 <= x <= 100

Response

Available stock for the requested page of products.

data
object[]

One entry per product on the requested page.

meta_data
object

Pagination information.