Shipping Fee - boscod OpenAPI

Calculates and returns detailed shipping rates from multiple courier services based on package specifications and shipping parameters. Supports dimensional weight calculation and includes courier performance ratings.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

destination_id

integer

required

Destination location identifier

Example:

14900

origin_id

integer

required

Origin location identifier

Example:

15780

weight

number

required

Package weight in kg (minimum 0.5 & maximal 99)

Example:

courier_code

string

required

Specific courier service code

Example:

idx

length

integer

optional

Package length in cm (default 10)

Example:

height

integer

optional

ackage width in cm (default 10)

Example:

width

integer

optional

Package height in cm (default 10)

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

array of:

cod

integer

required

Cash on Delivery availability (0: Not Coveraged COD, 1: Coveraged COD)

courier_name

string

required

Display name of courier service

drop_off

string

required

Drop-off service availability (0: Not Coveraged Drop off, 1: Coveraged Drop off)

etd

string

required

Estimated time of delivery

max_price

integer

required

Maximum shipping price

price

integer

required

Final calculated price after discounts

service_code

string

required

Unique service identifier

service_name

string

required

Service level name

shipping_type

string

required

Shipping category

volume_price

integer

required

Price based on volumetric weight

rating

integer

required

Courier performance rating (0-5)

courier_code

string

required

Unique identifier code for the courier

Example

[
    {
        "cod": 1,
        "courier_name": "IDEXPRESS",
        "drop_off": "1",
        "etd": "2-3",
        "max_price": 14500,
        "price": 11600,
        "service_code": "00",
        "service_name": "STD",
        "shipping_type": "regular",
        "volume_price": 6000,
        "rating": 0,
        "courier_code": "idx"
    },
    {
        "cod": 1,
        "courier_name": "IDEXPRESS",
        "drop_off": "1",
        "etd": "3-5",
        "max_price": 50000,
        "price": 47500,
        "service_code": "06",
        "service_name": "IDTruck",
        "shipping_type": "cargo",
        "volume_price": 4000,
        "rating": 0,
        "courier_code": "idx"
    }
]

🟠400Bad Request

🟠404Record Not Found