Apaczka integration through the Web API
Shipment pricing across several couriers, point selection, a label and a batch handover document from your panel. Apaczka signs every request, so the integration is simple but demands precision.
From pricing to tracking
The order of Web API v2 calls in a typical shipment. Each step is a separate endpoint.
Service structure
service_structure/Which services, options and point types your account has.
In the storea courier list for checkout
In the storea courier list for checkoutPricing
order_valuation/The shipment cost for the chosen services.
In the storea delivery price at checkout
In the storea delivery price at checkoutOrder
order_send/The shipment with the parcel data and the point.
In the storean Apaczka order number
In the storean Apaczka order numberLabel
waybill/:order_id/The waybill for printing.
In the storea parcel label
In the storea parcel labelHandover and tracking
turn_in/tracking/:waybill_number/A batch handover document and the shipment statuses.
In the storea status on the order
In the storea status on the order
Signing every request
Apaczka uses no session tokens. Every request carries an HMAC signature and an expiry, and the signature is computed from the same data the body carries.
Four parts, one string
The app id, the endpoint name, the JSON data and the expiry, in that order. We build the JSON once, as re-serialising it after signing changes characters.
HMAC-SHA256 with the App Secret
We compute the signature with the App Secret key, which stays in the server settings and never reaches the browser.
At most 30 minutes
The expiry must be in the future and at most 30 minutes ahead. It counts from server time, so we keep the clock synced to the network.
A plugin or an API integration
On popular platforms a ready connection usually does. We write code for custom stores and systems.
You switch services on in the platform integration's settings.
The price comes from whatever the platform's ready integration offers.
When the price must be calculated live for each parcel, you need an API integration.
You order the shipment in the Apaczka panel.
You download the label and handover document in the Apaczka panel.
The documents live in the Apaczka panel, not on the order in your panel.
You check statuses in the Apaczka panel.
www.apaczka.pl/api/v2/POST service_structure/Services, options and whether a courier pickup is needed, straight from the account.
POST order_valuation/The price for the parcel built at checkout.
The price is calculated live from the weight and dimensions of the products in the cart.
POST order_send/The shipment with the parcel data and point, from your panel.
POST waybill/:order_id/The waybill while packing, and turn_in/ at the end of the day.
Labels and the handover document sit on the order in your panel.
POST tracking/:waybill_number/Tracking reaches the order and the client panel.
What flows between the store and Apaczka
The store sends shipment data; Apaczka returns prices, documents and statuses.
- Your storeThe delivery price at checkout←order_valuation/ApaczkaPricing of the services for this parcel
- Your storeThe point the customer picks←points/:typeApaczkaDispatch and pickup points of a given type
- Your storeA packed order→order_send/ApaczkaA shipment order
- Your storeThe label while packing←waybill/:order_id/ApaczkaThe waybill for printing
- Your storeThe handover document at the end of the day←turn_in/ApaczkaA batch handover confirmation as PDF
- Your storeThe status on the order←tracking/:waybill_number/ApaczkaShipment statuses, checked periodically
Services and pickup hours
We take the list of services, options and point types from your Apaczka account and the pickup hours from a separate endpoint, so checkout and the dispatch screen always show what you actually have.
Services from the account, not the code
service_structure/Service and option ids come from this endpoint at every sync, never hard-coded.
A courier possible or required
service_structure/The service structure says whether a courier pickup is possible or required. The dispatch screen depends on it.
Pickup hours
pickup_hours/The hours a courier can pick parcels up come from Apaczka, and the warehouse sees them when dispatching.
Common questions about Apaczka
Answers about delivery prices, labels, picking an aggregator and the quote.
Read next
Carriers and platforms we connect Apaczka with.
How do you price delivery today?
Tell us what your store runs on and which couriers you use. We will reply within an hour with questions and a quote.