OrderList

  • Purpose: Retrieve pending ticketing and recall order information within a specified time range.
  • Request: POST
  • Encryption: No
  • URL: /supplier/v2/api/order_list

Request

Name Type Required Description
apiKey string ✅ Each supplier has a unique apiKey to represent their identity. Provided by AeroHub to the supplier before interface testing.
requestId string ✅ Unique identifier for each call in the ticketing process. 32 characters in length.
beginDatetime string ✅ Start time for pulling the order list, in ISO 8601 format.
endDatetime string ✅ End time for pulling the order list, in ISO 8601 format.

Sample Request:

{
    "apiKey": "PcrNq8964iFUkE0CyVV4bhgXRH",
    "requestId": "3fd720b5bf544161bd14c535c9",
    "beginDatetime": "2023-01-11T09:17:17",
    "endDatetime": "2023-01-12T09:17:17"
}

Response

Name Type Required Description
code int ✅ AeroHub status code. Refer to Market Errors in the general documentation.
msg string ✅ AeroHub error description. Refer to Market Errors in the general documentation.
data array/Data Element ⬜️ Order list.

array/Data Element

Name Type Required Description
purchaseOrderNo string ✅ AeroHub’s order number, corresponding to Order interface’s OrderNo during the request.
supplierOrderNo string ✅ Supplier’s own system order number, corresponding to Order interface’s OrderNo during the response.

Success Response:

{
    "code": 200,
    "msg": "Successful",
    "data": [
    {
        "purchaseOrderNo": "F1745527321051406356",
        "supplierOrderNo": "240112032518897783",
    },
    {
        "purchaseOrderNo": "F1745527321051406357",
        "supplierOrderNo": "240112032518897784",
    }]
}

Error Response

{
    "code": 1000,
    "msg": "Invalid API Key"
}

Special

  • In cases where the code in the returned JSON data is not equal to 200 or the HTTP status code is not 200, suppliers should retry the call to ensure successful processing of the request.
Author：AeroHub  Create time：2024-03-15 15:13
Last editor：AeroHub  Update time：2025-07-29 17:21