Get Carrier Rates

POST

/rates

Get the detailed info of a country code and zip code

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

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 -g --request POST 'https://api.byelabel.com/v1/rates?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": {
        "country_code": "string",
        "zip_code": "string",
        "state_code": "string",
        "city": "string",
        "street": [
            "str"
        ],
        "residential": true
    },
    "to": {
        "country_code": "string",
        "zip_code": "string",
        "state_code": "string",
        "city": "string",
        "street": [
            "str"
        ],
        "residential": true
    },
    "package": [
        {
            "weight": {
                "unit": "lb",
                "value": 0
            },
            "dimensions": {
                "unit": "in",
                "length": 0,
                "width": 0,
                "height": 0
            }
        }
    ]
}'

Response Example

200 - Example 1

{
    "success": true,
    "payload": [
        {
            "carrier": {
                "id": "string",
                "code": "string",
                "name": "string",
                "service": {
                    "code": "string",
                    "name": "string"
                },
                "packaging": {
                    "code": "string",
                    "name": "string"
                }
            },
            "rate": {
                "currency": "string",
                "cost": 0
            }
        }
    ],
    "transaction": {
        "id": "string",
        "response_time": 0
    }
}

Modified at 2026-02-08 02:37:09

State & City From Postal Code

Create Shipment (Label)