(Auth)
POST
/api/Package/Find
Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/Package/Find' \
--header 'X-BalikujAuthToken: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"pageSize": 50,
"start": 0,
"length": 50,
"search": "string",
"orderId": 0,
"carrierCodes": [
"string"
],
"cod": true,
"pickup": true,
"createdFrom": "string",
"createdTo": "string",
"packageNumberCustom": "string",
"packageNumberCarrier": "string",
"reference": "string",
"recepient": "string",
"status": "Printed",
"sortField": "string",
"sortOrder": "string",
"onlyMaster": false
}'Response Response Example
200 - Example 1
{
"correlationId": "d22127f9-6f76-4e1f-a15b-47ba32e899d0",
"result": {
"data": [
{
"id": 0,
"canCancel": true,
"canceled": false,
"carrierCode": "CP",
"carrierName": "Česká pošta, s. p.",
"codCurrency": "CZK",
"codPrice": 1000,
"created": "2024-01-15T08:48:27.83+01:00",
"delivered": false,
"deliveredDate": "2019-08-24T14:15:22.123Z",
"deliveringToday": true,
"editable": false,
"maskAddress": {
"id": 0,
"name": "Josef Novák",
"company": "Firma s.r.o.",
"street": "Ulice 555",
"city": "Zlín",
"zip": "76001",
"phone": "+420123456789",
"email": "email@info.cz",
"country": "CZ",
"countryName": "Česká republika",
"isEnabled": true,
"type": 1,
"additionalInfo": "Poslední byt v pravo.",
"taxNumber": "12345678",
"vatNumber": "CZ1234567890",
"taxId": "CZ1234567890",
"externalCode": "id-28462"
},
"maskAddressId": 0,
"orderId": null,
"packageNumberCarrier": "DR0007700387M",
"packageNumberCustom": "2024012345",
"packageNumberOrder": 1,
"packageStatusId": 0,
"pieceCount": 1,
"pieceIndex": 1,
"pickupId": 1274,
"deliveryType": "Home",
"price": 1000,
"printable": true,
"printed": true,
"recAddress": {
"id": 0,
"name": "Josef Novák",
"company": "Firma s.r.o.",
"street": "Ulice 555",
"city": "Zlín",
"zip": "76001",
"phone": "+420123456789",
"email": "email@info.cz",
"country": "CZ",
"countryName": "Česká republika",
"isEnabled": true,
"type": 1,
"additionalInfo": "Poslední byt v pravo.",
"taxNumber": "12345678",
"vatNumber": "CZ1234567890",
"taxId": "CZ1234567890",
"externalCode": "id-28462"
},
"recAddressId": 0,
"reference": "Eshop objednávka 0124515",
"senderAddress": {
"id": 0,
"name": "Josef Novák",
"company": "Firma s.r.o.",
"street": "Ulice 555",
"city": "Zlín",
"zip": "76001",
"phone": "+420123456789",
"email": "email@info.cz",
"country": "CZ",
"countryName": "Česká republika",
"isEnabled": true,
"type": 1,
"additionalInfo": "Poslední byt v pravo.",
"taxNumber": "12345678",
"vatNumber": "CZ1234567890",
"taxId": "CZ1234567890",
"externalCode": "id-28462"
},
"senderAddressId": 0,
"sent": true,
"serviceCode": "DR",
"serviceName": "Balík Do ruky",
"branchId": "string",
"branchName": "string",
"status": {
"code": "string",
"name": "string",
"category": "string"
},
"submittedCarrier": true,
"isMaster": true,
"masterId": 12354,
"inTransit": true,
"inTransitDate": "2019-08-24T14:15:22.123Z",
"isReturn": true,
"isReturnDate": "2019-08-24T14:15:22.123Z",
"trackable": true,
"trackingUrl": "string",
"updated": "2024-01-15T08:48:27.83+01:00",
"vs": "1234567890",
"readyForPickupDays": 0,
"readyForPickupDate": "2019-08-24T14:15:22.123Z",
"property1": "string",
"property2": "string"
}
],
"total": 1
}
}Modified at 2025-05-31 13:14:57