Create AWB Documentation

Endpoint

POST {base_url}/shipment/awb

Authentication - Request Headers

Authorization: Bearer <your_token>
Content-Type: application/json

Request Parameters

Field Name Type Description Required
invoice_datestring (YYYY-MM-DD)Date of invoiceRequired
destination_countrystringReceiver country (Case-sensitive - see valid countries)Required
servicestringCourier service (e.g., DHL)Required
reference_nostringReference NumberOptional
kyc1[kyc_type]intIndicates the sender's KYC document type.

Allowed values:
1 = Passport Number
2 = Voter ID
3 = PAN Number
4 = Aadhaar Number
5 = GSTIN (Normal)
Required
kyc1[kyc_number]stringSender KYC numberRequired
kyc1[kyc_filename]stringSender KYC File NameRequired
kyc1[kyc_filedata]base64encodedKYC File Base64 EncoadedRequired
kyc2[kyc_filename]stringSender KYC File NameOptional
kyc2[kyc_filedata]base64encodedKYC File Base64 EncoadedOptional
pcs_typestringPCS TypeRequired
shipper[name]stringSender nameRequired
shipper[phone_no]stringSender phoneRequired
shipper[company_name]stringSender companyRequired
shipper[address1]stringSender address line 1Required
shipper[address2]stringSender address line 2Required
shipper[city]stringSender cityRequired
shipper[state]stringSender stateRequired
shipper[zip_code]stringSender ZIP codeRequired
consignee[name]stringReceiver nameRequired
consignee[phone_no]stringReceiver phoneRequired
consignee[email]stringReceiver emailRequired
consignee[company_name]stringReceiver companyRequired
consignee[address1]stringReceiver address 1Required
consignee[address2]stringReceiver address 2Required
consignee[city]stringReceiver cityRequired
consignee[state]stringReceiver state
Pass "NA", in case state not applicable
Required
consignee[zip_code]stringReceiver ZIP codeRequired
consignee[country]stringReceiver countryRequired
boxes[n][boxno]integerBox numberRequired
boxes[n][actualwt]floatWeight in kgRequired
boxes[n][bookinglength]floatLength in cmRequired
boxes[n][bookingbreadth]floatBreadth in cmRequired
boxes[n][bookingheight]floatHeight in cmRequired
items[n][boxno]integerAssociated box numberRequired
items[n][description]stringItem descriptionRequired
items[n][hscode]stringHS codeRequired
items[n][weight]floatItem weightOptional
items[n][quantity]integerItem quantityRequired
items[n][unit_rate]floatUnit rateRequired
items[n][sub_total]floatSubtotalRequired

Payload Example

{
    "invoice_date": "2026-03-30",
    "destination_country": "Australia",
    "service": "Australia Direct",
    "pcs_type": "DOX",
    "reference_no": "REF-1001",
    "third_party_label": false,
    "kyc1": {
        "kyc_type": 4,
        "kyc_number": "987654321001",
        "kyc_filename": "kyc.png",
        "kyc_filedata": "BASE64_DATA"
    },
    "kyc2": {
        "kyc_number": "987654321002",
        "kyc_filename": "kyc2.png",
        "kyc_filedata": "BASE64_DATA"
    },
    "shipper": {
        "name": "Ravi Kumar",
        "phone_no": "+91-9876543210",
        "company_name": "Global Exports Pvt. Ltd.",
        "address1": "14 Industrial Estate",
        "address2": "Phase 2",
        "city": "Mumbai",
        "state": "Maharashtra",
        "zip_code": "400001"
    },
    "consignee": {
        "name": "Emma Thompson",
        "phone_no": "+61-412345678",
        "email": "emma.thompson@austradelogistics.com",
        "company_name": "Austrade Logistics",
        "address1": "22 Oceanic Drive",
        "address2": "Unit 5",
        "city": "Perth",
        "state": "WA",
        "zip_code": "6000",
        "country": "Australia"
    },
    "boxes": [
        {
            "boxno": 1,
            "actualwt": 3.5,
            "bookinglength": 45,
            "bookingbreadth": 30,
            "bookingheight": 20
        },
        {
            "boxno": 2,
            "actualwt": 2.0,
            "bookinglength": 40,
            "bookingbreadth": 25,
            "bookingheight": 15
        },
        {
            "boxno": 3,
            "actualwt": 1.8,
            "bookinglength": 35,
            "bookingbreadth": 20,
            "bookingheight": 10
        }
    ],
    "items": [
        {
            "boxno": 1,
            "description": "Business Documents - Legal Contracts",
            "hscode": "49119990",
            "weight": 3.5,
            "quantity": 1,
            "unit_rate": 100,
            "sub_total": 100
        },
        {
            "boxno": 2,
            "description": "Company Brochures",
            "hscode": "49111010",
            "weight": 2.0,
            "quantity": 500,
            "unit_rate": 0.10,
            "sub_total": 50.0
        },
        {
            "boxno": 3,
            "description": "Confidential Reports",
            "hscode": "49119990",
            "weight": 1.8,
            "quantity": 10,
            "unit_rate": 2.50,
            "sub_total": 25.0
        }
    ]
}

Success Response

{
    "status": true,
    "message": "AWB lable created successfully",
    "data": {
        "AWB": "DK00001",
        "ForwardingNo": "X123456789",
        "Label": Base64()
    }
}
Example Request

                    

Try it (Run API)