List shipping service

This API returns a list of available shipping services for a given order. It calculates estimated delivery times and total fees based on the shipping address, selected courier, parcel weight, and other details.

Example Returned Services
Chuyển phát đường bộ (Ground shipping)

Fee: 5,400 VND

Time: 3–5 days

Nội tỉnh nhanh (Intra-city express)

Fee: 22,000 VND

Time: 3–5 days

curl --location --request POST '/api/v1/public/orders/available-shipping-services' \ --header 'Authorization;' \ --header 'Content-Type: application/json' \ --data-raw '{ "store_id": {{store_id}}, "pickup_address_id": {{pickup_id}}, "box_id": {{box_id}}, "courier_id": 9, "courier_integration_id": 218, "weight": 150, "cod_amount": 100000, "receiver": { "address": "Số 9 trà khúc", "country": "VN", "district": 766, "fullname": "Hoài Thương", "phone": "0961557476", "province": 79, "ward": 26965, "zipcode": null }, "items": [ { "sku": "BANHTRANGXIKI", "sale_price": 79000, "discounted_price": 79000, "quantity": 2 } ], "config": { "preview": 1, "use_insurance": 0 } }'

{ "status_code": 200, "data": [ { "service_code": "NH_VNP_EC_FAST", "service_name": "Nhanh TMDT đồng giá", "service_type_name": "", "service_id": 26, "courier_id": 9, "courier_prefix": "nandh", "courier_integration_id": 218, "courier_ship_id": 10, "courier_ship_name": "Bưu điện (VNP)", "courier_ship_logo": "https://oms.boxme.asia/assets/images/courier/vnpost-ems.svg", "courier_ship_rating": 4, "distance": null, "priority": 0, "delivery_time_rank": 0, "fee_rank": 0, "only_fulfill": false, "require_tracking": false, "is_fulfill_now": false, "support_check_content": true, "support_use_insurance": true, "is_bridge": true, "is_seller_own_fleet": false, "min_estimate_time": 3, "max_estimate_time": 5, "estimate_time": "3-5 days", "fee_currency": "VND", "total_fee": 15000, "shipping_fee": { "shipping_fee": 15000, "handling_fee": 0, "heavy_weight_fee": 0, "stop_fee": 0, "remote_fee": 0, "vat_fee": 0, "line_haul_fee": 0 }, "vas_fee": { "vas_fee": 0, "insurance_fee": 0, "exchange_goods_fee": 0, "pricing_fee": 0, "cod_fee": 0 }, "fulfillment_fee": { "handover_fee": 0, "material_fee": 0, "bubble_wrap_fee": 0 }, "discount": { "courier_discount": 0 } }, { "service_code": "NH_VNP_EC_STT", "service_name": "Tiêu chuẩn TMDT đồng giá", "service_type_name": "", "service_id": 28, "courier_id": 9, "courier_prefix": "nandh", "courier_integration_id": 218, "courier_ship_id": 10, "courier_ship_name": "Bưu điện (VNP)", "courier_ship_logo": "https://oms.boxme.asia/assets/images/courier/vnpost-ems.svg", "courier_ship_rating": 4, "distance": null, "priority": 0, "delivery_time_rank": 0, "fee_rank": 0, "only_fulfill": false, "require_tracking": false, "is_fulfill_now": false, "support_check_content": true, "support_use_insurance": true, "is_bridge": true, "is_seller_own_fleet": false, "min_estimate_time": 3, "max_estimate_time": 5, "estimate_time": "3-5 days", "fee_currency": "VND", "total_fee": 16000, "shipping_fee": { "shipping_fee": 16000, "handling_fee": 0, "heavy_weight_fee": 0, "stop_fee": 0, "remote_fee": 0, "vat_fee": 0, "line_haul_fee": 0 }, "vas_fee": { "vas_fee": 0, "insurance_fee": 0, "exchange_goods_fee": 0, "pricing_fee": 0, "cod_fee": 0 }, "fulfillment_fee": { "handover_fee": 0, "material_fee": 0, "bubble_wrap_fee": 0 }, "discount": { "courier_discount": 0 } }, { "service_code": "NH_VTP_EC_PTN", "service_name": "Nội tỉnh nhanh", "service_type_name": "", "service_id": 32, "courier_id": 9, "courier_prefix": "nandh", "courier_integration_id": 218, "courier_ship_id": 1, "courier_ship_name": "Viettel Post", "courier_ship_logo": "https://storage.googleapis.com/omisell-cloud/logo/courier/viettelpost.svg", "courier_ship_rating": 4, "distance": null, "priority": 0, "delivery_time_rank": 0, "fee_rank": 0, "only_fulfill": false, "require_tracking": false, "is_fulfill_now": false, "support_check_content": true, "support_use_insurance": true, "is_bridge": true, "is_seller_own_fleet": false, "min_estimate_time": 3, "max_estimate_time": 5, "estimate_time": "3-5 days", "fee_currency": "VND", "total_fee": 22000, "shipping_fee": { "shipping_fee": 20370, "handling_fee": 0, "heavy_weight_fee": 0, "stop_fee": 0, "remote_fee": 0, "vat_fee": 1630, "line_haul_fee": 0 }, "vas_fee": { "vas_fee": 0, "insurance_fee": 0, "exchange_goods_fee": 0, "pricing_fee": 0, "cod_fee": 0 }, "fulfillment_fee": { "handover_fee": 0, "material_fee": 0, "bubble_wrap_fee": 0 }, "discount": { "courier_discount": 0 } } ], "error": false, "error_code": null, "log_id": null, "messages": "", "total": 3 }

Request

Header Params

Authorization

string

required

Default:

Body Params application/json

store_id

integer

required

ID of the seller’s store.

pickup_address_id

integer

required

Address ID from where the item is shipped.

box_id

integer

required

Box type or packaging ID.

courier_id

integer

required

Courier ID (e.g., Viettel Post).

weight

integer

required

Weight of the package in grams.

courier_integration_id

integer

required

Integration ID for the courier system.

cod_amount

integer

required

Cash on Delivery amount in VND.

receiver

object

required

Object containing recipient's address and contact info.

address

string

required

country

string

required

district

integer

required

fullname

string

required

phone

string

required

province

integer

required

ward

integer

required

zipcode

string | null

optional

items

array [object {4}]

required

List of items in the order.

sku

string

optional

sale_price

integer

optional

discounted_price

integer

optional

quantity

integer

optional

config

object

required

Additional configurations such as insurance or preview mode.

preview

integer

required

use_insurance

integer

required

Examples

Responses

🟢200OK

application/json

Body

status_code

integer

optional

data

array [object {31}]

optional

List of available shipping services.

service_code

string

optional

service_name

string

optional

Name of the shipping method.

service_type_name

string

optional

service_id

integer

optional

courier_id

integer

optional

courier_prefix

string

optional

courier_integration_id

integer

optional

courier_ship_id

integer

optional

courier_ship_name

string

optional

Courier name (e.g., Viettel Post).

courier_ship_logo

string

optional

URL to courier’s logo.

courier_ship_rating

integer

optional

distance

string

optional

priority

integer

optional

delivery_time_rank

integer

optional

fee_rank

integer

optional

only_fulfill

boolean

optional

require_tracking

boolean

optional

is_fulfill_now

boolean

optional

support_check_content

boolean

optional

support_use_insurance

boolean

optional

is_bridge

boolean

optional

is_seller_own_fleet

boolean

optional

min_estimate_time

integer

optional

max_estimate_time

integer

optional

estimate_time

string

optional

Estimated delivery duration.

fee_currency

string

optional

total_fee

integer

optional

Total shipping cost (in VND).

shipping_fee

object

optional

vas_fee

object

optional

fulfillment_fee

object

optional

The fulfillment_fee field is currently under development and not officially in use. It is included in the response for future compatibility but its values may not reflect actual or accurate charges at this time.

discount

object

optional

error

boolean

optional

error_code

string

optional

log_id

string

optional

messages

string

optional

total

integer

optional