Create Shipment (Label)
POST
/create-label
Request
Query Params
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://api.byelabel.com/v1/create-label?filter={"parent_code":"US"}' \
--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": [
"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",
"zip_code": "string",
"state_code": "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",
"zip_code": "string",
"state_code": "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",
"zip_code": "string",
"state_code": "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",
"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 Response Example
200 - Example 1
{
"success": true,
"payload": {
"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"
}
},
"transaction": {
"id": "string",
"response_time": 0
}
}Modified at 2026-02-08 03:47:28