GuidesAPI ReferenceChangelog
API Reference

Download your inventory as CSV

get
https://api.getbyrd.com/v2/warehouse/export/user//inventory

Returns a CSV file with one row per product and its physical,
reserved and unavailable stock. Set by_warehouse or by_lot to
split the rows per warehouse or per lot.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of your byrd account (UUID); any other account answers 404.

Query Params
boolean
Defaults to false

Whether to add one row per lot of each product, with the lot details. Defaults to false.

boolean
Defaults to false

Whether to add one row per warehouse holding each product, with the warehouse details. Defaults to false.

Responses

Updated 7 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago