Getting the details of a product

API reference ProductAPI

Overview

To get the details of a specific product including it stock levels, send the product_id in the request. The response will include different product details

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

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,
    "id": "the_product_id",
    "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,
    "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": {
        "the_warehouse_id": {
            "available": 11,
            "physical": 0,
            "reserved": 0,
            "unavailable": 0
        }
    },
    "isDangerousGoods": false,
    "customsTariffNumber": "123456789"
}