boscod OpenAPI
  1. Rates
boscod OpenAPI
  • Introduction
  • Shipping label
  • Errors
  • Changelog
  • API
    • Coverage Area
      • Provinces
      • Cities
      • Districts
      • Search Area
    • Rates
      • List Courier
        GET
      • Shipping Fee
        GET
      • Shipping Fee (SSE)
        GET
    • Orders
      • Create Order
      • Cancel Order
      • Detail Order
      • Tracking
      • Estimation Rates
  • Webhook
  1. Rates

Shipping Fee (SSE)

Developing
GET
/v1/courier/rates_stream
Provides real-time shipping rate calculations through Server-Sent Events (SSE). This endpoint streams rate calculations progressively as they become available from each courier service.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
origin_id
integer 
required
Origin location identifier
Example:
15780
destination_id
integer 
required
Destination location identifier
Example:
14900
weight
number 
required
Minimum weight is 0.5 kg
Example:
1
length
integer 
optional
Package length in cm
Example:
10
height
integer 
optional
Package height in cm
Example:
10
width
integer 
optional
Package width in cm
Example:
10

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://demo.boscod.com:4004/v1/courier/rates_stream?origin_id=15780&destination_id=14900&weight=1&length=10&height=10&width=10'

Responses

🟢200OK
text/event-stream
Body
object {0}
Examples
{
    "total_rates": 6,
    "rates": [
        {
            "courier_code": "idx",
            "cod": 1,
            "courier_name": "IDEXPRESS",
            "drop_off": null,
            "etd": "2-3",
            "max_price": 10700,
            "price": 10165,
            "service_code": "03",
            "service_name": "Lite",
            "shipping_type": "regular",
            "volume_price": 6000,
            "rating": 0
        },
        {
            "courier_code": "idx",
            "cod": 1,
            "courier_name": "IDEXPRESS",
            "drop_off": null,
            "etd": "2-3",
            "max_price": 14500,
            "price": 11600,
            "service_code": "00",
            "service_name": "STD",
            "shipping_type": "regular",
            "volume_price": 6000,
            "rating": 0
        },
        {
            "courier_code": "jne",
            "cod": "1",
            "courier_name": "JNE",
            "drop_off": null,
            "etd": "3-4",
            "max_price": 70000,
            "price": 70000,
            "service_code": "JTR",
            "service_name": "JNETRUCK",
            "shipping_type": "cargo",
            "volume_price": 5000,
            "rating": 0
        },
        {
            "courier_code": "jne",
            "cod": "1",
            "courier_name": "JNE",
            "drop_off": null,
            "etd": "1-2",
            "max_price": 17000,
            "price": 10200,
            "service_code": "REG",
            "service_name": "REG",
            "shipping_type": "regular",
            "volume_price": 6000,
            "rating": 0
        },
        {
            "courier_code": "ninja",
            "cod": "1",
            "courier_name": "NINJA EXPRESS",
            "drop_off": null,
            "etd": "",
            "max_price": 14000,
            "price": 11200,
            "service_code": "NINJAREG",
            "service_name": "NINJAREG",
            "shipping_type": "regular",
            "volume_price": 6000,
            "rating": 0
        },
        {
            "courier_code": "anteraja",
            "cod": "1",
            "courier_name": "ANTERAJA",
            "drop_off": null,
            "etd": 2,
            "max_price": 14286,
            "price": 11428.8,
            "service_code": "ANTERAJAREG",
            "service_name": "REGULER",
            "shipping_type": "regular",
            "volume_price": 6000,
            "rating": 0
        }
    ]
}
Previous
Shipping Fee
Next
Orders
Built with