1. Delivery Orders
Gokoo Third-Party Integration API
  • En
    • Start Readme Channel API Guide
    • Authentication
      • Channel Partner Authorization Login
      • Get Channel Partner AccessToken
      • Get Merchant OpenID
    • Product Management - Categories
      • Create Category
      • Edit Category
      • Delete Category
      • Get Category Detail
      • List Categories (Management)
      • List All Categories (For Product List)
      • Sort Categories
    • Merchant Management
      • Set delivery time
      • Business hours-set by day
      • Business hours setting
      • Modify business status
      • Set appointment days
      • Business hours management
    • Product Management - Products
      • Create Product
      • Edit Product
      • Delete Product
      • Get Product Detail
      • List Products
      • Search Products
      • Upload Product Image
      • Set Product On/Off Shelf (Batch)
      • Batch Update Product Stock
      • Batch Sold Out (Clear Stock)
      • Sort Products
    • Delivery Orders
      • Accept Order
        POST
      • Cancel Order (Merchant Reject)
        POST
      • Mark Food Ready (Prepared)
        POST
      • Apply for Delivery / Merchant Start Self-Delivery
        POST
      • Merchant Self-Delivery Completed
        POST
      • Query Order by Pickup Code
        POST
      • Verify Pickup Order (Scan Code)
        POST
      • List Orders (By Status)
        POST
      • Get Order Detail
        POST
      • Get Order Financial Details
        POST
      • Reprint Receipt
        POST
      • Order financial details-for Thailand
        POST
      • Order financial details-for Malaysia
        POST
    • Webhooks
      • Order Status Change Callback
  • 中文
    • 接口说明 v1.0
    • 商品管理
      • 商品排序
      • 全部分类(商品列表用)
      • 添加分类
      • 分类管理列表
      • 删除分类
      • 商品图片上传
      • 商品上下架(含批量)
      • 分类详情
      • 添加商品
      • 商品列表(搜索)
      • 商品批量改库存
      • 删除商品
      • 商品详情
      • 修改商品
      • 商品批量沽清
      • 分类排序
      • 商品列表
      • 修改分类
    • 商户管理
      • 营业时间——按天设置
      • 设置配送时间
      • 营业时间设置
      • 修改营业状态
      • 营业时间管理
      • 设置预约天数
    • 账户部分
      • 渠道商授权获取AccessToken
      • 渠道商授权获取商户openid
      • 渠道商授权登录
    • 外卖订单
      • 重新打印小票
      • 订单状态变更回调
      • 扫码核销订单
      • 取消订单(商家拒单)
      • 自提码查询订单
      • 订单账目
      • 订单列表(各种状态的)
      • 订单详情
      • 订单财务明细-泰国
      • 订单财务明细-马来西亚
      • 沙箱-创建订单
      • 接单
      • 出餐
      • 申请配送_商家自己开始配送
      • 商家自配送完成
      • 沙箱-发送订单状态变更回调
  • Schemas
    • CommonBodyParams
    • CommonResponse
    • SuccessResponse
    • ErrorResponse
    • TimeSlot
    • TimeSlotWithSeconds
    • CategoryItem
    • ProductItem
    • NormSpec
    • NormGroup
    • OrderProduct
    • ShowButtons
    • StaffInfo
  1. Delivery Orders

List Orders (By Status)

POST
/api.php
order list
** Request parameter details: **
parameter namerequiredtypedescription
data.statusisintOrder status: 1 (pending order), 2 (pending delivery), 3 (delivery), 4 (urging order), 5(refund), 6(completed), 7 (canceled)
data.pagenointcurrent page
** Return parameter description **
parameter nametypedescription
data.items.order_idintOrder ID
data.items.shop_idintshop id
data.items.shop_titlestringStore title
data.items.pei_labelstringDelivery Type Label
data.items.day_numstringToday's odd number
data.items.member_ordersstringHow many times did you place an order
data.items.order_status_labelstringorder status
data.items.pei_time_labelstringDelivery time label
data.items.staff.namestringName of rider
data.items.staff.mobilestringRider phone
data.items.staff.latstringrider coordinates
data.items.staff.lngstringrider coordinates
data.items.products_numintTotal quantity of goods
data.items.products.product.product_namestringproduct name
data.items.products.product. product_numberintpurchase quantity
data.items.products.product. amountfloattotal amount
data.items.introstringcustomer reference
data.items.tableware_numstringNumber of tableware
data.items.amountstringTotal order revenue
data.items.show_btn.cancelintButton Display-Cancel
data.items.show_btn.jiedanintButton display-whether to receive orders
data.items.show_btn.setpeiintButton display-whether to ship
data.items.show_btn.setSpendintButton display-whether to self-submit write-off
data.items.show_btn.refuseintButton Display-Reject
data.items.show_btn.agreeintButton Display-Agree
data.items.show_btn.makeProductintButton display-ready to serve
data.items.show_btn.replyCommentintButton display-whether to respond to comments
data.items.show_btn.seeCommentintButton Display-Do you want to view comments
data.items.show_btn.replyCuiintButton display-whether to reply to reminder
data.items.show_btn.deliveredintButton display-whether delivery is completed
data.items.show_btn.service_agreeintButton display-agree to after-sales application
data.items.show_btn.service_refuseintButton Display-Reject After-sales Application
data.items.show_btn.apply_makeintButton Display-Request for Dining
data.items.show_btn.print_againintButton display-print receipt again
data.items.show_btn.user_imintButton display-user im chat button
data.count_obj.wait_jiedanintQuantity of orders waiting to receive
data.count_obj.wait_peiintNumber of orders waiting for delivery
data.count_obj.cuiintReminder order quantity
data.count_obj.refundintNumber of refund orders
data.count_obj.ingintNumber of orders in progress
data.count_obj.finishedintQuantity of completed orders
data.count_obj.cancelledintQuantity of cancelled orders
data.count_obj.serviceintNumber of refund orders
data.curr_pageintcurrent page
data.pagesinttotal number of pages
data.totalinttotal number of orders

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Query Params

Header Params

Body Params application/x-www-form-urlencodedRequired

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api.php?API=biz%2Fwaimai%2Fneworder%2Forder_list' \
--header 'Authorization: Bearer <token>' \
--data-urlencode 'CLIENT_API=' \
--data-urlencode 'CLIENT_API=BIZ' \
--data-urlencode 'openid=' \
--data-urlencode 'openid={{openid}}' \
--data-urlencode 'data={"status":"5","page":"1","lang":"null"}'

Responses

🟢200
application/json
Successful response
Bodyapplication/json

Example
{
    "data": {
        "items": [
            {
                "order_id": "string",
                "shop_id": "string",
                "shop_title": "string",
                "pei_label": "string",
                "day_num": "string",
                "member_orders": "string",
                "order_status_label": "string",
                "pei_time_label": "string",
                "contact": "string",
                "mobile": "string",
                "addr": "string",
                "house": "string",
                "amount": "string",
                "intro": "string",
                "tableware_num": "string",
                "products_num": "string",
                "staff": {
                    "staff_id": "string",
                    "name": "string",
                    "mobile": "string",
                    "lng": "string",
                    "lat": "string"
                },
                "products": [
                    {
                        "basket_title": "string",
                        "product": [
                            {
                                "product_id": "string",
                                "product_name": "string",
                                "product_price": "string",
                                "package_price": "string",
                                "product_number": "string",
                                "amount": "string",
                                "unit": "string",
                                "specification": [
                                    {}
                                ],
                                "product_photo": "string",
                                "shop_sku": "string",
                                "old_product_number": "string"
                            }
                        ]
                    }
                ],
                "yuji_info": [
                    {
                        "key": "string",
                        "val": "string"
                    }
                ],
                "yuji_price": "string",
                "show_btn": {
                    "cancel": "string",
                    "jiedan": "string",
                    "setpei": "string",
                    "setSpend": "string",
                    "refuse": "string",
                    "agree": "string",
                    "makeProduct": "string",
                    "replyComment": "string",
                    "seeComment": "string",
                    "replyCui": "string",
                    "delivered": "string",
                    "service_agree": "string",
                    "service_refuse": "string",
                    "apply_make": "string",
                    "print_again": "string",
                    "user_im": "string",
                    "lack_goods": "string"
                }
            }
        ],
        "total_count": "string",
        "curr_page": "string",
        "pages": "string",
        "total": "string",
        "count_obj": {
            "wait_jiedan": "string",
            "wait_pei": "string",
            "cui": "string",
            "refund": "string",
            "ing": "string",
            "finished": "string",
            "cancelled": "string",
            "service": "string"
        }
    },
    "error": "0",
    "message": "success"
}
Modified at 2026-04-21 02:34:56
Previous
Verify Pickup Order (Scan Code)
Next
Get Order Detail
Built with