API Doc

# 5. Query order

# Brief Description

  • Check the order information according to the merchant order number

# HTTP Request Information

# Request URL

  • {domain}/open-api/order/query

# Request Method

  • POST

# Request Header

Parameter Name Required Type Description
Content-Type Yes string application/json

# Request Body Parameters

Parameter Name Required Type Length Limit Example Description
appId Yes string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 App id (provided by Swifood)
storeKey Yes string 100 CVIEIYUNHTS0 Store key (provided by Swifood)
param Yes string - - Request param content string
sign Yes string - RSA sign of param

# Param Parameters

Parameter Name Required Type Length Limit Example Description
paymentTransactionId Yes string 1 - 50 merchant order number,Online payment requires the MchOrderId of the platform

# Request body example

{
  "appId": "OpenTestAppId",
  "storeKey": "OpenTestStoreKey",
  "sign": "OpenTestSign",
  "param": "{\"paymentTransactionId\":\"TestOrderId\"}"
}

# Response Example

# Code Refer to this list

# Response Parameters

Parameter Name Type Example Description
code integer 10000 Status Code Refer to List
message string success Status Code Information
data Object - Response Param
- orderNo string - Order number
- pickUpNo string - Pick up code (Returned for takeout orders and queue orders)
{
  "code": 10000,
  "message": "success",
  "data": "{\"orderNo\":\"TB*******431\",\"pickUpNo\": \"001\", \"takeoutNo\":\"001\"}"
}

# Failed Response Example

{
    "code":21000,
    "message":"Service error, please contact administrator",
    "data":null
}

←