Shipment List

GET

/shipments

Shipment list using infinite method. For the next page send the last id of the data item.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Responses

🟢200Success

application/json

Body

🟠401Unauthorized Response

🔴500Server Error Response

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.byelabel.com/v1/shipments?filter={"status":"delivered"}' \
--header 'X-Workspace-Id: ' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "success": true,
    "payload": {
        "data": [
            {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "created_at": "2019-08-24T14:15:22.123Z",
                "tracking_number": "string",
                "currency": "str",
                "tax": 0,
                "cost": 0,
                "total_cost": 0,
                "status": "label-created",
                "provider": "string",
                "carrier": {
                    "id": "string",
                    "code": "string",
                    "name": "string",
                    "service": {
                        "code": "string",
                        "name": "string"
                    },
                    "packaging": {
                        "code": "string",
                        "name": "string"
                    }
                },
                "from": {
                    "name": "string",
                    "company": "string",
                    "country": {
                        "code": "US",
                        "name": "string",
                        "flag": "string"
                    },
                    "zip_code": "string",
                    "state": {
                        "code": "string",
                        "name": "string"
                    },
                    "city": "string",
                    "street": [
                        "str"
                    ],
                    "residential": true,
                    "phone": "string",
                    "email": "user@example.com",
                    "fax": "string",
                    "tax_number": "string",
                    "tax_identifiers": [
                        {
                            "type": "VAT",
                            "number": "string",
                            "authority": {
                                "code": "US",
                                "name": "string"
                            }
                        }
                    ],
                    "return_to": {
                        "name": "string",
                        "company": "string",
                        "country": {
                            "code": "US",
                            "name": "string",
                            "flag": "string"
                        },
                        "zip_code": "string",
                        "state": {
                            "code": "string",
                            "name": "string"
                        },
                        "city": "string",
                        "street": [
                            "str"
                        ],
                        "residential": true,
                        "phone": "string",
                        "email": "user@example.com",
                        "fax": "string",
                        "tax_number": "string",
                        "tax_identifiers": [
                            {
                                "type": "VAT",
                                "number": "string",
                                "authority": {
                                    "code": "US",
                                    "name": "string"
                                }
                            }
                        ]
                    }
                },
                "to": {
                    "name": "string",
                    "company": "string",
                    "country": {
                        "code": "US",
                        "name": "string",
                        "flag": "string"
                    },
                    "zip_code": "string",
                    "state": {
                        "code": "string",
                        "name": "string"
                    },
                    "city": "string",
                    "street": [
                        "str"
                    ],
                    "residential": true,
                    "phone": "string",
                    "email": "user@example.com",
                    "fax": "string",
                    "tax_identifiers": [
                        {
                            "type": "VAT",
                            "number": "string",
                            "authority": {
                                "code": "US",
                                "name": "string"
                            }
                        }
                    ],
                    "sold_to": {
                        "name": "string",
                        "company": "string",
                        "country": {
                            "code": "US",
                            "name": "string",
                            "flag": "string"
                        },
                        "zip_code": "string",
                        "state": {
                            "code": "string",
                            "name": "string"
                        },
                        "city": "string",
                        "street": [
                            "str"
                        ],
                        "residential": true,
                        "phone": "string",
                        "email": "user@example.com",
                        "fax": "string",
                        "tax_identifiers": [
                            {
                                "type": "VAT",
                                "number": "string",
                                "authority": {
                                    "code": "US",
                                    "name": "string"
                                }
                            }
                        ]
                    }
                },
                "package": [
                    {
                        "id": "string",
                        "description": "string",
                        "weight": {
                            "unit": "lb",
                            "value": 0
                        },
                        "dimensions": {
                            "unit": "in",
                            "length": 0,
                            "width": 0,
                            "height": 0
                        }
                    }
                ],
                "items": [
                    {
                        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                        "code": "string",
                        "description": "string",
                        "image_url": "string",
                        "hts_code": "string",
                        "country_of_origin": "string",
                        "quantity": 0,
                        "currency_code": "string",
                        "unit_selling_price": 0,
                        "total_selling_price": 0,
                        "weight": {
                            "unit": "lb",
                            "value": 0
                        }
                    }
                ],
                "order": {
                    "date": "2026-01-15",
                    "number": "string",
                    "buyer_note": "string"
                },
                "activity": [
                    {
                        "code": "string",
                        "status": "label-created",
                        "date_time": "2019-08-24T14:15:22.123Z",
                        "description": "string"
                    }
                ]
            }
        ]
    },
    "limit": 0,
    "more": 0,
    "transaction": {
        "id": "string",
        "response_time": 0
    }
}

Modified at 2026-02-08 05:03:49

Create Shipment (Label)

Fail Result Schema