API Documentation

📘 中文版

API documentation:

1. Authenticate with the vendor-token request header; please contact your business manager.

2. Use the API domain; please contact your business manager.

POST batch lists - Batch List

URL: /api/order-batch/lists　·　Description: Query the batches submitted by the current vendor (paginated).

Note: Only the batches submitted by the vendor identified by the current vendor-token are returned, in reverse order of submission time.

Parameters

Parameter Required Type Description
page Optional int Page number, default 1
rows Optional int Page size, default 10

Request Example

GET /api/order-batch/lists?page=1&rows=10
Header: vendor-token: xxxxx

Response Example

{
    "success": true,
    "code": 200,
    "data": {
        "page": 1,
        "rows": 10,
        "count": 25,
        "lists": [
            {
                "id": 88,
                "batch_no": "B20260921153000ab12",
                "total_count": 2,
                "success_count": 1,
                "fail_count": 1,
                "status": 2,
                "status_text": "Completed"
            }
        ]
    }
}
data field Type Description
page / rows / count int Current page / page size / total count
lists array Batch list, in reverse order of submission time
lists[].batch_no string Batch number
lists[].total_count / success_count / fail_count int Total / processed-or-succeeded / failed counts
lists[].status int Batch status: 0 Pending　1 Processing　2 Completed　3 Failed
lists[].status_text string Batch status text (follows the request language)