PayPilot API
Live demoGitHub
HomeGuidesSDKsContext PluginAPI Reference
Inventory

List inventory

GET
/api/v1/inventory/items

List inventory.

Authorization

HTTPBearer
AuthorizationBearer <token>

JWT access token

In: header

Query Parameters

page?integer
Range1 <= value
Default1
page_size?integer
Range1 <= value <= 200
Default50
status?string|null
q?|
Lengthlength <= 120
merchant_id?|

Optional merchant to act on. Must be one you are a member of.

Formatuuid

Header Parameters

X-Merchant-ID?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/inventory/items"
{  "data": {    "items": [      {}    ],    "pagination": {      "has_next": false,      "has_previous": false,      "page": 1,      "page_size": 25,      "total": 0,      "total_pages": 0    }  },  "meta": {},  "success": true}

Preview a bulk inventory import POST

Upload a .xlsx or .csv export. With no `mapping`, columns are auto-matched to inventory fields by header text (e.g. 'Item Code' -> sku, 'Reorder Level' -> reorder_point); pass one back (edited or not) to re-validate against it before committing. Every row is validated here - nothing is written yet.

Inventory item detail GET

Inventory item detail.