API Docs
Home
Home
Developer GuideAPI
StatusWebhooks
Developer GuideAPI
StatusWebhooks
  1. Shipment
  • 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
      • List shipping service of courier
    • 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. Shipment

Shipment detail

Developing
GET
/api/v1/public/shipments/detail/{{tracking_code}}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/api/v1/public/shipments/detail/{{tracking_code}}' \
--header 'Authorization;'
Response Response Example
{
  "status_code": 200,
  "data": {
    "id": 9230,
    "country": "VN",
    "currency": "VND",
    "platform": "retail",
    "group_platform": "retail",
    "sorting_code": null,
    "tracking_code": "NHSVC1901327753",
    "partner_tracking_code": "NHOV1901325215",
    "note": "",
    "packaging_note": "",
    "status": 220,
    "status_update_time": 1746522002,
    "tax_paid_by": "sender",
    "fee_paid_by": "sender",
    "volume": "10x10x10",
    "protective_packaging": false,
    "inspection": false,
    "use_insurance": false,
    "can_check_content": true,
    "order_shipping_provider": "normal",
    "shipping_provider": "self",
    "fulfillment_provider": "nandh",
    "cod_amount": "0.00",
    "courier_tracking_code": "NHOV1901325215",
    "fulfill_type": 2,
    "warehouse_provider": "NH_WH_HCM",
    "is_ship_now": false,
    "priority_fulfillment_3pf": false,
    "partner_created_time": 1746520734,
    "partner_information": {},
    "label_code": "6819caa15efe8d6a39df4f6b",
    "estimated_departure_time": 0,
    "push_3pl_success": true,
    "push_3pf_success": true,
    "push_rts_success": false,
    "push_fulfill_pack_success": false,
    "additional_services": "",
    "is_seller_own_fleet": true,
    "label_url": null,
    "confirmed_sla_time": 0,
    "sla_time": 0,
    "shipped_sla_time": 0,
    "fulfilled_time": 1746521106,
    "shipped_time": 0,
    "delivered_time": 0,
    "returned_time": 0,
    "completed_time": 0,
    "inspection_time": 0,
    "received_time": 0,
    "created_time": 1746520735,
    "updated_time": 1746520735,
    "user": 190,
    "business": 276,
    "updated_by": 190,
    "created_by": 190,
    "pickup_address": {
      "id": 167,
      "pickup_name": "BTH",
      "contact_name": "SHOP TEST IT",
      "phone": "0961557476",
      "address": "Đường An Phú Đông 13, An Phú Đông, Quận 12, Thành phố Hồ Chí Minh",
      "pickup_code": "PK100167",
      "fulfillment_provider_name": "N&H Logistics",
      "warehouse_provider_name": "FC HCM",
      "is_fulfill_self": false,
      "is_fulfill_3pf": true
    },
    "store": {
      "id": 336,
      "name": "Hary Trần",
      "logo": null,
      "platform": "retail",
      "platform_logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/store.png"
    },
    "order": {
      "id": 16760,
      "platform": "retail",
      "group_platform": "retail",
      "tracking_code": "NHOV1901325215",
      "partner_tracking_code": "NHOV1901325215",
      "status": 460,
      "status_update_time": 1746522002,
      "created_time": 1746520734,
      "updated_time": 1746520734,
      "status_display": "Ready to ship",
      "platform_logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/store.png",
      "status_css": "info",
      "validate_order_type": [
        "courier_ship",
        "pickup_address",
        "receiver"
      ],
      "can_view_channel_order_detail": false,
      "can_approve": false
    },
    "courier_integration": 212,
    "courier": {
      "id": 16,
      "prefix": "sof",
      "name": "Tự Vận Chuyển",
      "description": "Hình thức người bán tự vận chuyển cho đơn hàng của mình. Tự quản lý quá trình vận chuyển và giao hàng đối với những đơn hàng mà người bán đã nhận.",
      "logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/delivery.png",
      "tracking_url": null,
      "rating": 4,
      "is_fulfill_now": false,
      "is_seller_own_fleet": true,
      "use_lib": null,
      "is_platform_own_fleet": false
    },
    "courier_service": {
      "name": "Tiêu Chuẩn",
      "estimate_time": "3-5",
      "is_fulfill_now": false
    },
    "courier_ship": {
      "id": 16,
      "prefix": "sof",
      "name": "Tự Vận Chuyển",
      "description": "Hình thức người bán tự vận chuyển cho đơn hàng của mình. Tự quản lý quá trình vận chuyển và giao hàng đối với những đơn hàng mà người bán đã nhận.",
      "logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/delivery.png",
      "tracking_url": null,
      "rating": 4,
      "is_fulfill_now": false,
      "is_seller_own_fleet": true,
      "use_lib": null,
      "is_platform_own_fleet": false
    },
    "status_display": "Ready to ship",
    "platform_logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/store.png",
    "status_css": "info",
    "label_link": "https://stg-oms.nandh.vn/api/v1/shipments/awb-label/6819caa15efe8d6a39df4f6b",
    "can_cancel": true,
    "can_update_document": false,
    "is_b2b": false,
    "can_confirm": false,
    "additional_services_info": [],
    "supported_actions": [],
    "is_marketplace": false,
    "is_marketplace_seller_own_fleet": false,
    "is_retail": true,
    "is_platform_shopping": false,
    "shipping_documents": [],
    "can_confirm_complaint_completed": false,
    "shipment_items": [
      18035
    ],
    "shipment_receiver": {
      "id": 8162,
      "country": "VN",
      "fullname": "Bùi Thị Hoài Thương",
      "email": "buithihoaithuong301@gmail.com",
      "phone": "+84961557476",
      "address": "Số 9 Trà khúc",
      "address2": null,
      "zipcode": null,
      "lat": null,
      "lng": null,
      "shipment": 9230,
      "province": {
        "id": 79,
        "country": "VN",
        "code": "HCM",
        "province_name": "TP. Hồ Chí Minh"
      },
      "district": {
        "id": 766,
        "country": "VN",
        "province_id": 79,
        "district_name": "Quận Tân Bình"
      },
      "ward": {
        "id": 26965,
        "province_id": 79,
        "district_id": 766,
        "country": "VN",
        "ward_name": "Phường 02"
      }
    },
    "total_fees": 0,
    "total_discounts": 0,
    "weight": 20,
    "actual_weight": 20,
    "is_fulfill_now": false,
    "ship_by": "Tự Vận Chuyển",
    "total_qty_items": 2,
    "total_sku": 1,
    "total_sale_price": 10000,
    "total_received_quantity": 0,
    "total_damaged_quantity": 0,
    "total_lost_quantity": 0,
    "total_images": 0
  },
  "error": false,
  "error_code": null,
  "log_id": null,
  "messages": "",
  "total": 1
}

Request

Header Params
Authorization
string 
required
Default:
{{your_api_key_here}}

Responses

🟢200OK
application/json
Body
status_code
integer 
optional
data
object 
optional
id
integer 
required
country
string 
required
currency
string 
required
platform
string 
required
group_platform
string 
required
sorting_code
null 
required
tracking_code
string 
required
partner_tracking_code
string 
required
note
string 
required
packaging_note
string 
required
status
integer 
required
status_update_time
integer 
required
tax_paid_by
string 
required
fee_paid_by
string 
required
volume
string 
required
protective_packaging
boolean 
required
inspection
boolean 
required
use_insurance
boolean 
required
can_check_content
boolean 
required
order_shipping_provider
string 
required
shipping_provider
string 
required
fulfillment_provider
string 
required
cod_amount
string 
required
courier_tracking_code
string 
required
fulfill_type
integer 
required
warehouse_provider
string 
required
is_ship_now
boolean 
required
priority_fulfillment_3pf
boolean 
required
partner_created_time
integer 
required
partner_information
object 
required
label_code
string 
required
estimated_departure_time
integer 
required
push_3pl_success
boolean 
required
push_3pf_success
boolean 
required
push_rts_success
boolean 
required
push_fulfill_pack_success
boolean 
required
additional_services
string 
required
is_seller_own_fleet
boolean 
required
label_url
null 
required
confirmed_sla_time
integer 
required
sla_time
integer 
required
shipped_sla_time
integer 
required
fulfilled_time
integer 
required
shipped_time
integer 
required
delivered_time
integer 
required
returned_time
integer 
required
completed_time
integer 
required
inspection_time
integer 
required
received_time
integer 
required
created_time
integer 
required
updated_time
integer 
required
user
integer 
required
business
integer 
required
updated_by
integer 
required
created_by
integer 
required
pickup_address
object 
required
store
object 
required
order
object 
required
courier_integration
integer 
required
courier
object 
required
courier_service
object 
required
courier_ship
object 
required
status_display
string 
required
platform_logo
string 
required
status_css
string 
required
label_link
string 
required
can_cancel
boolean 
required
can_update_document
boolean 
required
is_b2b
boolean 
required
can_confirm
boolean 
required
additional_services_info
array[string]
required
supported_actions
array[string]
required
is_marketplace
boolean 
required
is_marketplace_seller_own_fleet
boolean 
required
is_retail
boolean 
required
is_platform_shopping
boolean 
required
shipping_documents
array[string]
required
can_confirm_complaint_completed
boolean 
required
shipment_items
array[integer]
required
shipment_receiver
object 
required
total_fees
integer 
required
total_discounts
integer 
required
weight
integer 
required
actual_weight
integer 
required
is_fulfill_now
boolean 
required
ship_by
string 
required
total_qty_items
integer 
required
total_sku
integer 
required
total_sale_price
integer 
required
total_received_quantity
integer 
required
total_damaged_quantity
integer 
required
total_lost_quantity
integer 
required
total_images
integer 
required
error
boolean 
optional
error_code
string 
optional
log_id
string 
optional
messages
string 
optional
total
integer 
optional
Previous
List shipment
Next
List shipment of order
Built with