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

List shipment of order

Developing
GET
/api/v1/public/shipments/list-shipment-of-order
This API retrieves the list of shipments associated with a specific order by its order_id.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/api/v1/public/shipments/list-shipment-of-order?order_id={{order_id}}' \
--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",
      "status": 220,
      "order_shipping_provider": "normal",
      "shipping_provider": "self",
      "fulfillment_provider": "nandh",
      "courier_tracking_code": "NHOV1901325215",
      "fulfill_type": 2,
      "warehouse_provider": "NH_WH_HCM",
      "is_ship_now": false,
      "priority_fulfillment_3pf": false,
      "cod_amount": "0.00",
      "created_time": 1746520735,
      "updated_time": 1746520735,
      "user": 190,
      "business": 276,
      "updated_by": 190,
      "created_by": 190,
      "pickup_address": 167,
      "store": 336,
      "order": 16760,
      "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
    }
  ],
  "error": false,
  "error_code": null,
  "log_id": null,
  "messages": "",
  "total": 1
}

Request

Query Params
order_id
string 
required
order_id (integer, required): The unique identifier of the order for which you want to get the related shipments.
Example:
{{order_id}}
Header Params
Authorization
string 
required
Default:
{{your_api_key_here}}

Responses

🟢200OK
application/json
Body
status_code
integer 
optional
data
array [object {47}] 
optional
id
integer 
optional
Unique ID of the shipment.
country
string 
optional
Country code (e.g., "VN").
currency
string 
optional
Currency code (e.g., "VND").
platform
string 
optional
Platform type (e.g., "retail").
group_platform
string 
optional
sorting_code
string 
optional
tracking_code
string 
optional
Internal tracking code.
partner_tracking_code
string 
optional
Courier-provided tracking code.
status
integer 
optional
Numeric status code of the shipment.
order_shipping_provider
string 
optional
Type of shipping provider ("normal" or others).
shipping_provider
string 
optional
Value like "self" indicates seller self-shipping.
fulfillment_provider
string 
optional
Fulfillment provider (e.g., "nandh").
courier_tracking_code
string 
optional
Courier's tracking code.
fulfill_type
integer 
optional
Fulfillment type (e.g., 2).
warehouse_provider
string 
optional
Identifier of the warehouse.
is_ship_now
boolean 
optional
Indicates immediate shipping.
priority_fulfillment_3pf
boolean 
optional
cod_amount
string 
optional
COD (Cash on Delivery) amount.
created_time
integer 
optional
Timestamps for creation and last update.
updated_time
integer 
optional
Timestamps for creation and last update.
user
integer 
optional
business
integer 
optional
updated_by
integer 
optional
created_by
integer 
optional
pickup_address
integer 
optional
store
integer 
optional
order
integer 
optional
courier_integration
integer 
optional
courier
object 
optional
courier_service
object 
optional
courier_ship
object 
optional
status_display
string 
optional
Human-readable shipment status (e.g., "Ready to ship").
platform_logo
string 
optional
status_css
string 
optional
label_link
string 
optional
can_cancel
boolean 
optional
can_update_document
boolean 
optional
is_b2b
boolean 
optional
can_confirm
boolean 
optional
additional_services_info
array[string]
optional
supported_actions
array[string]
optional
is_marketplace
boolean 
optional
is_marketplace_seller_own_fleet
boolean 
optional
is_retail
boolean 
optional
is_platform_shopping
boolean 
optional
shipping_documents
array[string]
optional
can_confirm_complaint_completed
boolean 
optional
error
boolean 
optional
error_code
string 
optional
log_id
string 
optional
messages
string 
optional
total
integer 
optional
Previous
Shipment detail
Next
Create shipment inbound
Built with