1. Webhooks
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
      • Cancel Order (Merchant Reject)
      • Mark Food Ready (Prepared)
      • Apply for Delivery / Merchant Start Self-Delivery
      • Merchant Self-Delivery Completed
      • Query Order by Pickup Code
      • Verify Pickup Order (Scan Code)
      • List Orders (By Status)
      • Get Order Detail
      • Get Order Financial Details
      • Reprint Receipt
      • Order financial details-for Thailand
      • Order financial details-for Malaysia
    • Webhooks
      • Order Status Change Callback
        POST
  • 中文
    • 接口说明 v1.0
    • 商品管理
      • 商品排序
      • 全部分类(商品列表用)
      • 添加分类
      • 分类管理列表
      • 删除分类
      • 商品图片上传
      • 商品上下架(含批量)
      • 分类详情
      • 添加商品
      • 商品列表(搜索)
      • 商品批量改库存
      • 删除商品
      • 商品详情
      • 修改商品
      • 商品批量沽清
      • 分类排序
      • 商品列表
      • 修改分类
    • 商户管理
      • 营业时间——按天设置
      • 设置配送时间
      • 营业时间设置
      • 修改营业状态
      • 营业时间管理
      • 设置预约天数
    • 账户部分
      • 渠道商授权获取AccessToken
      • 渠道商授权获取商户openid
      • 渠道商授权登录
    • 外卖订单
      • 重新打印小票
      • 订单状态变更回调
      • 扫码核销订单
      • 取消订单(商家拒单)
      • 自提码查询订单
      • 订单账目
      • 订单列表(各种状态的)
      • 订单详情
      • 订单财务明细-泰国
      • 订单财务明细-马来西亚
      • 沙箱-创建订单
      • 接单
      • 出餐
      • 申请配送_商家自己开始配送
      • 商家自配送完成
      • 沙箱-发送订单状态变更回调
  • Schemas
    • CommonBodyParams
    • CommonResponse
    • SuccessResponse
    • ErrorResponse
    • TimeSlot
    • TimeSlotWithSeconds
    • CategoryItem
    • ProductItem
    • NormSpec
    • NormGroup
    • OrderProduct
    • ShowButtons
    • StaffInfo
  1. Webhooks

Order Status Change Callback

POST
/{NOTIFY_URL}
Platform notification to channel partner when order status changes. The platform sends a POST request to the channel partner's configured NOTIFY_URL.

Signature Verification#

The signature is generated using HMAC-SHA1:
1.
Sort the data object keys alphabetically
2.
Concatenate key=value pairs with & (JSON-encode array values)
3.
Append &timestamp={time}&nonce_str={nonce_str}
4.
Sign with HMAC-SHA1 using APP_SECRET as the key
Order Status Table:
StatusDescription
WAIT_MERCHANT_CONFIRMPending merchant acceptance
WAIT_DRIVER_CONFIRMWaiting for rider acceptance
MERCHANT_CONFIRMEDMerchant accepted
DRIVER_CONFIRMEDRider accepted
DRIVER_ARRIVEDRider arrived at store
DRIVER_DELIVERINGRider delivering
DRIVER_DELIVEREDRider delivery completed
WAIT_COMMENTPending review
MERCHANT_DELIVERINGMerchant started delivery
MERCHANT_DELIVEREDMerchant delivered
ORDER_DONECompleted
ORDER_REFUNDEDRefunded
ORDER_CANCELCancelled
Parameter Encryption Method:
Signature generation rules:
$data_str = Sort the data array by key in ascending order and concatenate with &. If the value is an array, perform json_encode first;

Request

Path Params

Header Params

Body Params application/jsonRequired

Example
{
    "time": 1760143449,
    "nonce_str": "abc123random",
    "sign": "a1b2c3d4e5f6...",
    "data": {
        "openid": "merchant_openid_xxx",
        "type": "ORDER_STATUS_CHANGE",
        "data": {
            "order_id": "5208510",
            "status": "MERCHANT_CONFIRMED"
        },
        "label": "Merchant Confirmed"
    }
}

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 '/' \
--header 'Authorization: {{bearerToken}}' \
--header 'Content-Type: application/json' \
--data '{
    "time": 1760143449,
    "nonce_str": "abc123random",
    "sign": "a1b2c3d4e5f6...",
    "data": {
        "openid": "merchant_openid_xxx",
        "type": "ORDER_STATUS_CHANGE",
        "data": {
            "order_id": "5208510",
            "status": "MERCHANT_CONFIRMED"
        },
        "label": "Merchant Confirmed"
    }
}'

Responses

🟢200
Acknowledge receipt of callback
This response does not have a body.
Modified at 2026-04-14 04:06:42
Previous
Order financial details-for Malaysia
Next
接口说明 v1.0
Built with