Orders
Valuation, creation and management of shipment orders.
Order valuation
Prices an order without creating it. Takes the same order payload
as Create order. Amounts in the returned
price_table are in grosze (1 PLN = 100 gr).
Order valuation › Request Body
app_idApplication ID issued in the Apaczka panel (API settings).
Payload shared by order valuation and order creation. For international shipments with customs clearance additional fields apply.
expiresUnix timestamp until which the request is valid. At most 15 minutes
in the future (the Postman collection uses now + 900 s).
signature^[0-9a-f]{64}$ · requiredLowercase-hex HMAC-SHA256 of
app_id + ":" + route + ":" + request + ":" + expires keyed with
your app_secret, where route is the method path including path
parameters and trailing slash (e.g. order_send/,
waybill/123456/).
Order valuation › Responses
Always HTTP 200 — check status in the body for the real outcome.
statusApplication-level status — 200 means success, anything else is an error code.
messageHuman-readable error message (empty on success).
Method-specific result. null on failure.
Create order
Creates a shipment order. For international shipments with customs clearance, extend the payload with customs data (see the Postman collection example 4b).
Create order › Request Body
app_idApplication ID issued in the Apaczka panel (API settings).
Payload shared by order valuation and order creation. For international shipments with customs clearance additional fields apply.
expiresUnix timestamp until which the request is valid. At most 15 minutes
in the future (the Postman collection uses now + 900 s).
signature^[0-9a-f]{64}$ · requiredLowercase-hex HMAC-SHA256 of
app_id + ":" + route + ":" + request + ":" + expires keyed with
your app_secret, where route is the method path including path
parameters and trailing slash (e.g. order_send/,
waybill/123456/).
Create order › Responses
Always HTTP 200 — check status in the body for the real outcome.
statusApplication-level status — 200 means success, anything else is an error code.
messageHuman-readable error message (empty on success).
Method-specific result. null on failure.
Orders list
Returns a paginated list of your orders.
Orders list › Request Body
app_idApplication ID issued in the Apaczka panel (API settings).
expiresUnix timestamp until which the request is valid. At most 15 minutes
in the future (the Postman collection uses now + 900 s).
signature^[0-9a-f]{64}$ · requiredLowercase-hex HMAC-SHA256 of
app_id + ":" + route + ":" + request + ":" + expires keyed with
your app_secret, where route is the method path including path
parameters and trailing slash (e.g. order_send/,
waybill/123456/).
Orders list › Responses
Always HTTP 200 — check status in the body for the real outcome.
statusApplication-level status — 200 means success, anything else is an error code.
messageHuman-readable error message (empty on success).
Method-specific result. null on failure.
Order details
Returns details of a single order. The signed route is
order/<order_id>/. Payload is an empty JSON object ({}).
path Parameters
order_idApaczka order ID (part of the signed route).
Order details › Request Body
app_idApplication ID issued in the Apaczka panel (API settings).
requestThis method takes no payload — send an empty JSON object ({}).
expiresUnix timestamp until which the request is valid. At most 15 minutes
in the future (the Postman collection uses now + 900 s).
signature^[0-9a-f]{64}$ · requiredLowercase-hex HMAC-SHA256 of
app_id + ":" + route + ":" + request + ":" + expires keyed with
your app_secret, where route is the method path including path
parameters and trailing slash (e.g. order_send/,
waybill/123456/).
Order details › Responses
Always HTTP 200 — check status in the body for the real outcome.
statusApplication-level status — 200 means success, anything else is an error code.
messageHuman-readable error message (empty on success).
Method-specific result. null on failure.
Cancel order
Cancels an order (where the shipment state still allows it).
Payload is an empty JSON object ({}).
path Parameters
order_idApaczka order ID (part of the signed route).
Cancel order › Request Body
app_idApplication ID issued in the Apaczka panel (API settings).
requestThis method takes no payload — send an empty JSON object ({}).
expiresUnix timestamp until which the request is valid. At most 15 minutes
in the future (the Postman collection uses now + 900 s).
signature^[0-9a-f]{64}$ · requiredLowercase-hex HMAC-SHA256 of
app_id + ":" + route + ":" + request + ":" + expires keyed with
your app_secret, where route is the method path including path
parameters and trailing slash (e.g. order_send/,
waybill/123456/).
Cancel order › Responses
Always HTTP 200 — check status in the body for the real outcome.
statusApplication-level status — 200 means success, anything else is an error code.
messageHuman-readable error message (empty on success).
Method-specific result. null on failure.