(Auth)

POST

/api/Batch/Find

Request

Authorization

Add parameter in header

X-BalikujAuthToken

Example:

X-BalikujAuthToken: ********************

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🟠403Forbidden

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/Batch/Find' \
--header 'X-BalikujAuthToken: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pageSize": 50,
    "start": 0,
    "length": 50,
    "carrierCodes": [
        "DPD",
        "PPL"
    ],
    "createdFrom": "2024-01-10",
    "createdTo": "2024-01-14",
    "sortField": "created",
    "sortOrder": "desc",
    "archived": false
}'

Response Example

200 - Example 1

{
    "correlationId": "d22127f9-6f76-4e1f-a15b-47ba32e899d0",
    "result": {
        "data": [
            {
                "id": 0,
                "carrierCode": "string",
                "ordersCount": 0,
                "packagesCount": 0,
                "errorsCount": 0,
                "labelsHash": "string",
                "ordersHash": "string",
                "labelsUrl": "string",
                "ordersUrl": "string",
                "created": "2019-08-24T14:15:22.123Z",
                "source": "Api",
                "note": "string",
                "isArchived": true,
                "archived": "2019-08-24T14:15:22.123Z",
                "orders": [
                    {
                        "orderId": 0,
                        "id": 0,
                        "carrierCode": "string",
                        "orderNumber": "string",
                        "orderDeliveryName": "string",
                        "orderDeliveryCompany": "string",
                        "packageNumberCarrier": "string",
                        "success": true,
                        "message": "string"
                    }
                ]
            }
        ],
        "total": 1
    }
}

Modified at 2025-05-31 13:14:57

(Auth)

Vrátí informace o dané dávce