Create Shipment (Label)

POST

/create-label

Create shipment and get carrier label

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠401Unauthorized Response

🔴500Server Error Response

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.byelabel.com/v1/create-label' \
--header 'X-Workspace-Id: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "carrier": {
        "id": "string",
        "code": "string",
        "service": "string",
        "packaging": "string"
    },
    "from": {
        "name": "string",
        "company": "string",
        "country_code": "US",
        "zip_code": "string",
        "state_code": "string",
        "city": "string",
        "street": [
            "string"
        ],
        "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",
            "zip_code": "string",
            "state_code": "string",
            "city": "string",
            "street": [
                "string"
            ],
            "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",
        "zip_code": "string",
        "state_code": "string",
        "city": "string",
        "street": [
            "string"
        ],
        "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",
            "zip_code": "string",
            "state_code": "string",
            "city": "string",
            "street": [
                "string"
            ],
            "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",
            "total_selling_price": 0,
            "weight": {
                "unit": "lb",
                "value": 0
            },
            "options": [
                {
                    "id": "string",
                    "name": "Color",
                    "value": "Red"
                }
            ]
        }
    ],
    "date": "2026-01-15",
    "invoice": {
        "date": "2026-01-15",
        "number": "string",
        "tax": 0,
        "contents": "merchandise",
        "declaration": "string",
        "description": "string"
    },
    "print": {
        "format": "string",
        "resolution": 0,
        "size": "string"
    },
    "order": {
        "date": "2026-01-15",
        "number": "string",
        "buyer_note": "string"
    }
}'

Response Example

200 - Domestic Label

{
    "success": true,
    "payload": {
        "id": "f4dffe63-071a-4a9f-8738-bb782363c42c",
        "created_at": "2025-01-23T22:37:06.083Z",
        "provider": "fedex",
        "carrier": {
            "id": "fedex",
            "code": "fedex",
            "name": "FedEx",
            "service": {
                "code": "FEDEX_GROUND",
                "name": "FedEx Ground"
            },
            "packaging": {
                "code": "YOUR_PACKAGING",
                "name": "Package"
            }
        },
        "currency": "USD",
        "cost": 9.16,
        "tax": 0,
        "total_cost": 9.16,
        "tracking_number": "771641238420",
        "tracking_url: "https://www.fedex.com/fedextrack/?trknbr=771641238420",
        "label": {
            "data": "JVBERi0xLjMKJf////…=",
            "format": "pdf"
        }
    },
    "transaction": {
        "id": "0b190365aab4d073dd927fb96b63fcbe",
        "response_time": 3781.973
    }
}

Modified at 2026-02-09 02:58:26

Get Carrier Rates

Void Shipment (Label)