### ADD Endpoint Examples Source: https://balikobotv2eng.docs.apiary.io/reference/b2a-return-shipments/b2a-one-by-allegro/example-of-the-b2a-method-one-by-allegro Examples for adding shipments with various carriers. ```APIDOC ## ADD Česká Pošta ### Description Adds a shipment with Česká Pošta. ### Method POST ### Endpoint /add/ceskaposta ## ADD DPD ### Description Adds a shipment with DPD. ### Method POST ### Endpoint /add/dpd ## ADD PPL + DHL Freight ### Description Adds a shipment with PPL + DHL Freight. ### Method POST ### Endpoint /add/ppldhlfreight ## ADD Zásilkovna ### Description Adds a shipment with Zásilkovna. ### Method POST ### Endpoint /add/zasilkovna ## ADD Geis Cargo ### Description Adds a shipment with Geis Cargo. ### Method POST ### Endpoint /add/geiscargo ## ADD WE DO ### Description Adds a shipment with WE DO. ### Method POST ### Endpoint /add/wedo ## ADD GLS ### Description Adds a shipment with GLS. ### Method POST ### Endpoint /add/gls ## ADD TOPTRANS ### Description Adds a shipment with TOPTRANS. ### Method POST ### Endpoint /add/toptrans ## ADD Pošta bez hranic ### Description Adds a shipment with Pošta bez hranic. ### Method POST ### Endpoint /add/postabezhranic ## ADD DHL Express ### Description Adds a shipment with DHL Express. ### Method POST ### Endpoint /add/dhlxpress ## ADD Slovenská pošta ### Description Adds a shipment with Slovenská pošta. ### Method POST ### Endpoint /add/slovenskáposta ## ADD UPS ### Description Adds a shipment with UPS. ### Method POST ### Endpoint /add/ups ## ADD TNT ### Description Adds a shipment with TNT. ### Method POST ### Endpoint /add/tnt ## ADD SPS - Slovak Parcel Service ### Description Adds a shipment with SPS - Slovak Parcel Service. ### Method POST ### Endpoint /add/sps ## ADD Gebrüder Weiss Slovensko ### Description Adds a shipment with Gebrüder Weiss Slovensko. ### Method POST ### Endpoint /add/gebrüderweiss_slovensko ## ADD Gebrüder Weiss Česká republika ### Description Adds a shipment with Gebrüder Weiss Česká republika. ### Method POST ### Endpoint /add/gebrüderweiss_českárepublika ## ADD Messenger ### Description Adds a shipment with Messenger. ### Method POST ### Endpoint /add/messenger ## ADD DHL DE ### Description Adds a shipment with DHL DE. ### Method POST ### Endpoint /add/dhlde ## ADD Fedex ### Description Adds a shipment with Fedex. ### Method POST ### Endpoint /add/fedex ## ADD FOFR ### Description Adds a shipment with FOFR. ### Method POST ### Endpoint /add/fofr ## ADD DACHSER ### Description Adds a shipment with DACHSER. ### Method POST ### Endpoint /add/dachser ## ADD DHL Parcel Europe - PPL Parcel Connect EU ### Description Adds a shipment with DHL Parcel Europe - PPL Parcel Connect EU. ### Method POST ### Endpoint /add/dhlparceleurope_pplparcelconnecteu ## ADD Raben ### Description Adds a shipment with Raben. ### Method POST ### Endpoint /add/raben ## ADD Spring ### Description Adds a shipment with Spring. ### Method POST ### Endpoint /add/spring ## ADD DSV ### Description Adds a shipment with DSV. ### Method POST ### Endpoint /add/dsv ## ADD DHL Freight Euroconnect ### Description Adds a shipment with DHL Freight Euroconnect. ### Method POST ### Endpoint /add/dhlfreighteuroconnect ## ADD DB SCHENKER ### Description Adds a shipment with DB SCHENKER. ### Method POST ### Endpoint /add/dbscheduler ## ADD Airway ### Description Adds a shipment with Airway. ### Method POST ### Endpoint /add/airway ## ADD JAPO Transport ### Description Adds a shipment with JAPO Transport. ### Method POST ### Endpoint /add/japotransport ## ADD Kurýr na přesný čas - former Liftago ### Description Adds a shipment with Kurýr na přesný čas - former Liftago. ### Method POST ### Endpoint /add/kurýrnapřesnýčas_formerliftago ## ADD Magyar posta ### Description Adds a shipment with Magyar posta. ### Method POST ### Endpoint /add/magyarposta ## ADD Sameday ### Description Adds a shipment with Sameday. ### Method POST ### Endpoint /add/sameday ## ADD SDS ### Description Adds a shipment with SDS. ### Method POST ### Endpoint /add/sds ## ADD Inpost ### Description Adds a shipment with Inpost. ### Method POST ### Endpoint /add/inpost ## ADD One By Allegro ### Description Adds a shipment with One By Allegro. ### Method POST ### Endpoint /add/onebyallegro ``` -------------------------------- ### B2C One By Allegro Method Example Source: https://balikobotv2eng.docs.apiary.io/reference/tracking/tracktestcases/example-of-the-tracktestcases-method Example for creating a B2C shipment with One By Allegro. Requires pickup address and optionally accepts a pickup date. ```json { "sen_street": "Street Name", "sen_city": "City Name", "sen_zip": "12345", "sen_country": "CZ", "pickup_date": "2023-12-25", "service_type": "B2C" } ``` -------------------------------- ### B2C Raben Method Example Source: https://balikobotv2eng.docs.apiary.io/reference/other-methods/pod-proof-of-delivery/example-of-pod-method Example for creating a B2C return shipment with Raben. Requires a pickup address and optionally accepts a planned pickup date. ```json { "return_full_errors": "1", "return_track": "1", "pickup_date": "2023-12-20", "sen_street": "Senovazne namesti", "sen_city": "Praha", "sen_zip": "11000", "sen_country": "CZ", "sen_firm": "Firma", "sen_name": "Jmeno", "sen_email": "email@example.com", "sen_phone": "123456789" } ``` -------------------------------- ### GET /CARRIER/transportcosts Source: https://balikobotv2eng.docs.apiary.io/introduction/authentication Retrieves the price of carriage at the consignment level. The input is the same as for the CHECK/ADD method. The final price is a guide and is returned from the destination carrier. ```APIDOC ## GET /CARRIER/transportcosts ### Description Method for obtaining the price of carriage at consignment level. The input is the same as for the CHECK / ADD method. It's not necessary to send attribute _return_full_errors_ (it is fixed to true) - in case of wrong data in the request, the response is in the same format as for the CHECK / ADD methods. The final price for the shipment is a guide - we return it from the destination carrier based on the data sent. Balikobot is not responsible for the returned shipment price. ### Endpoint https://apiv2.balikobot.cz/CARRIER/transportcosts ### Supported Carriers TopTrans, DHL Expres, TNT, FedEx ### Response Parameters - **eid** (string) - Order ID sent in the request. - **costs_total** (float) - Total cost of potential transport. - **currency** (string) - ISO code of the currency in which costs_total is returned. - **costs_breakdown** (object) - Breakdown of total price. - **pickup_date** (string) - The nearest possible handover / collection of the consignment at the sender. Available only for selected carriers (DHL Express). - **transit_days** (integer) - The number of days the consignment will be in transit. Available only for selected carriers (DHL Express). - **count_duties** (float) - Addition of the price of duty and tax. Available only for selected Carriers (DHL Express). ### Response Example { "eid": "12345", "costs_total": 150.50, "currency": "EUR", "costs_breakdown": { "base_cost": 120.00, "fuel_surcharge": 10.50 }, "pickup_date": "2023-10-27", "transit_days": 2, "count_duties": 20.00 } ``` -------------------------------- ### Example Package Creation Request Body Source: https://balikobotv2eng.docs.apiary.io/reference/b2c/b2c-toptrans/b2c-toptrans-example Use this JSON structure to create a new package. Ensure all required fields like 'eid', 'rec_name', and 'rec_phone' are populated correctly. The 'service_type' and 'mu_type_one' fields specify service and unit details. ```json { "packages": [ { "eid": 1234567, "rec_name": "Petr Stránský", "rec_phone": "+420775998665", "rec_email": "petr@gmail.com", "rec_street": "Oválová 16", "rec_city": "Praha", "rec_zip": "16000", "rec_country": "CZ", "rec_firm": "", "del_insurance": 100, "price": 100, "cod_price": 100, "cod_currency": "CZK", "service_type": 2, "weight": 15, "order_number": 1, "vs": 20157595, "real_order_id": "BB123445", "volume": "2.4", "pieces_count": 2, "mu_type_one": "PYTEL", "content_one": "Pytel s pyrotechnikou a acetylénem", "sen_name": "Balikobot Sender", "sen_city": "Benesov", "sen_street": "Jana Svermy 1709", "sen_zip": "25601", "sen_phone": "+420602123456" } ] } ``` -------------------------------- ### GET /CARRIER/transportcosts Source: https://balikobotv2eng.docs.apiary.io/introduction/difference-api-v2-vs-api-v1 Retrieves the price of carriage at the consignment level. The input is the same as for the CHECK/ADD method. The final price is a guide and is returned from the destination carrier based on the data sent. ```APIDOC ## GET /CARRIER/transportcosts ### Description Method for obtaining the price of carriage at consignment level. The input is the same as for the CHECK / ADD method. It's not necessary to send attribute _return_full_errors_ (it is fixed to true) - in case of wrong data in the request, the response is in the same format as for the CHECK / ADD methods. The final price for the shipment is a guide - we return it from the destination carrier based on the data sent. Balikobot is not responsible for the returned shipment price. ### Method GET ### Endpoint https://apiv2.balikobot.cz/CARRIER/transportcosts ### Parameters #### Query Parameters - **carrier_id** (string) - Required - Identifier for the carrier. - **package_details** (object) - Required - Details of the package for cost calculation. - **weight** (float) - Required - Weight of the package. - **dimensions** (object) - Required - Dimensions of the package. - **width** (float) - Required - Width of the package. - **height** (float) - Required - Height of the package. - **length** (float) - Required - Length of the package. - **from_address** (object) - Required - Sender's address details. - **to_address** (object) - Required - Recipient's address details. ### Response #### Success Response (200) - **eid** (string) - Order ID sent in the request. - **costs_total** (float) - Total cost of potential transport. - **currency** (string) - ISO code of the currency in which costs_total is returned. - **costs_breakdown** (array) - Breakdown of total price. - **pickup_date** (string) - The nearest possible handover / collection of the consignment at the sender. Available only for selected carriers (DHL Express). - **transit_days** (integer) - The number of days the consignment will be in transit. Available only for selected carriers (DHL Express). - **count_duties** (float) - Addition of the price of duty and tax. Available only for selected Carriers (DHL Express) ``` -------------------------------- ### B2C One By Allegro Method Example Source: https://balikobotv2eng.docs.apiary.io/reference/other-methods/pod-proof-of-delivery/example-of-pod-method Example for creating a B2C return shipment with One By Allegro. Requires a pickup address and optionally accepts a planned pickup date. ```json { "pickup_date": "2023-12-20", "sen_street": "Senovazne namesti", "sen_city": "Praha", "sen_zip": "11000", "sen_country": "CZ", "sen_firm": "Firma", "sen_name": "Jmeno", "sen_email": "email@example.com", "sen_phone": "123456789" } ``` -------------------------------- ### GET /CARRIER/transportcosts Source: https://balikobotv2eng.docs.apiary.io/reference/add/add-messenger/www.balikobot.cz/dokumentace/create-api Method for obtaining the price of carriage at consignment level. The input is the same as for the CHECK / ADD method. The final price for the shipment is a guide and is returned from the destination carrier based on the data sent. ```APIDOC ## GET /CARRIER/transportcosts ### Description Method for obtaining the price of carriage at consignment level. The input is the same as for the CHECK / ADD method. It's not necessary to send attribute _return_full_errors_ (it is fixed to true) - in case of wrong data in the request, the response is in the same format as for the CHECK / ADD methods. The final price for the shipment is a guide - we return it from the destination carrier based on the data sent. Balikobot is not responsible for the returned shipment price. ### Method GET ### Endpoint https://apiv2.balikobot.cz/CARRIER/transportcosts ### Parameters #### Query Parameters - **carrier_id** (string) - Required - Identifier for the carrier. - **destination_country** (string) - Required - ISO code of the destination country. - **weight** (float) - Required - Weight of the parcel in kilograms. - **dimensions** (object) - Required - Dimensions of the parcel (length, width, height). - **length** (float) - Required - Length of the parcel. - **width** (float) - Required - Width of the parcel. - **height** (float) - Required - Height of the parcel. ### Response #### Success Response (200) - **eid** (string) - Order ID sent in the request. - **costs_total** (float) - Total cost of potential transport. - **currency** (string) - ISO code of the currency in which costs_total is returned. - **costs_breakdown** (array) - Breakdown of total price. - **pickup_date** (string) - The nearest possible handover / collection of the consignment at the sender. Available only for selected carriers (DHL Express). - **transit_days** (integer) - The number of days the consignment will be in transit. Available only for selected carriers (DHL Express). - **count_duties** (float) - Addition of the price of duty and tax. Available only for selected Carriers (DHL Express). #### Response Example { "eid": "12345", "costs_total": 150.50, "currency": "EUR", "costs_breakdown": [ { "name": "Base Rate", "cost": 120.00 }, { "name": "Fuel Surcharge", "cost": 10.50 } ], "pickup_date": "2023-10-27", "transit_days": 3, "count_duties": 20.00 } ``` -------------------------------- ### B2C Endpoint Examples Source: https://balikobotv2eng.docs.apiary.io/reference/b2a-return-shipments/b2a-ppl-parcel/example-of-b2a-ppl-method Examples for Business-to-Consumer (B2C) services. ```APIDOC ## B2C Dachser ### Description Provides Business-to-Consumer services with Dachser. ### Method POST ### Endpoint /b2c/dachser ## B2C SPS ### Description Provides Business-to-Consumer services with SPS. ### Method POST ### Endpoint /b2c/sps ## B2C Toptrans ### Description Provides Business-to-Consumer services with Toptrans. ### Method POST ### Endpoint /b2c/toptrans ## B2C DPD ### Description Provides Business-to-Consumer services with DPD. ### Method POST ### Endpoint /b2c/dpd ## B2C Raben ### Description Provides Business-to-Consumer services with Raben. ### Method POST ### Endpoint /b2c/raben ## B2C GLS ### Description Provides Business-to-Consumer services with GLS. ### Method POST ### Endpoint /b2c/gls ## B2C One By Allegro ### Description Provides Business-to-Consumer services with One By Allegro. ### Method POST ### Endpoint /b2c/onebyallegro ``` -------------------------------- ### Helper Methods Source: https://balikobotv2eng.docs.apiary.io/reference/tracking/track-v2 Endpoints to retrieve lists of available services and other configuration options. ```APIDOC ## GET /SERVICES ### Description Retrieves a list of available services. ### Method GET ### Endpoint https://apiv2.balikobot.cz/SERVICES ## GET /ACTIVATEDSERVICES ### Description Retrieves a list of activated services for the account. ### Method GET ### Endpoint https://apiv2.balikobot.cz/ACTIVATEDSERVICES ## GET /MANIPULATIONUNITS ### Description Retrieves a list of available manipulation units. ### Method GET ### Endpoint https://apiv2.balikobot.cz/MANIPULATIONUNITS ## GET /ADDSERVICEOPTIONS ### Description Retrieves a list of available additional service options. ### Method GET ### Endpoint https://apiv2.balikobot.cz/ADDSERVICEOPTIONS ## GET /BRANCHES ### Description Retrieves a list of available branches (dispensing points). ### Method GET ### Endpoint https://apiv2.balikobot.cz/BRANCHES ``` -------------------------------- ### DROP Shipment - Example Source: https://balikobotv2eng.docs.apiary.io/reference/add/add-dhl-parcel-europe-ppl-parcel-connect-eu Example endpoint for dropping a shipment. ```APIDOC ## POST /api/v2/drop/example ### Description Example endpoint for dropping a shipment. ### Method POST ### Endpoint /api/v2/drop/example ### Parameters #### Request Body - **field1** (type) - Required/Optional - Description ``` -------------------------------- ### Balíkobot API v2 Overview Source: https://balikobotv2eng.docs.apiary.io/introduction/label-overview-table General introduction to the Balíkobot API v2, including authentication, version differences, and implementation guidelines. ```APIDOC ## Balíkobot API v2 Introduction ### Description The Balíkobot API v2 provides a unified interface for interacting with multiple shipping carriers. It supports shipment creation, tracking, and various logistics management tasks. ### Authentication Authentication is required for all API requests. Please refer to the implementation guide for specific header requirements. ### Key Features - Multi-carrier support (e.g., Česká Pošta, DPD, PPL, Zásilkovna, etc.) - Shipment tracking (TRACK, TRACK v2) - Branch and service management - Return shipment handling (B2A) and B2C services ``` -------------------------------- ### Testing and Production Environment Source: https://balikobotv2eng.docs.apiary.io/reference/add/add-sps-slovak-parcel-service Information regarding the use of test API keys, the pre-production setup, and the transition to the production environment. ```APIDOC ## Testing and Production Environment ### Description Balikobot provides a test API key and login for pre-production setup. During testing, all requests behave as in production, but data is not transferred to the carrier. The API responds with fake sample data to demonstrate expected structures. Settings for individual carriers are standardized across all test accounts. Changes made in the client zone (e.g., pickup addresses, sender names) are only reflected in the Production environment. ### Test Environment - **Test API Key**: Use the provided test key for pre-production setup. - **Behavior**: Mimics production behavior without actual data transfer. - **Response**: Fake sample data is returned. ### Production Environment - **Production API Key**: Replace the test key with the production key after successful testing. ### Multiple API Access Profiles Multiple API access profiles may be required in scenarios such as: - Contracts with carriers across different states. - Multiple shipping locations. - Multiple contracts or accounts with a single carrier. - Need for different label variations. ``` -------------------------------- ### API Response Body Example Source: https://balikobotv2eng.docs.apiary.io/reference/drop/drop-example/example-of-the-drop-method This is an example of a successful API response body, indicating a status of 200. ```json { "status": 200 } ``` -------------------------------- ### B2A - return shipments Endpoint Examples Source: https://balikobotv2eng.docs.apiary.io/reference/b2a-return-shipments/b2a-ppl-parcel/example-of-b2a-ppl-method Examples for handling return shipments using B2A services. ```APIDOC ## B2A PPL Parcel ### Description Handles return shipments using B2A PPL Parcel service. ### Method POST ### Endpoint /b2a/return/ppl ## B2A Geis Cargo ### Description Handles return shipments using B2A Geis Cargo service. ### Method POST ### Endpoint /b2a/return/geiscargo ## B2A DPD ### Description Handles return shipments using B2A DPD service. ### Method POST ### Endpoint /b2a/return/dpd ## B2A GLS ### Description Handles return shipments using B2A GLS service. ### Method POST ### Endpoint /b2a/return/gls ## B2A TopTrans ### Description Handles return shipments using B2A TopTrans service. ### Method POST ### Endpoint /b2a/return/toptrans ## B2A WE DO ### Description Handles return shipments using B2A WE DO service. ### Method POST ### Endpoint /b2a/return/wedo ## B2A Dachser ### Description Handles return shipments using B2A Dachser service. ### Method POST ### Endpoint /b2a/return/dachser ## B2A Raben ### Description Handles return shipments using B2A Raben service. ### Method POST ### Endpoint /b2a/return/raben ## B2A SPS ### Description Handles return shipments using B2A SPS service. ### Method POST ### Endpoint /b2a/return/sps ## B2A zasilkovna ### Description Handles return shipments using B2A zasilkovna service. ### Method POST ### Endpoint /b2a/return/zasilkovna ## B2A One By Allegro ### Description Handles return shipments using B2A One By Allegro service. ### Method POST ### Endpoint /b2a/return/onebyallegro ``` -------------------------------- ### Example Request Body for Package Creation Source: https://balikobotv2eng.docs.apiary.io/reference/add/add-spring/add-spring This JSON structure represents a package to be created. It includes recipient details, insurance options, service type, and order information. Ensure all required fields are populated for successful package creation. ```json { "packages": [ { "eid": "1234567", "rec_name": "Pan Testovací", "rec_phone": "+420775998665", "rec_email": "test@balikobot.cz", "rec_street": "Valdštejnova 57", "rec_city": "Praha", "rec_zip": "11000", "rec_country": "CZ", "rec_firm": "Balikobot.cz", "del_insurance": true, "price": 220, "ins_currency": "EUR", "service_type": "TRCK", "weight": 0.7, "order_number": 1, "vs": 20157595, "return_full_errors": "1", "real_order_id": "BB1234", "return_track": 1 } ] } ```