GuidesAPI ReferenceChangelog
API Reference

List your products

get
https://api.getbyrd.com/v2/warehouse/products

Returns your products with their stock levels, paginated. Deleted
products and packaging materials are left out unless you ask for
them. See the Listing products guide.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false

Whether to include the storages holding the product. Defaults to false.

boolean
Defaults to false

Whether to include the lots of each product. Defaults to false.

boolean
Defaults to false

Whether to include deleted products. Defaults to false.

boolean
Defaults to true

Whether to include products that cannot be delivered to a warehouse themselves, such as bundles. Defaults to true.

boolean
Defaults to false

Whether to include packaging materials. Defaults to false.

only
array of strings

Fields to return, as a comma-separated list of field names or dotted paths to nested fields, for example id,sku,packagingUnits. All fields are returned when omitted.

only
boolean

Only include products that are (true) or are not (false) active.

string

Only include the product with this byrd SKU.

string

Only include products with this (deprecated) shop article ID.

string

Only include products with this (deprecated) shop article variant ID.

string

Only include the product with exactly this SKU.

skus
array of strings

Only include the products with these comma-separated SKUs; combined with ids, products matching either list are included.

skus
ids
array of strings

Only include the products with these comma-separated IDs; combined with skus, products matching either list are included.

ids
exclude_skus
array of strings

Exclude the products with these comma-separated SKUs. Cannot be combined with ids or skus.

exclude_skus
exclude_ids
array of strings

Exclude the products with these comma-separated IDs. Cannot be combined with ids or skus.

exclude_ids
string

Only include products linked to this shop.

shop_ids
array of uuids

Only include products linked to one of these comma-separated shop IDs.

shop_ids
uuid

Only include products owned by this user.

string
enum

Only include products of this type, for example product or bundle.

boolean

Only include products that are (true) or are not (false) organic.

boolean

Only include products that are (true) or are not (false) GRS compliant.

boolean

Only include products with lot tracking enabled (true) or disabled (false).

warehouse_ids
array of uuids

Only include products stocked in one of these comma-separated warehouse IDs; the stock levels then only count those warehouses.

warehouse_ids
boolean
enum

Only include products with at least one change request; only true is accepted.

Allowed:
string
enum

Only include products with a change request in this status.

  • open
  • accepted
  • declined
Allowed:
change_request_statuses
array of strings

Only include products with a change request in one of these comma-separated statuses: open, accepted, declined.

change_request_statuses
Allowed:
boolean

Only include products that do (true) or do not (false) have dangerous goods entries.

integer
≥ 0

Only include products with at least this physical stock; at least 0 and not above physicalStockMax.

integer
≥ 0

Only include products with at most this physical stock; at least 0.

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 about 1 month 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 about 1 month ago