- Overview
- Getting Started
- Common Errors
- API
- Config
- Product
- Product Inventory
- Order
- Shipment
- Shipment Inbound
- Courier
- Address Directory
- Status
- Webhooks
List shipping service
Developing
POST
/api/v1/public/orders/available-shipping-services
Last modified:2024-11-29 04:07:17
Request
Header Params
Authorization
string
optional
Default:
6pGkII/faXeTxkNR1wOXRKZniSG25HgtPoDr3dLcuAcegBUKinCDkkdpxeSULdtPE0I7P8nM7dWTPRUyhzgtvQ==
Body Params application/json
store_id
integer
required
pickup_address_id
integer
required
box_id
integer
required
courier_id
integer
required
weight
integer
required
courier_integration_id
integer
required
cod_amount
integer
required
receiver
object
required
address
string
required
country
string
required
district
integer
required
fullname
string
required
phone
string
required
province
integer
required
ward
integer
required
zipcode
null
required
items
array [object {4}]
required
sku
string
optional
sale_price
integer
optional
discounted_price
integer
optional
quantity
integer
optional
Example
{
"store_id": 34,
"pickup_address_id": 4,
"box_id": 2601,
"courier_id": 9,
"weight": 150,
"courier_integration_id": 187,
"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
}
}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://stg-oms.nandh.vn/api/v1/public/orders/available-shipping-services' \
--header 'Authorization: 6pGkII/faXeTxkNR1wOXRKZniSG25HgtPoDr3dLcuAcegBUKinCDkkdpxeSULdtPE0I7P8nM7dWTPRUyhzgtvQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
"store_id": 34,
"pickup_address_id": 4,
"box_id": 2601,
"courier_id": 9,
"weight": 150,
"courier_integration_id": 187,
"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
}
}'Responses
🟢200OK
application/json
Body
status_code
integer
required
data
array [object {31}]
required
service_code
string
required
service_name
string
required
service_type_name
string
required
service_id
integer
required
courier_id
integer
required
courier_prefix
string
required
courier_integration_id
integer
required
courier_ship_id
integer
required
courier_ship_name
string
required
courier_ship_logo
string
required
courier_ship_rating
integer
required
distance
null
optional
priority
integer
required
delivery_time_rank
integer
required
fee_rank
integer
required
only_fulfill
boolean
required
require_tracking
boolean
required
is_fulfill_now
boolean
required
support_check_content
boolean
required
support_use_insurance
boolean
required
is_bridge
boolean
required
is_seller_own_fleet
boolean
required
min_estimate_time
integer
required
max_estimate_time
integer
required
estimate_time
string
required
fee_currency
string
required
total_fee
integer
required
shipping_fee
object
required
vas_fee
object
required
fulfillment_fee
object
required
discount
object
required
error
boolean
required
error_code
null
optional
log_id
null
optional
messages
string
required
total
integer
required
Example
{
"status_code": 200,
"data": [
{
"service_code": "NH_VTP_EC_VCBO",
"service_name": "Chuyển phát đường bộ",
"service_type_name": "",
"service_id": 35,
"courier_id": 9,
"courier_prefix": "nandh",
"courier_integration_id": 187,
"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": false,
"support_use_insurance": false,
"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": 5400,
"shipping_fee": {
"shipping_fee": 5000,
"handling_fee": 0,
"heavy_weight_fee": 0,
"stop_fee": 0,
"remote_fee": 0,
"vat_fee": 400,
"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": 187,
"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": false,
"support_use_insurance": false,
"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": 2
}Modified at 2024-11-29 04:07:17