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

Developing
GET
/api/v1/public/shipments/list
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/api/v1/public/shipments/list?page=1&page_size=10&created_from={{$date.timestamp|addMonths(-1)}}&created_to={{$date.timestamp}}&status_group=&type_filter&keyword' \
--header 'Authorization;'
Response Response Example
{
  "status_code": 200,
  "data": {
    "shipments": [
      {
        "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": {
          "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": 79,
          "district": 766,
          "ward": 26965
        },
        "is_fulfill_now": false,
        "ship_by": "Tự Vận Chuyển",
        "total_qty_items": 2,
        "total_sku": 1,
        "total_received_quantity": 0,
        "total_damaged_quantity": 0,
        "total_lost_quantity": 0,
        "total_images": 0
      },
      {
        "id": 9048,
        "country": "VN",
        "currency": "VND",
        "platform": "retail",
        "group_platform": "retail",
        "sorting_code": null,
        "tracking_code": "NHSVC1901099705",
        "partner_tracking_code": "50C01270",
        "note": "",
        "packaging_note": "",
        "status": 215,
        "status_update_time": 1745398678,
        "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": "CP1018566366",
        "fulfill_type": 2,
        "warehouse_provider": "NH_WH_HCM",
        "is_ship_now": false,
        "priority_fulfillment_3pf": false,
        "partner_created_time": 1745398382,
        "partner_information": {},
        "label_code": "6808ab95366813919fbcfcb9",
        "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": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/van_don_gui_hang_nhat_tin_logistics1_1745398671.pdf",
        "confirmed_sla_time": 0,
        "sla_time": 0,
        "shipped_sla_time": 0,
        "fulfilled_time": 0,
        "shipped_time": 0,
        "delivered_time": 0,
        "returned_time": 0,
        "completed_time": 0,
        "inspection_time": 0,
        "received_time": 0,
        "created_time": 1745398675,
        "updated_time": 1745398675,
        "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": 16558,
          "platform": "retail",
          "group_platform": "retail",
          "tracking_code": "NHOV1908861826",
          "partner_tracking_code": "50C01270",
          "status": 400,
          "status_update_time": 1745398674,
          "created_time": 1745398382,
          "updated_time": 1745398382,
          "status_display": "Created shipment",
          "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": 172,
        "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": 9,
          "prefix": "nandh",
          "name": "N&H Logistics",
          "description": "N&H Logistics là công ty cung cấp giải pháp Fulfillment tổng thể từ lưu kho, hoàn tất đơn hàng, vận chuyển đến quản lý hậu cần cho doanh nghiệp trên đa nền tảng.",
          "logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/AppIcon~ios-marketing.png",
          "tracking_url": null,
          "rating": 5,
          "is_fulfill_now": false,
          "is_seller_own_fleet": false,
          "use_lib": null,
          "is_platform_own_fleet": false
        },
        "status_display": "Waiting For Packaging",
        "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/6808ab95366813919fbcfcb9",
        "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": [
          17796
        ],
        "shipment_receiver": {
          "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": 9048,
          "province": 79,
          "district": 766,
          "ward": 26965
        },
        "is_fulfill_now": false,
        "ship_by": "N&H Logistics",
        "total_qty_items": 1,
        "total_sku": 1,
        "total_received_quantity": 0,
        "total_damaged_quantity": 0,
        "total_lost_quantity": 0,
        "total_images": 0
      },
      {
        "id": 9035,
        "country": "VN",
        "currency": "VND",
        "platform": "retail",
        "group_platform": "retail",
        "sorting_code": null,
        "tracking_code": "NHSVC1905324940",
        "partner_tracking_code": "CP1018565133",
        "note": "",
        "packaging_note": "",
        "status": 215,
        "status_update_time": 1745396607,
        "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": "CP1018565133",
        "fulfill_type": 2,
        "warehouse_provider": "NH_WH_HCM",
        "is_ship_now": false,
        "priority_fulfillment_3pf": false,
        "partner_created_time": 1745396572,
        "partner_information": {},
        "label_code": "6808a37fe171329bb0bcfcad",
        "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": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/sizze_a67_1745396593.pdf",
        "confirmed_sla_time": 0,
        "sla_time": 0,
        "shipped_sla_time": 0,
        "fulfilled_time": 0,
        "shipped_time": 0,
        "delivered_time": 0,
        "returned_time": 0,
        "completed_time": 0,
        "inspection_time": 0,
        "received_time": 0,
        "created_time": 1745396602,
        "updated_time": 1745396602,
        "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": 16547,
          "platform": "retail",
          "group_platform": "retail",
          "tracking_code": "NHOV1903649837",
          "partner_tracking_code": "CP1018565133",
          "status": 400,
          "status_update_time": 1745396601,
          "created_time": 1745396572,
          "updated_time": 1745396572,
          "status_display": "Created shipment",
          "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": 172,
        "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": 9,
          "prefix": "nandh",
          "name": "N&H Logistics",
          "description": "N&H Logistics là công ty cung cấp giải pháp Fulfillment tổng thể từ lưu kho, hoàn tất đơn hàng, vận chuyển đến quản lý hậu cần cho doanh nghiệp trên đa nền tảng.",
          "logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/AppIcon~ios-marketing.png",
          "tracking_url": null,
          "rating": 5,
          "is_fulfill_now": false,
          "is_seller_own_fleet": false,
          "use_lib": null,
          "is_platform_own_fleet": false
        },
        "status_display": "Waiting For Packaging",
        "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/6808a37fe171329bb0bcfcad",
        "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": [
          17773
        ],
        "shipment_receiver": {
          "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": 9035,
          "province": 79,
          "district": 766,
          "ward": 26965
        },
        "is_fulfill_now": false,
        "ship_by": "N&H Logistics",
        "total_qty_items": 1,
        "total_sku": 1,
        "total_received_quantity": 0,
        "total_damaged_quantity": 0,
        "total_lost_quantity": 0,
        "total_images": 0
      },
      {
        "id": 8901,
        "country": "VN",
        "currency": "VND",
        "platform": "haravan",
        "group_platform": "shopping",
        "sorting_code": null,
        "tracking_code": "NHSVC1901523476",
        "partner_tracking_code": "#10019",
        "note": "Vui lòng chỉ cho xem hàng không cho dùng thử hoặc khui sản phẩm",
        "packaging_note": null,
        "status": 102,
        "status_update_time": 1744345798,
        "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": "seller",
        "shipping_provider": "nandh",
        "fulfillment_provider": "nandh",
        "cod_amount": "300000.00",
        "courier_tracking_code": null,
        "fulfill_type": 2,
        "warehouse_provider": "NH_WH_HCM",
        "is_ship_now": false,
        "priority_fulfillment_3pf": false,
        "partner_created_time": 1744345284,
        "partner_information": {
          "shipping_carrier": {
            "pickup": "",
            "delivery": "",
            "drop-off": "",
            "service_code": null,
            "shipping_lines": [
              {
                "code": null,
                "price": 0,
                "title": null,
                "source": null
              }
            ]
          }
        },
        "label_code": null,
        "estimated_departure_time": 0,
        "push_3pl_success": false,
        "push_3pf_success": false,
        "push_rts_success": false,
        "push_fulfill_pack_success": false,
        "additional_services": "",
        "is_seller_own_fleet": false,
        "label_url": null,
        "confirmed_sla_time": 1744359684,
        "sla_time": 1744518084,
        "shipped_sla_time": 1744690884,
        "fulfilled_time": 0,
        "shipped_time": 0,
        "delivered_time": 0,
        "returned_time": 0,
        "completed_time": 0,
        "inspection_time": 0,
        "received_time": 0,
        "created_time": 1744345798,
        "updated_time": 1744950420,
        "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": 481,
          "name": "NH Logistics",
          "logo": null,
          "platform": "haravan",
          "platform_logo": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoharavan_1739504296.png"
        },
        "order": {
          "id": 16402,
          "platform": "haravan",
          "group_platform": "shopping",
          "tracking_code": "NHOV1901689836",
          "partner_tracking_code": "#10019",
          "status": 400,
          "status_update_time": 1744345797,
          "created_time": 1744345398,
          "updated_time": 1744345398,
          "status_display": "Created shipment",
          "platform_logo": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoharavan_1739504296.png",
          "status_css": "info",
          "validate_order_type": [
            "courier_ship",
            "pickup_address",
            "receiver"
          ],
          "can_view_channel_order_detail": true,
          "can_approve": false
        },
        "courier_integration": 197,
        "courier": {
          "id": 9,
          "prefix": "nandh",
          "name": "N&H Logistics",
          "description": "N&H Logistics là công ty cung cấp giải pháp Fulfillment tổng thể từ lưu kho, hoàn tất đơn hàng, vận chuyển đến quản lý hậu cần cho doanh nghiệp trên đa nền tảng.",
          "logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/AppIcon~ios-marketing.png",
          "tracking_url": null,
          "rating": 5,
          "is_fulfill_now": false,
          "is_seller_own_fleet": false,
          "use_lib": null,
          "is_platform_own_fleet": false
        },
        "courier_service": {
          "name": "Chuyển phát đường bộ",
          "estimate_time": "3-5",
          "is_fulfill_now": false
        },
        "courier_ship": {
          "id": 1,
          "prefix": "vtp",
          "name": "Viettel Post",
          "description": "TỔNG CÔNG TY CỔ PHẦN BƯU CHÍNH VIETTEL. Viettel Post là doanh nghiệp hàng đầu cung cấp dịch vụ chuyển phát nhanh hàng hoá, bưu kiện trong nước, quốc tế tại Việt ...",
          "logo": "https://storage.googleapis.com/omisell-cloud/logo/courier/viettelpost.svg",
          "tracking_url": null,
          "rating": 4,
          "is_fulfill_now": false,
          "is_seller_own_fleet": false,
          "use_lib": "nandh",
          "is_platform_own_fleet": false
        },
        "status_display": "Awaiting label",
        "platform_logo": "https://nhl.sgp1.cdn.digitaloceanspaces.com/ts/logoharavan_1739504296.png",
        "status_css": "warning",
        "label_link": null,
        "can_cancel": true,
        "can_update_document": false,
        "is_b2b": false,
        "can_confirm": true,
        "additional_services_info": [],
        "supported_actions": [],
        "is_marketplace": false,
        "is_marketplace_seller_own_fleet": false,
        "is_retail": false,
        "is_platform_shopping": true,
        "shipping_documents": [],
        "can_confirm_complaint_completed": false,
        "shipment_items": [
          17560
        ],
        "shipment_receiver": {
          "country": "VN",
          "fullname": "Trung Thu",
          "email": "",
          "phone": "0911233244",
          "address": "11 Nguyễn Ảnh thủ",
          "address2": null,
          "zipcode": null,
          "lat": null,
          "lng": null,
          "shipment": 8901,
          "province": 79,
          "district": 772,
          "ward": 27217
        },
        "is_fulfill_now": false,
        "ship_by": "Viettel Post",
        "total_qty_items": 1,
        "total_sku": 1,
        "total_received_quantity": 0,
        "total_damaged_quantity": 0,
        "total_lost_quantity": 0,
        "total_images": 0
      }
    ],
    "ward_list": [
      {
        "id": 26965,
        "ward_name": "Phường 02"
      },
      {
        "id": 27217,
        "ward_name": "Phường 11"
      }
    ],
    "district_list": [
      {
        "id": 772,
        "district_name": "Quận 11"
      },
      {
        "id": 766,
        "district_name": "Quận Tân Bình"
      }
    ],
    "province_list": [
      {
        "id": 79,
        "province_name": "TP. Hồ Chí Minh"
      }
    ]
  },
  "error": false,
  "error_code": null,
  "log_id": null,
  "messages": "",
  "total": 4
}

Request

Query Params
page
string 
required
Example:
1
page_size
string 
required
Example:
10
created_from
number 
required
Example:
{{$date.timestamp|addMonths(-1)}}
created_to
number 
required
Max 90 days
Example:
{{$date.timestamp}}
status_group
string  | null 
optional
new
problems
in_progress
delivering
completed
return
cancelled
Example:
new
type_filter
string  | null 
optional
order_number
tracking_code
courier_tracking_code
product_inventory_variant_sku
product_inventory_variant_nhsin
Example:
order_number
keyword
string  | null 
optional
Header Params
Authorization
string 
required
Default:
{{your_api_key_here}}

Responses

🟢200Success
application/json
Body
status_code
integer 
optional
data
object 
optional
shipments
array [object {88}] 
optional
ward_list
array [object {2}] 
optional
district_list
array [object {2}] 
optional
province_list
array [object {2}] 
optional
error
boolean 
optional
error_code
string 
optional
log_id
string 
optional
messages
string 
optional
total
integer 
optional
Previous
Cancel shipment
Next
Shipment detail
Built with