GuidesAPI ReferenceChangelog
API Reference

List Products.

get
https://api.getbyrd.com/v2/warehouse/products
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
change_request_statuses
array of strings
change_request_statuses
string
ids
array of strings

Select a set of unique Product IDs

ids
boolean
boolean
warehouse_ids
array of strings
warehouse_ids
string

Select a single SKU of a Product

boolean
Defaults to false
boolean
Defaults to false
boolean
string
enum
string
string
enum
Allowed:
string
string
boolean
exclude_ids
array of strings

Exclude a set of Product IDs

exclude_ids
boolean
enum
Allowed:
string
boolean
Defaults to false
boolean
Defaults to true
skus
array of strings

Select a set of Product SKUs

skus
exclude_skus
array of strings

Exclude a set of Product SKUs

exclude_skus
shop_ids
array of strings

Select a set of Shop IDs

shop_ids
integer
≥ 1
Defaults to 250

Number of results per page

integer
≥ 0
Defaults to 0

Result page to jump to, 0-indexed

string

The model field to sort results by

string
enum

The direction of result sorting

Allowed:
string

The search term

fields
array of strings

Model fields to search through; comma separated

fields
Headers
string
enum
Defaults to application/vnd.byrd.customer+json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

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

Updated 7 months ago