Dispatch Order price calculation
- Former user (Deleted)
- Michał Machowski
Warning Debit clients!
Dispatch order price calculation is available only for prepaid clients. Prices are not returned for postpaid (debit) clients.
On this page
Structure
DispatchOrderPriceList resource has the following attributes:
Attribute | Type | Description |
|---|---|---|
| Integer | Amount of correctly processed shipments |
| Integer | Amount of incorrectly processed shipments |
| Hash | Total price for courier pick-up |
| Hash | Courier pick-up price list |
| Hash | Unprocessed shipment errors |
DispatchOrderPriceList resource in JSON format:
{
"total_success_count": 3,
"total_error_count": 1,
"total_price": {
"amount": 20.3,
"currency": "PLN"
},
"price_list": {
"courier": {
"count": 1,
"price": {
"amount": "12",
"currency": "PLN"
},
"shipments": [
24921
]
},
"locker": {
"count": 1,
"price": {
"amount": "4.30",
"currency": "PLN"
},
"shipments": [
24907
]
}
"allegro": {
"count": 1,
"price": {
"amount": "4.30",
"currency": "PLN"
},
"shipments": [
24908
]
}
},
"invalid_shipments": {
"24906": [
"already_dispatched"
]
}
}
Dispatch Order price calculation
POST /v1/organizations/:organization_id/dispatch_orders/calculateParameters
Parameter | Type | Description | Validation |
|---|---|---|---|
|
| Dispatch Point identifier, from which the shipment is to be collected from (the dispatch point address will become the dispatch order address). | Attribute not required. |
|
| List of shipment IDs for which the dispatch order is to be created for. | Required attribute.
|
Request example
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/dispatch_orders/calculate -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{
"dispatch_point_id": 10,
"shipments": [24907, 24908, 24906, 24918, 24921]
}'Response
Error Information
validation_failed- validation errorforbidden- user does not have access to the given organizationtoken_invalid- token is invalid