Apilo

Welcome to the Apilo Help Center.

[API] Creating a new shipment in Apilo

Connection with Shoper Connection with the Allegro account Connection with Erli.pl Connection to the eBay account Connection to the Amazon account Connection with OLX Connection to Empik Connection with Castorama Connection to Decathlon Connection with Black Red White Connection with Media Expert Connection with Aliexpress Connection with TikTok Shop List of inventory – accounting programs that you can connect to Apilo Connection to Hebe Connection to Morele Marketplace Connection to Ceneo.pl Connection to Kaufland DE / PL / CZ / SK / AT / FR / IT Connection to CDiscount Connection with Shopify Connection to Shopify – Authorization via Custom APP method Connection to Etsy.com Connection with InPost Fresh Connection with InPost Von Halsky Connection with IdoSell Connection with Prestashop Connection to WooCommerce Connection with ShopGold Connection to eMag Connection to RedCart Apilo Returns Connection to Gmail Connection with Labelcall Connection with Thunderbird Connection to Magento Connection with the Inpost courier Ship from Allegro, Allegro Smart, Allegro One Connection with DPD courier Connection with the GLS courier Connection with UPS courier Connection with DHL Poland courier Connection with FedEx Poland Connection with FedEx International Connection with courier Poczta Polska Connection to ShipCenter Connection to Amazon Easy Ship Connection with Orlen Paczka Connection with New Colors Connection with Eurohermes Connection to Paxy Connection with Global24 Connection with the courier Rohlig Suus Apilo Warehouse – based on an external inventory and accounting program of the ERP type Connection with the GEODIS (Pekaes) courier Connection with DPD courier (Germany) Connection with DHL (Germany) Connection with the Apaczka broker Connection with the Furgonetka.pl broker Connection to the Erli.pl broker Connection with the broker Olza Logistic Connection with the Meest Post broker Connection with the BliskaPaczka broker List of all couriers and brokers that you will connect to Apilo. Connection with wFirma.pl – invoices and receipts Connection to FakturaXL – invoices Connection with Fakturownia.pl – invoices and receipts Connection with inFakt Connection with Shoper Invoice and Warehouse Connection with iFirma.pl Connection to Subiekt GT – Sellintegro connector Connection with Subiekt GT/Nexo/Nexo Pro – integratory.pl connector Receipts – connecting a fiscal printer EAN barcodes – Barcode scanner Labels – Connecting the label printer and printing labels directly to the printer (PrintNode)

The process of creating a new shipment using Apilo is multi-step and requires prior account configuration.

Configuration:

– add courier integration accounts to your Apilo account using the form at

https://{{apilo_client_account}}.apilo.pl/admin/carrier-account/

Once the courier integration accounts are created, you can proceed to obtain the necessary information to create

a new shipment:

– courier account ID (added in the Configuration step above)

– shipping method (if different from default)

– shipping and packaging options (weight, dimensions)

How to obtain a courier account identifier? (context of creating a new shipment in Apilo)

 

This is used for the following endpoint:

GET https://{{apilo_client_account}}.apilo.pl/rest/api/shipping/carrier-account/map/

Returned response:

{r
"carrierAccounts": [r
{r
"id": 1,r
"key": "CARRIER_ACCOUNT_143_1",r
"name": "AllegroBroker",r
"description": "Sending from Allegro",r
"options": {r
"isPickupInShipmentCreation": false,r
"isPickupInShipmentConfirmation": true,r
"isShipmentConfirmationRequired": truer
}r
},r
r
{r
"id": 3,r
"key": "CARRIER_ACCOUNT_3_3",r
"name": "Inpost",r
"description": "Inpost (Courier, Parcel Machines, Allegro)",r
"options": {r
"isPickupInShipmentCreation": false,r
"isPickupInShipmentConfirmation": false,r
"isShipmentConfirmationRequired": falser
}r
},r
...r
]r
}

Returned identifiers (field: id) are used as arguments for the next endpoint.

However, it is worthwhile to analyze the obtained options:

isPickupInShipmentCreation – indicates whether the courier pickup at designated times can be declared already at the shipment creation stage

isPickupInShipmentConfirmation – indicates whether the courier pickup at designated times can be declared at the shipment confirmation stage

isShipmentConfirmationRequired – indicates whether shipment confirmation is required

The returned values for these options influence the ability to utilize the courier pickup request functionality and are tied to triggering further endpoints. At this time, you can only request a pickup through “Sending from Allegro”.

How to download shipping methods? (context of creating a new shipment in Apilo)

 

GET https://{{apilo_client_account}}.apilo.pl/rest/api/shipping/carrier-account/{{carrier_account_id}}/method/

where:

{{carrier_account_id}} - identifier obtained in the previous endpoint, e.g., 1 for Allegro.

This is not a constant value. The identifiers for courier integration accounts are assigned

individually for each Apilo customer and also depend on the order of their addition in the Configuration step above.

Returned response (snippet):

{r
"methods": [r
{r
"id": "12d2c05d-5807-4fbe-8471-1ad29a637bdc",r
"name": "Allegro Kurier Express One collection"r
},r
{r
"id": "02d2c05d-e7f3-494f-a597-1ad29a637bdc",r
"name": "Allegro Kurier Express One"r
},r
{r
"id": "0099dbaa-be2e-430d-8f94-ab9c86ea6a5e",r
"name": "Allegro Pickup at Express One Point"r
},r
{r
"id": "1099dbaa-5a98-4c2a-a7b4-ab9c86ea6a5e",r
"name": "Allegro Pickup at Express One Point collection"r
},r
{r
"id": "0a6f5534-8f51-4912-ac40-2be5bbc1bd4d",r
"name": "Allegro Express One Machine"r
},r
{r
"id": "1a6f5534-a3b3-4cc7-bc02-2be5bbc1bd4d",r
"name": "Allegro Express One Machine collection"r
},r
{r
"id": "025cb739-ef8e-45c4-9e7b-ce4e7fece8be",r
"name": "Allegro Pickup at ORLEN Paczka Point"r
},r
{r
"id": "09164667-daa5-42dc-8087-33d7485790ac",r
"name": "Allegro ORLEN Paczka Machine"r
},r
{r
"id": "0e4c7d59-64b6-4b06-89c3-c1d941506dd0",r
"name": "Allegro UPS Courier"r
},r
{r
"id": "199d2a2a-7c90-4ca7-aaf3-c1d941506dd0",r
"name": "Allegro UPS Courier collection"r
},r
{r
"id": "0d69a62b-7a66-4bd1-9134-49dea68dccc8",r
"name": "Allegro Pickup at UPS Point"r
},r
{r
"id": "0d021121-97e5-4729-9af6-a05779c6b835",r
"name": "Allegro Mini Shipment"r
},r
{r
"id": "aa1d05e0-943b-47cb-a759-9d8c16707129",r
"name": "Allegro Registered Shipment"r
},r
{r
"id": "093d950b-8497-4cc7-aa2a-6081e5e7e7e2",r
"name": "Allegro Pocztex Courier"r
},r
{r
"id": "028e2be0-1c06-41cf-a309-ec5557273786",r
"name": "Allegro Pickup at Pocztex Point"r
},r
{r
"id": "0fc30a71-a1c3-4572-8217-c29515a5f0d1",r
"name": "Allegro Pocztex Machine"r
},r
{r
"id": "0660145a-f92f-417d-a88b-effb8240eb45",r
"name": "Allegro Pickup at ORLEN Paczka Point (valid until 21.10.2024)"r
},r
{r
"id": "04c33651-bd96-484b-a89b-06a797d8eff4",r
"name": "Allegro ORLEN Paczka Machine (valid until 21.10.2024)"r
},r
{r
"id": "31a306e6be3e352f452421b42ad44e22",r
"name": "ORLEN Paczka (Orlen sandbox)"r
},r
{r
"id": "046452898438bde4c58502a5a4896dbf",r
"name": "ORLEN Paczka collection (Orlen sandbox)"r
},r
{r
"id": "fcd8b669172c42e370971d860edf496f",r
"name": "Courier InPost (Inpost sandbox) (COURIER)"r
},r
{r
"id": "f55a99ec6a31dce861fa4ab58d897c2d",r
"name": "Courier InPost collection (Inpost sandbox) (COURIER)"r
},r
{r
"id": "24f5c55531899af0c841b52b3bbc0a54",r
"name": "InPost Parcel Lockers (Inpost sandbox) (LOCKER)"r
},r
{r
"id": "e1137a63bb53d38d9ba610dc8f553e9e",r
"name": "InPost Parcel Lockers collection (Inpost sandbox) (LOCKER)"r
},r
{r
"id": "250dbb2f9996b8308540160d1a9e1886",r
"name": "Allegro Kurier24 InPost (Inpost sandbox) (COURIER)"r
},r
{r
"id": "6d5bbfcbe809007f4e546df77cbf5752r
",r
"name": "Allegro Kurier24 InPost collection (Inpost sandbox) (COURIER)"r
},r
{r
"id": "2533b181a0810f248181f8bf365d7fd2",r
"name": "Allegro miniKurier24 InPost (Inpost sandbox) (COURIER)"r
},r
{r
"id": "75f35102762de75d2a827113c9fa88b6",r
"name": "Allegro miniKurier24 InPost collection (Inpost sandbox) (COURIER)"r
},r
{r
"id": "ffc173ce598becbf1dc8943bf57d6870",r
"name": "Allegro Paczkomaty InPost (Inpost sandbox) (LOCKER)"r
},r
{r
"id": "358ca81df104d7f7ae28228b959f926f",r
"name": "Allegro Paczkomaty InPost collection (Inpost sandbox) (LOCKER)"r
},r
{r
"id": "c3066682-97a3-42fe-9eb5-3beeccab840c",r
"name": "Allegro Courier DPD"r
},r
{r
"id": "259b5c7a-9056-4c74-80ec-8bdc50cb0413",r
"name": "Allegro Courier DPD collection"r
},r
{r
"id": "08e2ef8e-90c8-49db-8970-d6c2773f1530",r
"name": "Allegro Pickup at DPD Pickup Point"r
},r
{r
"id": "1d037bcd-7e6a-4713-9015-d6c2773f1530",r
"name": "Allegro Pickup at DPD Pickup Point collection"r
},r
{r
"id": "0c330aea-900f-4830-9de8-72fadd2a3916r
",r
"name": "Allegro DHL BOX 24/7 Machine"r
},r
{r
"id": "a3b4db98-4a70-4542-84ee-c642604d9d8a",r
"name": "Allegro DHL Courier"r
},r
{r
"id": "07c12933-584e-453d-bee5-60f3f32dfc73",r
"name": "Allegro Pickup at DHL Point"r
},r
{r
"id": "0d83955a-4297-4169-adef-9790d53b11ff",r
"name": "Allegro One Courier - delivery tomorrow"r
},r
{r
"id": "1d83955a-69c8-407c-becc-9790d53b11ff",r
"name": "Allegro One Courier collection - delivery tomorrow"r
},r
{r
"id": "08c15d0b-9b24-4b3f-89a8-7a2b502abe55",r
"name": "Allegro One Point, UPS"r
},r
{r
"id": "0aafb43c-e66a-46ec-9cc4-29bb39ebb483",r
"name": "Allegro One Box, UPS"r
},r
{r
"id": "0b9bed2c-0bc1-4e1f-9694-29bb39ebb483",r
"name": "Allegro One Box, One Courier"r
},r
{r
"id": "0ee3467f-5451-4060-856e-7a2b502abe55",r
"name": "Allegro One Point, One Courier"r
},r
{r
"id": "0e454c54-21dd-4e5c-9db2-0553724f9077",r
"name": "Allegro One Box, One Courier - delivery today"r
},r
{r
"id": "0b257488-c85d-4507-b967-9b45ffbfa2e8",r
"name": "Allegro One Box, DPD"r
},r
{r
"id": "09ef5a54-c34d-41ef-908e-9b45ffbfa2e8",r
"name": "Allegro One Point, DPD"r
}r
]r
}

How to retrieve shipping and packaging options? (context of creating a new shipment in Apilo)

 

GET https://{{apilo_client_account}}.apilo.pl/rest/api/shipping/carrier-account/{{carrier_account_id}}/method/{{method}}/map/

where:

{{carrier_account_id}} – identifier of the courier integration account, e.g., 1 for Allegro from the examples above

{{method}} – method identifier, e.g., c3066682-97a3-42fe-9eb5-3beeccab840c for Allegro DPD Courier

Returned response:

{r
"options": {r
"id": "options",r
"type": "definition",r
"label": "Shipping options",r
"multiple": false,r
"properties": [r
{r
"id": "insurance",r
"type": "money",r
"label": "Insurance value"r
},r
{r
"id": "packageType",r
"type": "choice",r
"label": "Type of shipment",r
"choices": [r
{r
"value": "PACKAGE",r
"label": "Package"r
},r
{r
"value": "DOX",r
"label": "Envelope (DOX)"r
},r
{r
"value": "PALLET",r
"label": "Pallet"r
}r
],r
"multiple": falser
},r
{r
"id": "services",r
"type": "choice",r
"label": "Additional services",r
"choices": [r
{r
"value": "additionalHandling",r
"label": "Non-standard package"r
},r
{r
"value": "returnOfDocuments",r
"label": "Returns of documents"r
},r
{r
"value": "collectionUponDelivery",r
"label": "Return shipment"r
},r
{r
"value": "guarantee0930",r
"label": "Delivery by 09:30"r
},r
{r
"value": "guarantee1200",r
"label": "Delivery by 12:00"r
},r
{r
"value": "guaranteeNextDay",r
"label": "Next business day delivery"r
},r
{r
"value": "saturdayDelivery",r
"label": "Saturday delivery"r
},r
{r
"value": "privateShipping",r
"label": "Delivery to a private person"r
},r
{r
"value": "documentsSupply",r
"label": "Delivery of transport documents by courier"r
},r
{r
"value": "personalDelivery",r
"label": "Delivery by hand"r
}r
],r
"multiple": truer
},r
{r
"id": "dropoffPoint",r
"type": "string",r
"label": "Drop-off method"r
},r
{r
"id": "receiverParcel",r
"type": "string",r
"label": "Pick-up point"r
},r
{r
"id": "comment",r
"type": "string",r
"label": "Comment"r
}r
],r
"required": [r
"packageType"r
]r
},r
"parcels": {r
"id": "parcels",r
"type": "definition",r
"label": "Packaging options",r
"multiple": true,r
"properties": [r
{r
"id": "dimensions",r
"type": "dimensions",r
"label": "Dimensions"r
},r
{r
"id": "weight",r
"type": "integer",r
"label": "Weight [grams]"r
}r
],r
"required": [r
"dimensions",r
"weight"r
]r
},r
"maxParcelsCount": 1r
}

NOTE: The “multiple” key in the “options” and “parcels” objects (type: definition).

This means that at the next endpoint, i.e., the one used for sending the shipment, the Apilo REST API expects an object,

which contains 1 object for the “options” property and an array of objects for the “parcels” property. It will be best illustrated

by an example in the description of the next endpoint.

How to create a new shipment? (context for creating a new shipment in Apilo)

POST https://{{apilo_client_account}}.apilo.pl/rest/api/shipping/shipment/

The request body must include a JSON object that contains all required properties.

Optional parameters are validated for correctness but can be omitted.

{r
"carrierAccountId": 1,r
"addressReceiver": {r
"type": "house",r
"name": "Jan Kowalski",r
"streetName": "Kwiatowa",r
"streetNumber": "1",r
"zipCode": "01-001",r
"city": "Warszawa",r
"country": "PL",r
"phone": "48500600700",r
"email": "bb7ygt6xzx+5040fe591@user.allegrogroup.pl"r
},r
"orderId": "AL240800057",r
"postDate": "2024-09-06T13:41:18+00:00",r
"method": "c3066682-97a3-42fe-9eb5-3beeccab840c",r
"options": [r
{r
"id": "insurance",r
"type": "money",r
"value": {r
"amount": "2014.44",r
"currency": "PLN"r
}r
},r
{r
"id": "packageType",r
"type": "choice",r
"value": ["PACKAGE"]r
},r
{r
"id": "dropoffPoint",r
"type": "string",r
"value": "Allegro One Box, zielony automat||AL003KR1"r
},r
{r
"id": "comment",r
"type": "string",r
"label": "Handle with care, the package contains fragile items."r
}r
],r
"parcels": [r
{r
"options": [r
{r
"id": "dimensions",r
"type": "dimensions",r
"value": {r
"length": 50,r
"width": 60,r
"height": 70r
}r
},r
{r
"id": "weight",r
"type": "integer",r
"value": 2500r
}r
]r
}r
]r
}The ID of the newly created shipment will be returned in the response.{r
"shipments":[r
{r
"shipmentId": 169r
}r
]r
}

In what form should dimensions (dimensions) be sent in parcels during the package creation action? (context of creating a new shipment in Apilo)

The way to send dimensions depends on the integration.

A significant portion of integrations uses the following form:

{r
"id": "dimensions",r
"type": "dimensions",r
"value": {r
"length": 50,r
"width": 60,r
"height": 70r
}r
}

However, there are exceptions such as Allegro broker with Inpost Paczkomat shipping method:

{r
"id": "dimensions",r
"type": "choice",r
"choices": [r
{r
"value": "A",r
"label": "Size A - 64cm x 38cm x 8cm, 25kg"r
},r
{r
"value": "B",r
"label": "Size B - 64cm x 38cm x 19cm, 25kg"r
},r
{r
"value": "C",r
"label": "Size C - 64cm x 38cm x 41cm, 25kg"r
}r
]r
}

To ensure the required format by a given integration, use the following endpoint:

/rest/api/shipping/carrier-account/{carrierAccountId}/method/{method}/map/

Then, check if the parcels.properties[] field contains an object with id dimensions and what its type is.

If type = dimensions, we send a standard object with length, width, height.

If type = choice, then one of the listed values should be sent.

This guide has been translated using AI-powered tools.

Still need help?

Talk to a support agent