Listing products

API reference ProductAPI

Overview

This endpoint can be used to get a list of the products that are created in byrd. The response will include different product details including the stocks. If your products are stored in multiple byrd warehouses you will get the stock by warehouse

Method access
      GET https://api.getbyrd.com/v2/warehouse/products
Request Headers
      Authorization: Bearer token-from >Authentication
      Content-Type: application/json
      User-Agent: your user-agent >How to call the APIs

Query params

You can filter the list by different fields combining them depending on your needs. The most frequent are:

Field

Type

Description

productType string

Type of product
If accepts product and bundle

sku string

Include this specific sku.

lotsEnabled boolean

Include only products with lot tracking enabled.
If accepts true and false

organic boolean

Include only products with organic flag enabled.
If accepts true and false

include_non_deliverable boolean

Filter out products that cannot be logically delivered to a warehouse.
Example: bundles
If accepts true and false

include_deleted boolean

Include products that were deleted
If accepts true and false
Defaults to false

active boolean

Filter products by its status
If accepts true and false

include_packaging_material boolean

Include packaging materials.
If accepts true and false

qstring

Search by term. It searches for that term in the fields specified underfield

fieldsstring

Fields where to search for the value inq

Pagination

By sending these parameters you can get the result in different pages:

Field

Type

Description

per_page string

Items per page
Default is 250

page string

It returns only that page

sort_by string

It sorts the response by this field

sort_order string

It sorts the response ascending or descending depending on this value
It accepts asc and desc

Getting stock per warehouse

The response contains a child Element per Product called stocksByWarehouse.
If multiple warehouses are connected with a user account the stock by warehouse
will be shown in the following way. Otherwise the result will be empty ({}).

"stocksByWarehouse": {
  "<warehouse-1-id>": {
    "available": 0,
    "physical": 0,
    "reserved": 0,
    "unavailable": 0
  },
  "<warehouse-2-id>": {
    "available": 0,
    "physical": 0,
    "reserved": 0,
    "unavailable": 0
  }
}

Successful response example

"data": [
  {
    "availableStock": 11,
    "physicalStock": 0,
    "unavailableStock": 0,
    "reservedStock": 0,
    "skipBarcodePick": flase,
    "description": "string",
    "packagingUnitEnabled": false,
    "productID": "string",
    "ean": "string",
    "purchasePrice": {
        "currency": "EUR",
        "value": "0.01",
        "taxFactor": "1.0"
    },
    "purchasePriceEvidenceURL": null,
    "userID": "1111-22222-33333-44444",
    "id": "1111-33333-22222-44444",
    "deleted": false,
    "changeRequests": null,
    "packagingUnits": [
        {
            "barcodeValue": "string",
            "active": true,
            "barcodeType": "string",
            "quantity": 0
        }
    ],
    "pictureID": null,
    "dangerousGoods": [
        {
            "createdAt": "2023-01-06T14:12:59.105Z",
            "limit": 0,
            "productID": "string",
            "unit": "string",
            "updatedAt": "2023-01-06T14:12:59.105Z",
            "dangerousGoodsClass": 0,
            "id": "string",
            "dangerousGoodsType": "string",
            "description": "string",
            "UNNumber": "string",
            "quantity": 0
        }
    ],
    "barcodeType": "string",
    "dangerousGoodsMSDSURL": null,
    "shopID": null,
    "active": true,
    "barcode": null,
    "fragile": false,
    "serialNumberEnabled": false,
    "upc": null,
    "bsku": "BSKU-123452",
    "reorderPoint": 0,
    "internalComments": null,
    "sku": "MULTI127",
    "retailPrice": null,
    "productType": "product",
    "dimensions": null,
    "updatedAt": "2023-01-06T10:00:09.319935+00:00",
    "weightEstimation": null,
    "user": {
        "id": "4ea4616c-803b-4623-b30a-57734874e148"
    },
    "organic": false,
    "isbn": null,
    "lotsEnabled": false,
    "deletedDate": null,
    "originCountryCode": "GB",
    "name": "Product 1",
    "variantID": null,
    "createdAt": "2023-01-06T10:00:09.319925+00:00",
    "stocksByWarehouse": {
        "111-344532-1342245-323453": {
            "available": 11,
            "physical": 0,
            "reserved": 0,
            "unavailable": 0
        }
    },
    "isDangerousGoods": false,
    "customsTariffNumber": "123456789"
  },
]