Byelabel Api
    Byelabel Api
    • ByeLabel API (v1) Document
    • Me
      GET
    • Login
      POST
    • Refresh Token
      POST
    • Balance
      GET
    • Carrier List
      GET
    • Country List
      GET
    • State/Province List
      GET
    • State & City From Postal Code
      POST
    • Get Carrier Rates
      POST
    • Create Shipment (Label)
      POST
    • Shipment List
      GET
    • Schemas
      • Fail Result Schema
      • Success Result Schema
      • HTTP Error Schema
      • Tax Identifiers Schema
      • Weight Schema
      • Dimensions Schema
      • Sender Schema
      • Recipient Schema
      • Package Schema
      • Package Line Items Schema
      • Product Options Schema
      • Invoice Schema
      • Printing Options Schema
      • Order Schema
      • Carrier Rate Result Schema
      • Created Shipment Result Schema
      • Document To Print
      • Country Schema
      • State / Province Schema
      • Carrier Schema
      • Shipment Activity Schema

    Created Shipment Result Schema

    Shipment result

    {
        "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"
            }
        },
        "label": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "format": "string",
            "data": "string"
        },
        "invoice": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "format": "string",
            "data": "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"
        }
    }
    Built with