Skip to content

Reconciliation File Export

Brief Description
  • Use this API module to export merchant order reconciliation files.
  • The export process includes three steps: apply for an export task, query the export status, and get the download URL.
Workflow
Step API Description
1 /v1/vexora/orderExport/apply Create an export task for the selected time range
2 /v1/vexora/orderExport/status Query the task status until it becomes 2 (Generated)
3 /v1/vexora/orderExport/downloadUrl Get the temporary download URL for the generated file
General Rules
  • Method: POST
  • Content-Type: application/json
Name Required Type Description
merchantNo Y String Merchant number
Common Request Body Parameters
Name Required Type Description
timestamp Y Number Millisecond timestamp
sign Y String Request signature
Common Response Parameters
Name Required Type Description
msg Yes String Response message
code Yes String Business status code. 0000 means success
timestamp Yes Number Response timestamp in milliseconds
success Yes Boolean Whether the request succeeded
data No Object Business response data

Apply Export Task

Request URL
  • /v1/vexora/orderExport/apply
Request Body Parameters
Name Required Type Description
reportType Y String Report type. Currently only supports order
language N String Default: en-US. Supports: en / en-us / english, zh / zh-cn / chinese
startTime Y String Start time. Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss
endTime Y String End time. Format: yyyy-MM-dd or yyyy-MM-dd HH:mm:ss
timestamp Y Number Millisecond timestamp
sign Y String Request signature
Time Range Rules
  • startTime cannot be later than endTime
  • Only data within the last 3 months can be exported
  • Maximum export range is 7 days
  • Date-only values are automatically expanded:
    • startTime to 00:00:00
    • endTime to 23:59:59
Request Example
{
  "reportType": "order",
  "language": "en-US",
  "startTime": "2026-05-18 00:00:00",
  "endTime": "2026-05-19 23:59:59",
  "timestamp": 1779172654161,
  "sign": "7c08afed19c3b5b72e014b71b5a6249c"
}
Response Parameters
Name Required Type Description
data.id Yes String Export task ID
data.fileName Yes String Export file name (.xlsx)
data.status Yes String Task status code. Initial value: 0
Successful Response Example
{
  "msg": "success",
  "code": "0000",
  "timestamp": 1779161740505,
  "success": true,
  "data": {
    "id": "f1f06916c29509c77aaf59e23b423123",
    "fileName": "Merchant Order List-20260519113540-1701853483.xlsx",
    "status": "0"
  }
}

Query Export Status

Request URL
  • /v1/vexora/orderExport/status
Request Body Parameters
Name Required Type Description
id Y String Export task ID
timestamp Y Number Millisecond timestamp
sign Y String Request signature
Request Example
{
  "id": "77f3fe29b19aceab1bf817a7b21e9797",
  "timestamp": 1779173918792,
  "sign": "027c22dd4a6b4d103ca71e9d06de27ec"
}
Response Parameters
Name Required Type Description
data.id Yes String Export task ID
data.fileName Yes String Export file name
data.status Yes String Export status code
data.finishTime No String Export completion time
data.fileExpires No String File expiration time
data.msg Yes String Status description
Status Definitions
Status Description
0 Pending
1 Generating
2 Generated
3 Generation Failed
4 No Data
Successful Response Example
{
  "msg": "success",
  "code": "0000",
  "timestamp": 1779170178547,
  "success": true,
  "data": {
    "id": "18429abbb2e32cd4bd3012de491bd164",
    "fileName": "Merchant Order List-20260519135506-1701853483.xlsx",
    "status": "2",
    "finishTime": "2026-05-19 13:55:14",
    "fileExpires": "2026-05-26 13:55:14",
    "msg": "Generated"
  }
}

Get Download URL

Request URL
  • /v1/vexora/orderExport/downloadUrl
Request Body Parameters
Name Required Type Description
id Y String Export task ID
timestamp Y Number Millisecond timestamp
sign Y String Request signature
Preconditions
  • Task status must be 2 (Generated)
  • The exported file must not be expired
  • Expired files will return: The file has expired, please re-export it
Request Example
{
  "id": "77f3fe29b19aceab1bf817a7b21e9797",
  "timestamp": 1779173950267,
  "sign": "e4657d7facfffa2ce3738548ea79500f"
}
Response Parameters
Name Required Type Description
data.downloadUrl Yes String Temporary download URL
data.expire Yes Long Temporary download URL validity period, in milliseconds. For example, 600000 means 10 minutes
Successful Response Example
{
  "msg": "success",
  "code": "0000",
  "timestamp": 1779170179047,
  "success": true,
  "data": {
    "downloadUrl": "https://xxx.xxx.xxx/...",
    "expire": 600000
  }
}