We announce the release of a new API version aimed at providing convenience for our partners using the service.
- Overview
- Getting Started
- Authentication
- Q&A
- Common Errors
- API Call Flow
- Instant Order Flow
- Boxme's RTO and RPO
- Changelog
- API References
- Location
- Pickup
- Product
- Shipment (ASN)
- Customer
- Orders
- Order API Overview
- Error Codes
- Get Shipping Option (Fulfillment)POST
- Get Shipping Option (Dropship)POST
- Create B2C OrderPOST
- Create Delivery OrderPOST
- Create B2B OrderPOST
- Update DocumentPUT
- Request Cancel Delivery OrderPOST
- Cancel OrderPOST
- Get Order DetailGET
- Get Order ListGET
- Get Courier ListGET
- Get Courier ServiceGET
- Get Packed ItemsGET
- Order PackPUT
- Get B2B Pickup TimeSlotGET
- Returns
- Finance
- Location
- Webhooks
- Guidelines
Get Shipping Option (Fulfillment)
POST
https://s.boxme.asia/api/v2/courier/pricing/calculate
Last modified:2024-10-02 06:34:46
Rate limit: 2rqs/IP
Request
Header Params
Authorization
string
optional
Example:
Token {{API_TOKEN}}
Content-Type
string
optional
Example:
application/json
Body Params application/json
ship_from
object
required
country
string
required
pickup_id
integer
required
ship_to
object
required
address
string
required
subdistrict
integer
required
contact_name
string
required
country
string
required
district
integer
required
phone
string
required
province
integer
required
zipcode
string
required
shipments
object
required
delivery_note
string
required
parcels
array [object {1}]
required
config
object
required
insurance
string
required
currency
string
required
unit_metric
string
required
sort_mode
string
required
auto_approve
string
required
order_type
string
required
include_distance_service
string
required
payment
object
required
cod_amount
integer
required
referral
object
required
order_number
string
required
fulfillment_vas
object
required
fulfill_now
string
required
priority_fulfill
string
required
Example
{
"ship_from": {
"country": "VN",
"pickup_id": 409223
},
"ship_to": {
"address": "18 Tam Trinh",
"subdistrict": 8980,
"contact_name": "Thịnh NV",
"country": "VN",
"district": 250,
"phone": "84032999292",
"province": 1,
"zipcode": ""
},
"shipments": {
"delivery_note": "",
"parcels": [
{
"items": [
{
"quantity": 1,
"sku": "TEST-0004"
},
{
"quantity": 1,
"sku": "TEST-0005"
}
]
}
]
},
"config": {
"insurance": "N",
"currency": "VND",
"unit_metric": "metric",
"sort_mode": "best_price",
"auto_approve": "Y",
"order_type": "b2c",
"include_distance_service": "Y"
},
"payment": {
"cod_amount": 24000
},
"referral": {
"order_number": "SO092921232"
},
"fulfillment_vas": {
"fulfill_now": "N",
"priority_fulfill": "N"
}
}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 POST 'https://s.boxme.asia/api/v2/courier/pricing/calculate' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"ship_from": {
"country": "VN",
"pickup_id": 409223
},
"ship_to": {
"address": "18 Tam Trinh",
"subdistrict": 8980,
"contact_name": "Thịnh NV",
"country": "VN",
"district": 250,
"phone": "84032999292",
"province": 1,
"zipcode": ""
},
"shipments": {
"delivery_note": "",
"parcels": [
{
"items": [
{
"quantity": 1,
"sku": "TEST-0004"
},
{
"quantity": 1,
"sku": "TEST-0005"
}
]
}
]
},
"config": {
"insurance": "N",
"currency": "VND",
"unit_metric": "metric",
"sort_mode": "best_price",
"auto_approve": "Y",
"order_type": "b2c",
"include_distance_service": "Y"
},
"payment": {
"cod_amount": 24000
},
"referral": {
"order_number": "SO092921232"
},
"fulfillment_vas": {
"fulfill_now": "N",
"priority_fulfill": "N"
}
}'Responses
🟢200OK
application/json
Body
data
object
required
couriers
array [object {24}]
required
error
boolean
required
error_code
string
required
messages
string
required
request_id
string
required
Example
{
"data": {
"couriers": [
{
"total_fee": 0,
"cod_value": 24000,
"shipping_fee": 0,
"vas_fee": 0,
"fulfillment_fee": 0,
"tax": 0,
"duty": 0,
"is_distance_service": false,
"is_negotiable": false,
"sorting_hub": "BMPH_PDC_TEST_2",
"chargeable_weight": 22,
"min_delivery_time": 1,
"max_delivery_time": 0,
"currency": "VND",
"handover_options": "dropoff, pickup",
"handover_policy": "Free pickup",
"courier_name": "Boxme Express",
"courier_id": 52,
"courier_logo": "https://app.omisell.com/assets/customize/images/courier/Boxme_EXPRESS.svg",
"service_id": 57,
"service_code": "BM_DBS",
"service_name": "Self-Delivery",
"insurance_policy": "https://blog.boxme.asia/vi/dieu-khoan-su-dung/",
"dropoff_point": "https://boxme.asia/en/dropoff/"
}
]
},
"error": false,
"error_code": "",
"messages": "Calculate fee successfully",
"request_id": 1703485703,
"total": 0
}Modified at 2024-10-02 06:34:46