Shipped items lot data

API reference ShipmentPickListAPIV3

Overview

To get the details of the lots sent in a specific shipment, send the shipment_id in the endpoint. The response will include different pick details for the shipment

Method access
      GET https://api.getbyrd.com/v3/shipments/<shipment_id>/picks
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": [
        {
            "quantity": 2,
            "product": {
                "barcode": "1234567890",
                "id": "product_id",
                "name": "Awsome product",
                "sku": "SKU-A"
            },
            "warehouse_id": "warehouse_id",
            "id": "pick_id",
            "packaging_unit": null,
            "reservation": false,
            "shipment_id": "shipment_id",
            "storage": {
                "lot": {
                    "expiry_date": "2024-12-31",
                    "id": "lot_id",
                    "lot_number": "ABC1234"
                },
                "bsid": "BSID_STORAGE",
                "shelf_identifier": "SH-MS-10",
                "id": "storage_id"
            },
            "container_code": "ABC1234567",
            "total_items": 2
        }
    ]
}

Lot information data format

The picks data contains a section called storage. Under this section you will
find information regarding the storage that the SKU was picked from including
the lot information. This information is only available for shipments after
status packaging (packaged, sent and delivered).

Lot fields

Field

Description

lot_number

The lot number the product was picked from.

expiry_date

The expiry date of the lot if tracked (null otherwise).

id

The internal id in byrd of this lot.

The following code is an example of the storage field. This example shows only a the relevant fields. A complete example can be found in the documentation of the response of the request.

{
    "storage": {
        "lot": {
            "expiry_date": "2024-12-31",
            "id": "lot_id",
            "lot_number": "ABC1234"
        }
    }
}