API Docs
Home
Home
Developer GuideAPI
StatusWebhooks
Developer GuideAPI
StatusWebhooks
  1. Shipping Service
  • Config
    • List Pickup Address
      GET
    • List Box Dimension
      GET
    • List vendor
      GET
    • List store
      GET
  • Online Product
    • Options
      • List category
      • List brand
    • Create Single Product
      POST
    • Create Product From Product Inventory
      POST
    • List product
      GET
    • Product detail
      GET
  • Product Inventory
    • Options
      • List Outbound Strategy
      • List Product Type
      • List Material
      • List Storage Method
    • List product inventory
      GET
    • Product inventory detail
      GET
    • Create single inventory product
      POST
  • Order
    • Shipping Service
      • Preview shipping prices
        • List shipping service
        • List available courier
      • List available courier from order
        POST
      • List shipping service of courier
        POST
    • Create order B2C
      POST
    • Create order B2B
      POST
    • List order
      GET
    • Order detail
      GET
    • Cancel order
      PATCH
  • Shipment
    • Create shipment auto
      POST
    • [Retail][Ship by self] Create shipment with item
      POST
    • Cancel shipment
      PATCH
    • List shipment
      GET
    • Shipment detail
      GET
    • List shipment of order
      GET
  • Shipment Inbound
    • Create shipment inbound
    • Cancel shipment inbound
    • List shipment inbound
    • Shipment inbound detail
    • Shipment inbound items
  • Order Return
    • List return order
    • Return order detail
    • Create return order
    • Cancel Return Order
  • Courier
    • List courier service integrated
    • List courier operate
    • List courier integrated
  • Address Directory
    • Province
    • District
    • Ward
  1. Shipping Service

List shipping service of courier

Developing
POST
/api/v1/public/orders/available-shipping-services
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/public/orders/available-shipping-services' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tracking_code": "NHOV1904705391",
  "pickup_address_id": 167,
  "box_id": 120,
  "courier_id": 16,
  "courier_integration_id": 172,
  "config": {
    "fulfill_now": 0
  }
}'
Response Response 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.0,
            "max_estimate_time": 5.0,
            "estimate_time": "3-5 days",
            "fee_currency": "VND",
            "total_fee": 5400.0,
            "shipping_fee": {
                "shipping_fee": 5000.0,
                "handling_fee": 0,
                "heavy_weight_fee": 0,
                "stop_fee": 0,
                "remote_fee": 0,
                "vat_fee": 400.0,
                "line_haul_fee": 0
            },
            "vas_fee": {
                "vas_fee": 0.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.0,
            "max_estimate_time": 5.0,
            "estimate_time": "3-5 days",
            "fee_currency": "VND",
            "total_fee": 22000.0,
            "shipping_fee": {
                "shipping_fee": 20370.0,
                "handling_fee": 0,
                "heavy_weight_fee": 0,
                "stop_fee": 0,
                "remote_fee": 0,
                "vat_fee": 1630.0,
                "line_haul_fee": 0
            },
            "vas_fee": {
                "vas_fee": 0.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
}

Request

Header Params
Authorization
string 
required
Default:
{{your_api_key_here}}
Body Params application/json
tracking_code
string 
required
pickup_address_id
integer 
required
box_id
integer 
required
courier_id
integer 
required
courier_integration_id
integer 
required
config
object 
required
fulfill_now
integer 
required
Examples

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 
required
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
Previous
List available courier from order
Next
Create order B2C
Built with