Code Playground

Request Endpoint
https://production.courierapi.co.uk/api/couriers/v1/
Reset Session
Request Body
{
    "testing": true,
    "auth_company": "",
    "request_id": "8ad29eb77574a48cf7b371937fb915931874d84b",
    "format_address_default": true,
    "shipment": {
        "label_size": "6x4",
        "label_format": "pdf",
        "generate_invoice": false,
        "generate_packing_slip": false,
        "courier": {
            "posting_location": "9000257150"
        },
        "dc_service_id": "ROYALMAIL-CRL1-P",
        "collection_date": "2025-12-09T16:00:00",
        "reference": "DC1234567890",
        "delivery_instructions": "Leave on the porch",
        "ship_from": {
            "name": "John Doe",
            "phone": "01377455180",
            "email": "hello@despatchcloud.com",
            "company_name": "Despatch Cloud Ltd",
            "address_1": "Unit 76",
            "address_2": "Warfield Road",
            "address_3": "",
            "city": "Driffield",
            "postcode": "YO25 9QF",
            "county": "East Yorkshire",
            "country_iso": "GB",
            "company_id": "",
            "tax_id": ""
        },
        "ship_to": {
            "name": "Jane Doe",
            "phone": "01377455180",
            "email": "hello@despatchcloud.com",
            "company_name": "Despatch Cloud Ltd",
            "address_1": "Unit 76",
            "address_2": "Warfield Road",
            "address_3": "",
            "city": "Driffield",
            "postcode": "YO25 9QF",
            "county": "East Yorkshire",
            "country_iso": "GB"
        },
        "parcels": [
            {
                "dim_width": 20,
                "dim_height": 40,
                "dim_length": 40,
                "dim_unit": "cm",
                "items": [
                    {
                        "description": "Test Item One",
                        "origin_country": "GB",
                        "quantity": 1,
                        "value": 20,
                        "value_currency": "GBP",
                        "weight": "0.6",
                        "weight_unit": "kg",
                        "sku": "TEST0001",
                        "hs_code": "12345"
                    },
                    {
                        "description": "Test Item Two",
                        "origin_country": "GB",
                        "quantity": 1,
                        "value": 5,
                        "value_currency": "GBP",
                        "weight": "0.4",
                        "weight_unit": "kg",
                        "sku": "TEST0002",
                        "hs_code": "12345"
                    }
                ]
            }
        ]
    }
}
Response Body
Request Headers

Code Playground
