API Docs
Home
Home
Developer GuideAPI
StatusWebhooks
Developer GuideAPI
StatusWebhooks
  1. Order
  • Config
    • List Pickup Address
      GET
    • List Box Dimension
      GET
    • List vendor
      GET
    • List store
      GET
    • List category
      GET
    • List brand
      GET
    • List Outbound Strategy
      GET
    • List Product Type
      GET
    • List Material
      GET
    • List Storage Method
      GET
    • List Unit
      GET
    • Upload File
      POST
  • Online Product
    • Create Single Product
      POST
    • Create Product From Product Inventory
      POST
    • List product
      GET
    • Product detail
      GET
  • Product Inventory
    • Create single inventory product
      POST
    • List product inventory
      GET
    • Product inventory detail
      GET
    • Get Product Inventory in Warehouse
      GET
  • 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
    • [Retail][Ship by self] Create shipment with item
    • Cancel shipment
    • List shipment
    • Shipment detail
    • List shipment of order
  • Shipment Inbound
    • Create shipment inbound
    • Cancel shipment inbound
    • List shipment inbound
    • Shipment inbound detail
    • Shipment inbound items
    • List addtional services
  • 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. Order

List order

GET
/api/v1/public/orders/list

Request

Query Params

Header Params

Responses

🟢200OK
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/public/orders/list?page=1&page_size=5&created_from=1719203604&created_to=1719853199&status_group&type_filter&keyword' \
--header 'Authorization: {{your_api_key_here}}'
Response Response Example
{
    "status_code": 200,
    "data": {
        "orders": [
            {
                "id": 24252,
                "country": "VN",
                "currency": "VND",
                "platform": "retail",
                "group_platform": "retail",
                "source": "app",
                "sorting_code": null,
                "tracking_code": "NHOV1901550686",
                "partner_tracking_code": "NHOV1901550686",
                "partner_id": null,
                "partner_courier_tracking_code": null,
                "order_type": "b2c",
                "note": "Thương test",
                "packaging_note": "",
                "partner_priority_fulfillment": false,
                "partner_created_time": 1759199088.0,
                "status": 300,
                "status_update_time": 1759199088.0,
                "tax_paid_by": "sender",
                "fee_paid_by": "sender",
                "tax_info": {},
                "volume": "10x10x10",
                "protective_packaging": false,
                "inspection": false,
                "use_insurance": false,
                "can_check_content": true,
                "shipping_provider": "normal",
                "fulfill_type": 2,
                "time_fulfillment": 1759199388.0,
                "is_ship_now": false,
                "is_created_shipment": false,
                "confirmed_sla_time": 0.0,
                "sla_time": 0.0,
                "shipped_sla_time": 0.0,
                "fast_fulfill_sla_time": 0.0,
                "completed_time": 0.0,
                "estimated_departure_time": 0.0,
                "returned_time": 0.0,
                "created_time": 1759199088.0,
                "updated_time": 1759199088.0,
                "user": 190,
                "business": 276,
                "updated_by": 190,
                "created_by": 190,
                "pickup_address": 167,
                "store": {
                    "id": 336,
                    "name": "Hary Trần",
                    "logo": null,
                    "platform": "retail",
                    "is_active": true,
                    "currency": "VND",
                    "platform_logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/store.png"
                },
                "box_dimension": 120,
                "courier_integration": 268,
                "courier": 9,
                "courier_service": 55,
                "courier_ship": 12,
                "status_display": "Approved",
                "platform_logo": "https://nh-wms.sgp1.cdn.digitaloceanspaces.com/oms/store.png",
                "status_css": "purple",
                "validate_order_type": [
                    "courier_ship",
                    "pickup_address",
                    "receiver"
                ],
                "can_view_channel_order_detail": false,
                "can_approve": false,
                "items": [
                    36545
                ],
                "receiver": {
                    "fullname": "CN Tân Binnhf",
                    "email": "",
                    "phone": "+84961557476",
                    "address": "Số 9 Trà khúc",
                    "address2": null,
                    "zipcode": "",
                    "lat": null,
                    "lng": null,
                    "order": 24252,
                    "province": 89,
                    "district": 886,
                    "ward": 30337,
                    "customer": null
                },
                "total_qty_items": 1,
                "total_cod_amount": 100000.0,
                "cod_amount": 100000.0,
                "total_amount": 59000.0,
                "payment_status": 100,
                "payment_status_display": "Unpaid",
                "payment_status_css": "warning",
                "payment_detail": {
                    "total_payment": 100000.0,
                    "total_unpaid": 100000.0,
                    "total_paid": 0,
                    "total_debt": 0,
                    "total_refund": 0
                },
                "is_fulfill_now": false,
                "cutoff_order_type": "b2c_standard",
                "can_edit": true,
                "can_cancel": true,
                "can_create_shipment": true,
                "can_update_packed_to_marketplace": false
            },
            {
                "id": 24028,
                "country": "VN",
                "currency": "VND",
                "platform": "retail",
                "group_platform": "retail",
                "source": "app",
                "sorting_code": null,
                "tracking_code": "NHOV1901970476",
                "partner_tracking_code": "LC2609202668",
                "partner_id": null,
                "partner_courier_tracking_code": null,
                "order_type": 
Previous
Create order B2B
Next
Order detail
Built with