Dokumentacja WebApi
Informacje podstawowe
Definicja WebService’u dostępna jest pod adresem https://biznes.furgonetka.pl/api/soap/v2?wsdl.
Dla testów dostępna jest wersja https://biznes-test.furgonetka.pl/api/soap/v2?wsdl.
Kodowanie: UTF-8
Wersja SOAP: 1.2
Metody
AccountExistsResult accountExists (AccountExistsParams)
AddIntegrationSourceResult addIntegrationSource (AddIntegrationSourceParams)
Method adds data / configuration for specific integration.
AddPackageToTrackingResult addPackageToTracking (AddPackageToTrackingParams)
Metoda służy do dodawania przesyłki do listy śledzonych przesyłek klienta.
Przykład request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:addPackageToTracking> <data> <auth> <access_token>access_token</access_token> </auth> <package_no>662410138982300116942907</package_no> </data> </ns1:addPackageToTracking> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:addPackageToTrackingResponse> <addPackageToTrackingResult> <package_id>9544041</package_id> <service>dpd</service> <errors xsi:nil="true"/> </addPackageToTrackingResult> </ns1:addPackageToTrackingResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
CalculatePackageResult calculatePackage (CalculatePackage)
Metoda służy do wyceny przesyłki dla wszystkich przewoźników skonfigurowanych na koncie.
Przykład request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:calculatePackage> <data> <auth> <access_token>access_token</access_token> </auth> <sender> <name>Jan Kowalski</name> <email>jan@kowalski.pl</email> <company>Spinacz.pl</company> <street>Polna 1/2</street> <postcode>82-300</postcode> <city>Elbląg</city> <country_code>PL</country_code> <county xsi:nil="true"/> <phone>500123456</phone> <point xsi:nil="true"/> </sender> <receiver> <name>Adam Mickiewicz</name> <email>adam@mickiewicz.pl</email> <company>Furgonetka.pl</company> <street>Błotna 2/3</street> <postcode>80-300</postcode> <city>Gdańsk</city> <country_code>PL</country_code> <county xsi:nil="true"/> <phone>501214771</phone> <point xsi:nil="true"/> </receiver> <pickup xsi:nil="true"/> <type>package</type> <parcels> <item> <weight>2</weight> <width>10</width> <height>20</height> <depth>30</depth> <value xsi:nil="true"/> <gauge xsi:nil="true"/> <description>Opis</description> <customer_data xsi:nil="true"/> </item> </parcels> <services> <cod> <amount>100</amount> <iban>iban</iban> <name>Jan Kowalski</name> </cod> <rod>true</rod> <additional_handling xsi:nil="true"/> <ups_saver xsi:nil="true"/> <sending_at_point xsi:nil="true"/> <private_shipping xsi:nil="true"/> </services> <pickup_date xsi:nil="true"/> </data> </ns1:calculatePackage> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:calculatePackageResponse> <calculatePackageResult> <services_pricing> <item> <service>dpd</service> <pricing> <price>26.68</price> <price_net>21.69</price_net> <tax/> </pricing> </item> <item> <service>fedex</service> <pricing> <price>23.79</price> <price_net>19.34</price_net> <tax/> </pricing> </item> <item> <service>ups</service> <pricing> <price>39.32</price> <price_net>31.97</price_net> <tax/> </pricing> </item> </services_pricing> <errors xsi:nil="true"/> </calculatePackageResult> </ns1:calculatePackageResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
CancelPackageResult cancelPackage (CancelPackageParams)
Metoda umożliwia anulowanie przesyłek. Jeśli przesyłka jest jeszcze w koszyku to zostanie całkowicie usunięta. W przypadku GLS anulowanie przesyłki może wiązać się z dodatkowymi opłatami.
Przykład 1-request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:cancelPackage> <data> <auth> <access_token>access_token</access_token> </auth> <id>8394812</id> </data> </ns1:cancelPackage> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład 1-response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:cancelPackageResponse> <cancelPackageResult> <packages> <item> <id>8394812</id> <errors xsi:nil="true"/> </item> </packages> <errors xsi:nil="true"/> </cancelPackageResult> </ns1:cancelPackageResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład 2-request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:cancelPackage> <data> <auth> <access_token>access_token</access_token> </auth> <id>8394390</id> </data> </ns1:cancelPackage> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład 2-response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:cancelPackageResponse> <cancelPackageResult> <packages xsi:nil="true"/> <errors> <item> <field>error</field> <message>Prośba o anulowanie została odrzucona przez firmę UPS.</message> </item> </errors> </cancelPackageResult> </ns1:cancelPackageResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
CreateAccountResult createAccount (CreateAccountParams)
CreateIntegrationOAuthApplicationResult createIntegrationOAuthApplication (CreateIntegrationOAuthApplicationParams)
Metoda służy do zakładania aplikacji OAuth dla wybranych integracji.
Details createPackage (Package)
Metoda służy do tworzenia przesyłek oraz zlecenia ich odbioru.
Przykład dpd-request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:createPackage> <data> <auth> <access_token>access_token</access_token> </auth> <partner_reference_number>test/1517834669</partner_reference_number> <service_id>821</service_id> <sender> <name>Jan Kowalski</name> <email>jan@kowalski.pl</email> <company>Spinacz.pl</company> <street>Polna 1/2</street> <postcode>82-300</postcode> <city>Elbląg</city> <country_code>PL</country_code> <county xsi:nil="true"/> <phone>500123456</phone> <point xsi:nil="true"/> </sender> <receiver> <name>Adam Mickiewicz</name> <email>adam@mickiewicz.pl</email> <company>Furgonetka.pl</company> <street>Błotna 2/3</street> <postcode>80-300</postcode> <city>Gdańsk</city> <country_code>PL</country_code> <county xsi:nil="true"/> <phone>501214771</phone> <point xsi:nil="true"/> </receiver> <pickup xsi:nil="true"/> <user_reference_number xsi:nil="true"/> <type>package</type> <parcels> <item> <weight>2</weight> <width>10</width> <height>20</height> <depth>30</depth> <value xsi:nil="true"/> <gauge xsi:nil="true"/> <description>Opis</description> <customer_data xsi:nil="true"/> </item> </parcels> <services> <cod xsi:nil="true"/> <rod xsi:nil="true"/> <additional_handling xsi:nil="true"/> <ups_saver xsi:nil="true"/> <sending_at_point xsi:nil="true"/> <private_shipping xsi:nil="true"/> </services> <label> <file_format>PDF</file_format> <page_format>A4</page_format> </label> <regulations_accept>1502183405</regulations_accept> <pickup_date xsi:nil="true"/> </data> </ns1:createPackage> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład dpd-response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:createPackageResponse> <createPackageResult> <id>8394808</id> <partner_reference_number>test/1517834669</partner_reference_number> <documents> <label> <format>pdf</format> <content>obcietybase64===</content> </label> <protocol> <format>pdf</format> <content>obcietybase64===</content> </protocol> <cod> <format/> <content>obcietybase64===</content> </cod> <regulation> <format>pdf</format> <content>obcietybase64===</content> </regulation> </documents> <parcels> <item> <package_no>0000000273058Q</package_no> <state>sent</state> </item> </parcels> <pricing> <price>13.03</price> <price_net>10.59</price_net> <tax>23</tax> </pricing> <pickup_date> <date>2018-02-05</date> <min_time>14:00</min_time> <max_time>16:00</max_time> </pickup_date> <errors xsi:nil="true"/> </createPackageResult> </ns1:createPackageResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład dpd-services-request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:createPackage> <data> <auth> <access_token>access_token</access_token> </auth> <partner_reference_number>test/1517834854</partner_reference_number> <service_id>821</service_id> <sender> <name>Jan Kowalski</name> <email>jan@kowalski.pl</email> <company>Spinacz.pl</company> <street>Polna 1/2</street> <postcode>82-300</postcode> <city>Elbląg</city> <country_code>PL</country_code> <county xsi:nil="true"/> <phone>500123456</phone> <point xsi:nil="true"/> </sender> <receiver> <name>Adam Mickiewicz</name> <email>adam@mickiewicz.pl</email> <company>Furgonetka.pl</company> <street>Błotna 2/3</street> <postcode>80-300</postcode> <city>Gdańsk</city> <country_code>PL</country_code> <county xsi:nil="true"/> <phone>501214771</phone> <point xsi:nil="true"/> </receiver> <pickup xsi:nil="true"/> <user_reference_number xsi:nil="true"/> <type>package</type> <parcels> <item> <weight>2</weight> <width>10</width> <height>20</height> <depth>30</depth> <value xsi:nil="true"/> <gauge xsi:nil="true"/> <description>Opis</description> <customer_data xsi:nil="true"/> </item> </parcels> <services> <cod> <amount>100</amount> <iban>iban</iban> </cod> <rod xsi:nil="true"/> <additional_handling>true</additional_handling> <ups_saver xsi:nil="true"/> <sending_at_point xsi:nil="true"/> <private_shipping xsi:nil="true"/> </services> <label> <file_format>PDF</file_format> <page_format>A4</page_format> </label> <regulations_accept>1502183405</regulations_accept> <pickup_date xsi:nil="true"/> </data> </ns1:createPackage> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład dpd-services-response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:createPackageResponse> <createPackageResult> <id>8394810</id> <partner_reference_number>test/1517835930</partner_reference_number> <documents> <label> <format>pdf</format> <content>obcietybase64===</content> </label> <protocol> <format>pdf</format> <content>obcietybase64===</content> </protocol> <cod> <format/> <content>obcietybase64===</content> </cod> <regulation> <format>pdf</format> <content>obcietybase64===</content> </regulation> </documents> <parcels> <item> <package_no>0000000273068Q</package_no> <state>sent</state> </item> </parcels> <pricing> <price>30.68</price> <price_net>24.94</price_net> <tax>23</tax> </pricing> <pickup_date> <date>2018-02-05</date> <min_time>15:00</min_time> <max_time>17:00</max_time> </pickup_date> <errors xsi:nil="true"/> </createPackageResult> </ns1:createPackageResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład ups-bad-request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:createPackage> <data> <auth> <access_token>access_token</access_token> </auth> <partner_reference_number>test/1517836137</partner_reference_number> <service_id>856</service_id> <sender> <name>Jan Kowalski</name> <email>jan@kowalski.pl</email> <company>Spinacz.pl</company> <street>Polna 1/2</street> <postcode>82-300</postcode> <city>Elbląg</city> <country_code>PL</country_code> <county xsi:nil="true"/> <phone>500123456</phone> <point xsi:nil="true"/> </sender> <receiver> <name>Adam Mickiewicz</name> <email>adam@mickiewicz.pl</email> <company>Furgonetka.pl</company> <street>Błotna 2/3</street> <postcode>80-300</postcode> <city>Gdańsk</city> <country_code>PL</country_code> <county xsi:nil="true"/> <phone>501214771</phone> <point xsi:nil="true"/> </receiver> <pickup xsi:nil="true"/> <user_reference_number xsi:nil="true"/> <type>package</type> <parcels> <item> <weight>2</weight> <width xsi:nil="true"/> <height xsi:nil="true"/> <depth>30</depth> <value xsi:nil="true"/> <gauge xsi:nil="true"/> <description>Opis</description> <customer_data xsi:nil="true"/> </item> </parcels> <services> <cod xsi:nil="true"/> <rod xsi:nil="true"/> <additional_handling xsi:nil="true"/> <ups_saver xsi:nil="true"/> <sending_at_point xsi:nil="true"/> <private_shipping xsi:nil="true"/> </services> <label> <file_format>PDF</file_format> <page_format>A4</page_format> </label> <regulations_accept>0</regulations_accept> <pickup_date xsi:nil="true"/> </data> </ns1:createPackage> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład ups-bad-response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:createPackageResponse> <createPackageResult> <id xsi:nil="true"/> <partner_reference_number>test/1517836137</partner_reference_number> <documents xsi:nil="true"/> <parcels xsi:nil="true"/> <pricing xsi:nil="true"/> <pickup_date xsi:nil="true"/> <errors> <item> <field>regulations_accept</field> <message>Przed nadaniem przesyłki konieczna jest akceptacja regulaminu.</message> </item> <item> <field>width_1</field> <message>Pole nie może być puste</message> </item> <item> <field>height_1</field> <message>Pole nie może być puste</message> </item> <item> <field>dimensions_1</field> <message>Wpisz prawidłowe wymiary przesyłki.</message> </item> </errors> </createPackageResult> </ns1:createPackageResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
GetAvailablePickupHoursResult getAvailablePickupHours (GetAvailablePickupHoursParams)
Metoda umożliwia pobranie dostępnych terminów odbioru przesyłki przez przewoźnika. Dla UPS zawsze jest jeden zakres i oznacza on min_time - godzinę do której należy zamówić kuriera max_time - najpóźniejszy czas odbioru przesyłki.
Przykład request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:getAvailablePickupHours> <data> <auth> <access_token>access_token</access_token> </auth> <service_id>821</service_id> <ready_date>2018-02-06</ready_date> <sender> <postcode>82-300</postcode> <country_code>PL</country_code> </sender> <receiver> <postcode>80-300</postcode> <country_code>PL</country_code> </receiver> <services> <ups_saver xsi:nil="true"/> </services> </data> </ns1:getAvailablePickupHours> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:getAvailablePickupHoursResponse> <getAvailablePickupHoursResult> <pickup_date> <item> <date>2018-02-06</date> <min_time>10:00</min_time> <max_time>12:00</max_time> </item> <item> <date>2018-02-06</date> <min_time>12:00</min_time> <max_time>14:00</max_time> </item> <item> <date>2018-02-06</date> <min_time>14:00</min_time> <max_time>16:00</max_time> </item> <item> <date>2018-02-06</date> <min_time>15:00</min_time> <max_time>17:00</max_time> </item> <item> <date>2018-02-06</date> <min_time>16:00</min_time> <max_time>18:00</max_time> </item> </pickup_date> <errors xsi:nil="true"/> </getAvailablePickupHoursResult> </ns1:getAvailablePickupHoursResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
GetBalanceResult getBalance (GetBalanceParams)
Metoda umożliwia pobranie salda na koncie użytkownika.
Przykład request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:getBalance> <data> <auth> <access_token> access_token </access_token> </auth> </data> </ns1:getBalance> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:getBalanceResponse> <getBalanceResult> <balance>27.65</balance> <credit_limit>2000</credit_limit> <errors xsi:nil="true"/> </getBalanceResult> </ns1:getBalanceResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Details getPackageDetails (GetPackageDetailsParams)
Metoda umożliwia pobieranie szczegółów przesyłki. Odpowiedź zawiera Id przesyłki, dokumenty, wycenę, status przesyłki oraz przewidywaną datę podjazdu kuriera.
Przykład request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:getPackageDetails> <data> <auth> <access_token>access_token</access_token> </auth> <partner_reference_number>test/1517837565</partner_reference_number> </data> </ns1:getPackageDetails> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:getPackageDetailsResponse> <getPackageDetailsResult> <id>8394816</id> <partner_reference_number>test/1517837565</partner_reference_number> <documents> <label> <format>pdf</format> <content>obcietybase64===</content> </label> <protocol> <format>pdf</format> <content>obcietybase64===</content> </protocol> <cod> <format/> <content>obcietybase64===</content> </cod> <regulation> <format>pdf</format> <content>obcietybase64===</content> </regulation> </documents> <parcels> <item> <package_no>0000000273083Q</package_no> <state>sent</state> </item> </parcels> <pricing> <price>15.18</price> <price_net>12.34</price_net> <tax>23</tax> </pricing> <pickup_date> <date>2018-02-05</date> <min_time>15:00</min_time> <max_time>17:00</max_time> </pickup_date> <errors xsi:nil="true"/> </getPackageDetailsResult> </ns1:getPackageDetailsResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
GetPackageFormUrlResult getPackageFormUrl (GetPackageFormUrlParams)
Metoda służy do wygenerowania unikalnego adresu URL do formularza dodawania przesyłki
Przykład request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:getPackageFormUrl> <data> <auth> <access_token>access_token</access_token> </auth> <sender> <name>Jan Kowalski</name> <email>jan@kowalski.pl</email> <company xsi:nil="true"/> <street>Polna 1/2</street> <postcode>82-300</postcode> <city>Elbląg</city> <country_code>PL</country_code> <county xsi:nil="true"/> <phone>500123456</phone> <point xsi:nil="true"/> </sender> <receiver> <name>Adam Mickiewicz</name> <email>adam@mickiewicz.pl</email> <company xsi:nil="true"/> <street>Błotna 2/3</street> <postcode>80-300</postcode> <city>Gdańsk</city> <country_code>PL</country_code> <county xsi:nil="true"/> <phone>501214771</phone> <point xsi:nil="true"/> </receiver> <service>dpd</service> <type>package</type> <parcels> <item> <weight>10</weight> <width>20</width> <height>50</height> <depth>20</depth> <value>200</value> <gauge xsi:nil="true"/> <description>Opis</description> <customer_data xsi:nil="true"/> </item> </parcels> <services> <cod> <amount>100</amount> <iban>96109010307987071635139352</iban> <name>Jan Kowalski</name> <express xsi:nil="true"/> </cod> <rod xsi:nil="true"/> <guarantee_0930 xsi:nil="true"/> <guarantee_1200 xsi:nil="true"/> <saturday_delivery xsi:nil="true"/> <additional_handling xsi:nil="true"/> <ups_saver xsi:nil="true"/> <sending_at_point xsi:nil="true"/> <private_shipping xsi:nil="true"/> <sms_predelivery_information xsi:nil="true"/> <insurance xsi:nil="true"/> <fragile xsi:nil="true"/> <fedex_priority xsi:nil="true"/> <xpress_plus xsi:nil="true"/> </services> <pickup_date xsi:nil="true"/> <partner_reference_number>100000</partner_reference_number> <user_reference_number xsi:nil="true"/> <sale_source_id xsi:nil="true"/> </data> </ns1:getPackageFormUrl> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:getPackageFormUrlResponse> <getPackageFormUrlResult> <url> https://shop-test.furgonetka.pl/integrations/package_form/3224b063184330ff745b8075877ce5479088b4b46c969f7edc004288e2b61c6e </url> <errors xsi:nil="true"/> </getPackageFormUrlResult> </ns1:getPackageFormUrlResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
GetPackagesTrackingResult getPackagesTracking (GetPackagesTrackingParams)
Metoda służy do pobierania pełnego trackingu wielu przesyłek.
Używanie metody dozwolone jest jedynie dla własnych przesyłek. Metoda nie może być używana jako endpoint innego produktu np. strony/aplikacji ze śledzeniem przesyłek.
Przykład request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:getPackagesTracking> <data> <auth> <access_token>access_token</access_token> </auth> <packages> <item> <package_no>0000000339662Q</package_no> </item> <item> <package_no>523000019915001012381208</package_no> </item> </packages> </data> </ns1:getPackagesTracking> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:getPackagesTrackingResponse> <getPackagesTrackingResult> <packages> <item> <package_no>0000000339662Q</package_no> <tracking> <item> <state>ordered</state> <status>Zamówienie przesyłki na Furgonetka.pl</status> <datetime>2018-11-22 12:56:30</datetime> <branch>ELBLĄG</branch> </item> </tracking> </item> <item> <package_no>523000019915001012381208</package_no> <tracking> <item> <state>ordered</state> <status>Zamówienie przesyłki na Furgonetka.pl</status> <datetime>2019-04-16 11:03:40</datetime> <branch></branch> </item> <item> <state>ordered</state> <status>Przygotowana przez Nadawcę.</status> <datetime>2019-04-16 10:04:00</datetime> <branch></branch> </item> </tracking> </item> </packages> <errors xsi:nil="true"/> </getPackagesTrackingResult> </ns1:getPackagesTrackingResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
GetRegulationsResult getRegulations (GetRegulationsParams)
Metoda służy do pobierania regulaminów przewoźników. Dostarcza wersję regulaminu oraz adresy i tytuły dokumentów do akceptacji.
Przykład request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:getRegulations> <data> <auth> <access_token>access_token</access_token> </auth> </data> </ns1:getRegulations> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:getRegulationsResponse> <getRegulationsResult> <services> <item> <name>DPD</name> <version>1502183405</version> <datetime>2017-08-08 11:10:05</datetime> <service_type>dpd</service_type> <documents> <item> <name>Regulamin Świadczenia Usług W Obrocie Krajowym DPD Polska sp. z o.o.</name> <url>https://www.dpd.com.pl/var/storage/original/application/787a78f706f5c18970b8f181b6bf294b.pdf</url> </item> <item> <name>Regulamin Świadczenia Usług W Obrocie Międzynarodowym DPD Polska sp. z o.o.</name> <url>https://www.dpd.com.pl/var/storage/original/application/87a4123745b953329ea52a2e77ab1d20.pdf</url> </item> </documents> </item> <item> <name>UPS</name> <version>1502183540</version> <datetime>2017-08-08 11:12:20</datetime> <service_type>ups</service_type> <documents> <item> <name>UPS</name> <url>http://www.ups.com/content/pl/pl/resources/ship/terms/service.html</url> </item> <item> <name>Politykę Prywatności UPS</name> <url>http://www.ups.com/content/pl/pl/resources/ship/terms/privacy.html</url> </item> </documents> </item> <item> <name>GEIS</name> <version>1483315200</version> <datetime>2017-01-02 01:00:00</datetime> <service_type>kex</service_type> <documents> <item> <name>GEIS</name> <url>https://www.geis.pl/data/images/_orig/8/818.pdf</url> </item> </documents> </item> <item> <name>GLS</name> <version>1393632000</version> <datetime>2014-03-01 01:00:00</datetime> <service_type>gls</service_type> <documents> <item> <name>GLS</name> <url>https://gls-group.eu/PL/pl/regulamin</url> </item> </documents> </item> <item> <name>X-press</name> <version>1383264000</version> <datetime>2013-11-01 01:00:00</datetime> <service_type>xpress</service_type> <documents> <item> <name>X-Press Couriers</name> <url>http://www.x-press.com.pl/content/pliki/364/regulaminswiadczeniauslug2013.pdf</url> </item> </documents> </item> <item> <name>InPost</name> <version>1476230400</version> <datetime>2016-10-12 02:00:00</datetime> <service_type>inpost</service_type> <documents> <item> <name>Paczkomaty Inpost</name> <url>http://www.paczkomaty.pl/pl/cenniki-i-regulaminy</url> </item> </documents> </item> <item> <name>InPost Kurier</name> <version>1483228800</version> <datetime>2017-01-01 01:00:00</datetime> <service_type>inpostkurier</service_type> <documents> <item> <name>InPost Express Sp. z o.o.</name> <url>https://inpost.pl/pl/pomoc/cenniki-i-regulaminy/regulaminy</url> </item> </documents> </item> <item> <name>FedEx</name> <version>1443225600</version> <datetime>2015-09-26 02:00:00</datetime> <service_type>fedex</service_type> <documents> <item> <name>FedEx</name> <url>http://www.fedex.com/pl/services/terms/</url> </item> </documents> </item> <item> <name>Paczka w RUCHu</name> <version>1484697600</version> <datetime>2017-01-18 01:00:00</datetime> <service_type>ruch</service_type> <documents> <item> <name>Paczka w RUCHu</name> <url>https://www.paczkawruchu.pl/files/Regulamin.pdf</url> </item> </documents> </item> <item> <name>Poczta Polska</name> <version>1483315200</version> <datetime>2017-01-02 01:00:00</datetime> <service_type>poczta</service_type> <documents> <item> <name>Poczty Polskiej</name> <url>http://www.poczta-polska.pl/hermes/uploads/2012/08/OWU-przesylek-nadawanych-przez-Klienta-Biznesowego.pdf</url> </item> <item> <name>OWU Poczty Polskiej</name> <url>http://www.pocztex.pl/jowisz/uploads/2014/10/REGULAMIN-POCZTEX_20140916.zip</url> </item> </documents> </item> <item> <name>ETL</name> <version>1435708800</version> <datetime>2015-07-01 02:00:00</datetime> <service_type>etl</service_type> <documents> <item> <name>ETL</name> <url>http://www.etlogistik.com/Upload/Files/pl/docs/REGULAMIN%20ETL%20(aktualizacja%2020150701).pdf</url> </item> </documents> </item> </services> <errors xsi:nil="true"/> </getRegulationsResult> </ns1:getRegulationsResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
GetServicesResult getServices (GetServicesParams)
Metoda służy do pobierania listy skonfigurowanych na koncie przewoźników. Zawiea Id przewoźnika, jego typ oraz nadą mu nazwę.
Przykład request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:getServices> <data> <auth> <access_token>access_token</access_token> </auth> </data> </ns1:getServices> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:getServicesResponse> <getServicesResult> <services> <item> <name>DPD (kurier)</name> <type>dpd</type> <id>821</id> <additionalServices> <item>additional_handling</item> <item>cod</item> <item>cod_express</item> <item>guarantee_0930</item> <item>guarantee_1200</item> <item>saturday_delivery</item> <item>rod</item> </additionalServices> </item> <item> <name>InPost (kurier)</name> <type>inpost</type> <id>822</id> <additionalServices> <item>cod</item> </additionalServices> </item> <item> <name>Własny InPost</name> <type>inpost</type> <id>848</id> <additionalServices> <item>cod</item> </additionalServices> </item> <item> <name>Borkerka UPS</name> <type>ups</type> <id>856</id> <additionalServices> <item>additional_handling</item> <item>cod</item> <item>rod</item> <item>ups_saver</item> </additionalServices> </item> <item> <name>GLS</name> <type>gls</type> <id>857</id> <additionalServices> <item>additional_handling</item> </additionalServices> </item> <item> <name>InPost Kurier</name> <type>inpostkurier</type> <id>858</id> <additionalServices> <item>additional_handling</item> <item>sms_predelivery_information</item> <item>cod</item> <item>saturday_delivery</item> <item>rod</item> </additionalServices> </item> <item> <name>FedEx (kurier)</name> <type>fedex</type> <id>859</id> <additionalServices> <item>additional_handling</item> <item>cod</item> <item>cod_express</item> <item>rod</item> </additionalServices> </item> <item> <name>Poczta Polska</name> <type>poczta</type> <id>860</id> <additionalServices> <item>cod</item> <item>fragile</item> </additionalServices> </item> <item> <name>Własny DPD</name> <type>dpd</type> <id>861</id> <additionalServices> <item>additional_handling</item> <item>cod</item> <item>guarantee_0930</item> <item>guarantee_1200</item> <item>saturday_delivery</item> <item>rod</item> </additionalServices> </item> <item> <name>DHL Parcel</name> <type>dhl</type> <id>862</id> <additionalServices> <item>additional_handling</item> <item>sms_predelivery_information</item> <item>cod</item> <item>guarantee_0930</item> <item>guarantee_1200</item> <item>saturday_delivery</item> <item>rod</item> </additionalServices> </item> <item> <name>DHL Express</name> <type>dhlinternational</type> <id>863</id> <additionalServices> <item>additional_handling</item> <item>sms_predelivery_information</item> <item>cod</item> <item>guarantee_0930</item> <item>guarantee_1200</item> <item>saturday_delivery</item> <item>rod</item> </additionalServices> </item> <item> <name>Paczka w RUCHu</name> <type>ruch</type> <id>864</id> <additionalServices/> </item> <item> <name>DHL Parcel</name> <type>dhl</type> <id>961</id> <additionalServices> <item>additional_handling</item> <item>sms_predelivery_information</item> <item>cod</item> <item>guarantee_0930</item> <item>guarantee_1200</item> <item>saturday_delivery</item> <item>rod</item> </additionalServices> </item> <item> <name>K-EXx</name> <type>kex</type> <id>988</id> <additionalServices> <item>cod</item> <item>cod_express</item> </additionalServices> </item> <item> <name>InPost</name> <type>inpost</type> <id>2289</id> <additionalServices> <item>cod</item> </additionalServices> </item> <item> <name>X-press</name> <type>xpress</type> <id>4083</id> <additionalServices/> </item> </services> <errors xsi:nil="true"/> </getServicesResult> </ns1:getServicesResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
PayResult pay (PayParams)
Metoda służy do generowania adresu płatności, która doładuje konto w serwisie w celu zlecenia odbioru przesyłek.
Przykład request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:pay> <data> <auth> <access_token>access_token</access_token> </auth> <amount>16.5</amount> <url>https://testowyurl.pl</url> <reference_id>payment123</reference_id> </data> </ns1:pay> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:payResponse> <payResult> <url>http://furgonetka.pl/partner/payment/hashxxx</url> <errors xsi:nil="true"/> </payResult> </ns1:payResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
PickupResult pickup (PickupParams)
Metoda służy do zlecania odbioru przesyłek.
Przykład request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:pickup> <data> <auth> <access_token>access_token</access_token> </auth> <packages_ids> <item>4387764</item> </packages_ids> </data> </ns1:pickup> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:pickupResponse> <pickupResult> <ordered_packages_ids> <item>4387764</item> </ordered_packages_ids> <pickup_fees xsi:nil="true"/> <packages_order_errors xsi:nil="true"/> <errors xsi:nil="true"/> </pickupResult> </ns1:pickupResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
ValidateResult validatePackage (Package)
Metoda służy do sprawdzania poprawności danych do utworzenia przesyłki.
Przykład request.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:validatePackage> <data> <auth> <access_token>access_token</access_token> </auth> <partner_reference_number/> <service_id>821</service_id> <sender> <name>Jan Kowalski</name> <email>jan@kowalski.pl</email> <company>Spinacz.pl</company> <street>Polna 1/2</street> <postcode>82-300</postcode> <city>Elbląg</city> <country_code>PL</country_code> <county xsi:nil="true"/> <phone>500123456</phone> <point xsi:nil="true"/> </sender> <receiver> <name>Adam Mickiewicz</name> <email>adam@mickiewicz.pl</email> <company>Furgonetka.pl</company> <street>Błotna 2/3</street> <postcode>80-300</postcode> <city>Gdańsk</city> <country_code>PL</country_code> <county xsi:nil="true"/> <phone>501214771</phone> <point xsi:nil="true"/> </receiver> <pickup xsi:nil="true"/> <user_reference_number xsi:nil="true"/> <type>package</type> <parcels> <item> <weight>2</weight> <width>10</width> <height>20</height> <depth>30</depth> <value xsi:nil="true"/> <gauge xsi:nil="true"/> <description>Opis</description> <customer_data xsi:nil="true"/> </item> </parcels> <services> <cod> <amount>100</amount> <iban>iban</iban> <name>Jan Kowalski</name> </cod> <rod xsi:nil="true"/> <additional_handling xsi:nil="true"/> <ups_saver xsi:nil="true"/> <sending_at_point xsi:nil="true"/> <private_shipping xsi:nil="true"/> </services> <label> <file_format>PDF</file_format> <page_format>A4</page_format> </label> <regulations_accept>1502183405</regulations_accept> <pickup_date xsi:nil="true"/> </data> </ns1:validatePackage> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Przykład response.xml
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://biznes-test.furgonetka.pl/api/soap/v2"> <SOAP-ENV:Body> <ns1:validatePackageResponse> <validatePackageResult> <errors xsi:nil="true"/> </validatePackageResult> </ns1:validatePackageResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Struktury
Struktura AccountExistsParams | |||
---|---|---|---|
auth | Auth | wymagany | Dane autoryzacyjne |
string | wymagany | E-mail użytkownika z systemu partnera |
Struktura AccountExistsResult | |||
---|---|---|---|
status | string | opcjonalny | Informacja czy konto istnieje. Przyjmuje wartości: NOT_EXISTS | EXISTS | NO_ACTIVE |
partner_account_id | string | opcjonalny | ID konta z serwisu partnera |
oauth | OAuth | opcjonalny | Struktura zawierająca dane dostępowe OAuth |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura AddIntegrationSourceParams | |||
---|---|---|---|
auth | Auth | wymagany | Authorization data. |
integration_type | string | wymagany | Specific integration type. |
module_version | string | opcjonalny | Version of the module. |
data_1 | string | opcjonalny | Integration data 1. |
data_2 | string | opcjonalny | Integration data 2. |
data_3 | string | opcjonalny | Integration data 3. |
data_4 | string | opcjonalny | Integration data 4. |
data_5 | string | opcjonalny | Integration data 5. |
data_6 | string | opcjonalny | Integration data 6. |
Struktura AddIntegrationSourceResult | |||
---|---|---|---|
source_id | int | opcjonalny | Source ID. |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura AddPackageToTrackingParams | |||
---|---|---|---|
auth | Auth | wymagany | Authorization data. |
name | string | opcjonalny | Nazwa przydzielona przez użytkownika |
package_no | string | wymagany | Numer listu przewozowego |
service | string | opcjonalny |
Typ przewoźnika (jeśli nie zostanie przesyłana to WebService spróbuje to sam określić)
więcej informacji |
Struktura AddPackageToTrackingResult | |||
---|---|---|---|
package_id | int | wymagany | Identyfikator przesyłki |
service | string | opcjonalny |
Typ przewoźnika
więcej informacji |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura Auth | |||
---|---|---|---|
access_token | string | wymagany |
Token użytkownika zalogowanego przez OAuth
więcej informacji |
Struktura CalculatePackage | |||
---|---|---|---|
auth | Auth | wymagany | Dane autoryzacyjne |
sender | Sender | wymagany | Struktura zawierająca informacje o nadawcy |
receiver | Receiver | wymagany | Struktura zawierająca informacje o odbiorcy |
pickup | Pickup | opcjonalny | Struktura zawierająca informacje o miejscu odbioru przesyłki przez kuriera |
type | string | wymagany |
Typ przesyłki, dopuszczalne wartości: package - paczka, dox - koperta, pallette - paleta
więcej informacji |
parcels | Parcel [] | wymagany | Tablica zawierająca informacje o przesyłkach. Maksymalnie liczba przesyłek dla przewoźnika DHL Pracel, DPD, GLS, InPost Kurier, UPS - 10; DHL Express, Furgonetka Dziś, FedEx, InPost, KEX, Poczta, Ruch - 1, Xpress - 1 |
services | Services | opcjonalny | Struktura zawierająca informacje o usługach dodatkowych |
pickup_date | PickupDate | opcjonalny |
Struktura zawierająca informację o dacie odbioru przesłki. Dostępna jest dla DPD, DHL, UPS, FedEx i Poczty Polskiej.
więcej informacji |
Struktura CalculatePackageResult | |||
---|---|---|---|
services_pricing | ServicePricing [] | opcjonalny | Lista cen przesyłek w zależności od przewoźnika |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura CancelPackageParams | |||
---|---|---|---|
auth | Auth | wymagany | Dane autoryzacyjne |
id | int | wymagany | Id przesyłki |
Struktura CancelPackageResult | |||
---|---|---|---|
packages | CanceledPackage [] | opcjonalny | Lista anulowanych przesyłek |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura CanceledPackage | |||
---|---|---|---|
id | int | wymagany | Id przesyłki |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura Cod | |||
---|---|---|---|
amount | float | wymagany | Wartość pobrania w PLN |
iban | string | wymagany | Numer rachunku bankowego |
name | string | wymagany | Właściciel rachunku bankowego |
express | bool | opcjonalny | Usługa pobraniowa Express. Kwota pobrania wysyłana jest nadawcy 1 dzień roboczy po dostarczeniu przesyłki. Usługo dostępna dla: DPD, FedEx i GEIS. |
Struktura CreateAccountParams | |||
---|---|---|---|
auth | Auth | wymagany | Dane autoryzacyjne |
partner_account_id | string | wymagany | ID konta z serwisu partnera |
account_type | string | wymagany | Rodzaj konta. Przyjmuje wartości: PERSONAL | COMPANY |
name | string | opcjonalny | Imię |
surname | string | opcjonalny | Nazwisko |
company | string | opcjonalny | Nazwa firmy |
street | string | opcjonalny | Ulica, numer domu i lokalu |
postcode | string | opcjonalny | Kod pocztowy |
city | string | opcjonalny | Miasto |
country_code | string | opcjonalny |
Kod kraju w formacie ISO 3166-1 alpha-2
więcej informacji |
county | string | opcjonalny | Hrabstwo |
string | wymagany | Adres e-mail | |
phone | string | opcjonalny | Numer telefonu |
nip | string | opcjonalny | Numer NIP |
Struktura CreateAccountResult | |||
---|---|---|---|
oauth | OAuth | opcjonalny | Struktura zawierająca dane dostępowe OAuth |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura CreateIntegrationOAuthApplicationParams | |||
---|---|---|---|
integration_type | string | wymagany | Typ integracji. Dostępne wartości: prestashop, magento. |
url | string | wymagany | Adres powrotu po pomyślnym uwierzytelnieniu OAuth. |
data_1 | string | wymagany | Dane służące do autoryzacji integracji. |
data_2 | string | wymagany | Dane służące do autoryzacji integracji. |
data_3 | string | opcjonalny | Dane służące do autoryzacji integracji. |
Struktura CreateIntegrationOAuthApplicationResult | |||
---|---|---|---|
client_id | string | opcjonalny | OAuth application client ID |
client_secret | string | opcjonalny | OAuth application client Secret |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura Details | |||
---|---|---|---|
id | int | opcjonalny | ID przesyłki |
partner_reference_number | string | opcjonalny | Unikalny numer zamówienia z systemu partnera |
documents | Documents | opcjonalny | Struktura zawierająca informacje o dokumentach przewozowych |
parcels | DetailsParcel [] | opcjonalny | Tablica zawierająca numery listów przewozowych |
pricing | Pricing | opcjonalny | Struktura zawierająca informację o wycenie przesyłki |
pickup_date | PickupDate | opcjonalny | Struktura zawierająca informację o dacie odbioru przesłki |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura DetailsParcel | |||
---|---|---|---|
package_no | string | wymagany | Numer listu przewozowego |
state | string | wymagany |
Stan przesyłki
więcej informacji |
Struktura Documents | |||
---|---|---|---|
label | File | wymagany | Struktura zawierająca etykietę |
protocol | File | wymagany | Struktura zawierająca protokół |
cod | File | wymagany | Struktura zawierająca dokumenty COD |
regulation | File | wymagany | Struktura zawierająca regulamin |
Struktura Error | |||
---|---|---|---|
field | string | wymagany | Nazwa pola |
message | string | wymagany | Treść błędu |
Struktura File | |||
---|---|---|---|
format | string | wymagany |
Format pliku (PDF, ZPL, EPL)
więcej informacji |
content | string | wymagany | Zawartość pliku w base64 |
Struktura GetAvailablePickupHoursParams | |||
---|---|---|---|
auth | Auth | wymagany | Dane autoryzacyjne |
service_id | int | wymagany | Id przewoźnika skonfigurowanego w serwisie |
ready_date | string | wymagany | Data kiedy przesyłka będzie gotowa do nadania w formacie YYYY-MM-DD |
sender | GetAvailablePickupHoursSender | wymagany | Struktura zawierająca informacje o nadawcy |
receiver | GetAvailablePickupHoursReceiver | opcjonalny | Struktura zawierająca informacje o odbiorcy |
services | GetAvailablePickupHoursServices | opcjonalny | Struktura zawierająca informacje o usługach dodatkowych |
weight | float | opcjonalny | Waga przesyłki |
Struktura GetAvailablePickupHoursReceiver | |||
---|---|---|---|
country_code | string | wymagany |
Kod kraju w formacie ISO 3166-1 alpha-2
więcej informacji |
Struktura GetAvailablePickupHoursResult | |||
---|---|---|---|
pickup_date | PickupDate [] | opcjonalny |
Data podjazdu
więcej informacji |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura GetAvailablePickupHoursSender | |||
---|---|---|---|
postcode | string | wymagany | Kod pocztowy nadawcy |
country_code | string | opcjonalny |
Kod kraju w formacie ISO 3166-1 alpha-2
więcej informacji |
Struktura GetAvailablePickupHoursServices | |||
---|---|---|---|
ups_saver | bool | opcjonalny | UPS Express Saver |
Struktura GetBalanceParams | |||
---|---|---|---|
auth | Auth | wymagany | Dane autoryzacyjne |
Struktura GetBalanceResult | |||
---|---|---|---|
balance | float | opcjonalny | Stan konta w PLN |
credit_limit | float | opcjonalny | Limit kredytowy w PLN |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura GetPackageDetailsParams | |||
---|---|---|---|
auth | Auth | wymagany | Dane autoryzacyjne |
partner_reference_number | string | opcjonalny | Unikalny numer zamówienia z systemu partnera (wymagany, gdy nie został przesłany package_no) |
package_no | string | opcjonalny | Numer przesyłki (wymagany, gdy nie został przesłany partner_reference_number) |
Struktura GetPackageFormUrlParams | |||
---|---|---|---|
auth | Auth | wymagany | Dane autoryzacyjne. |
sender | Sender | wymagany | Struktura zawierająca informacje o nadawcy. |
receiver | Receiver | wymagany | Struktura zawierająca informacje o odbiorcy. |
service | string | opcjonalny | Typ wybranego przewoźnika (wymagany w przypadku podanego punktu nadania/odbioru). Dopuszczalne wartości: dhl, dpd, fedex, ups, inpost, inpostkurier, poczta, kex, ruch, xpress. |
type | string | opcjonalny | Typ przesyłki. Dopuszczalne wartości: package - paczka, dox - koperta, pallette - paleta. |
parcels | Parcel [] | opcjonalny | Tablica zawierająca informacje o przesyłkach. |
services | Services | opcjonalny | Struktura zawierająca informacje o usługach dodatkowych. |
pickup_date | PickupDate | opcjonalny |
Struktura zawierająca informację o dacie odbioru przesłki. Dostępna jest dla DPD, DHL, UPS, FedEx i Poczty Polskiej.
więcej informacji |
partner_reference_number | string | wymagany | Unikalny numer zamówienia z systemu partnera. |
user_reference_number | string | opcjonalny | Numer dokumentu sprzedaży, który znajdzie się na etykiecie. |
sale_source_id | int | opcjonalny | Identyfikator źródła sprzedaży powiązanego z integracją. |
Struktura GetPackageFormUrlResult | |||
---|---|---|---|
url | string | opcjonalny | Adres URL do formularza dodawania przesyłki |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura GetPackagesTrackingParams | |||
---|---|---|---|
auth | Auth | wymagany | Dane autoryzacyjne |
packages | TrackingPackage [] | wymagany | Lista przesyłek |
Struktura GetPackagesTrackingResult | |||
---|---|---|---|
packages | TrackingPackageResult [] | opcjonalny | Lista przesyłek |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura GetRegulationsParams | |||
---|---|---|---|
auth | Auth | wymagany | Dane autoryzacyjne |
Struktura GetRegulationsResult | |||
---|---|---|---|
services | Regulations [] | opcjonalny | Lista regulaminów per przewoźnik |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura GetServicesParams | |||
---|---|---|---|
auth | Auth | wymagany | Dane autoryzacyjne |
Struktura GetServicesResult | |||
---|---|---|---|
services | Service [] | opcjonalny | Lista przewoźników |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura Label | |||
---|---|---|---|
file_format | string | wymagany |
Format pliku z etykietą (pdf, epl, zpl)
więcej informacji |
page_format | string | wymagany | Dla PDF - format papieru A4 lub A6 |
Struktura OAuth | |||
---|---|---|---|
access_token | string | opcjonalny | Access token założonego konta |
token_type | string | opcjonalny | Typ tokena, w tym przypadku Bearer |
expires_in | int | opcjonalny | Czas ważności tokena dostępowego w sekundach (30 dni) |
refresh_token | string | opcjonalny | Token pozwalający na przedłużenie ważności autoryzacji użytkownika dla aplikacji do 3 miesięcy |
Struktura Package | |||
---|---|---|---|
auth | Auth | wymagany | Dane autoryzacyjne |
partner_reference_number | string | wymagany | Unikalny numer zamówienia z systemu partnera |
service_id | int | wymagany | Id przewoźnika skonfigurowanego w serwisie |
sender | Sender | wymagany | Struktura zawierająca informacje o nadawcy |
receiver | Receiver | wymagany | Struktura zawierająca informacje o odbiorcy |
pickup | Pickup | opcjonalny | Struktura zawierająca informacje o miejscu odbioru przesyłki przez kuriera |
user_reference_number | string | opcjonalny | Numer dokumentu sprzedaży, który znajdzie się na etykiecie. U następujących przewoźników, liczba znaków, które znajdą się na etykiecie jest ograniczona: DPD (27), Fedex (30), UPS (35), Inpost (28), GLS (25) |
type | string | wymagany |
Typ przesyłki, dopuszczalne wartości: package - paczka, dox - koperta, pallette - paleta
więcej informacji |
parcels | Parcel [] | wymagany | Tablica zawierająca informacje o przesyłkach. Maksymalnie liczba przesyłek dla przewoźnika DHL Pracel, DPD, GLS, InPost Kurier, UPS - 10; DHL Express, Furgonetka Dziś, FedEx, InPost, KEX, Poczta, Ruch - 1, Xpress - 1 |
services | Services | opcjonalny | Struktura zawierająca informacje o usługach dodatkowych |
label | Label | wymagany | Struktura zawierająca ustawienia formatu zwracanej etykiety |
regulations_accept | int | wymagany | Wersja regulaminu, którą akceptuje użytkownik (wymagany dla przewoźników z umową furgonetka.pl) |
pickup_date | PickupDate | opcjonalny |
Struktura zawierająca informację o dacie odbioru przesłki. Dostępna jest dla DPD, DHL, UPS, FedEx i Poczty Polskiej.
więcej informacji |
request_collection | bool | opcjonalny | Parametr określa czy dla przesyłki ma zostać zlecony odbiór (domyślna wartość true). |
Struktura PackageOrderError | |||
---|---|---|---|
package_id | int | wymagany | Identyfikator przesyłki |
code | string | wymagany | Kod błędu |
error | string | wymagany | Treść błędu |
Struktura Parcel | |||
---|---|---|---|
weight | float | opcjonalny | Waga paczki w kg |
width | int | opcjonalny | Szerokość paczki w cm |
height | int | opcjonalny | Wysokość paczki w cm |
depth | int | opcjonalny | Długość paczki w cm |
value | float | opcjonalny | Wartość przesyłki w PLN (od podania tej wartości zależy ubezpieczenie przesyłki) |
gauge | string | opcjonalny | Gabaryt (wymagany dla InPost i Poczta), dostępne wartości InPost: A, B, C; Poczta Kurier48: XS, S, M, L, XL, XXL; Poczta Polecony: S, M, L |
description | string | opcjonalny | Opis zawartości paczki |
customer_data | string | opcjonalny | Uwagi na etykiecie |
Struktura PayParams | |||
---|---|---|---|
auth | Auth | wymagany | Dane autoryzacyjne |
amount | float | wymagany | Kwota w PLN |
url | string | wymagany | Adres URL do powrotu na stronę partnera. Do adresu zostanie dodany parametr "status" o wartościach SUCCESS lub FAIL. |
reference_id | string | wymagany | Numer płatności z systemu partnera |
Struktura PayResult | |||
---|---|---|---|
url | string | opcjonalny | Adres URL do płatności |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura Pickup | |||
---|---|---|---|
name | string | opcjonalny | Imię i nazwisko |
string | opcjonalny | ||
company | string | opcjonalny | Nazwa firmy |
street | string | wymagany | Ulica, numer domu i lokalu nadawcy |
postcode | string | wymagany | Kod pocztowy |
city | string | wymagany | Miasto |
country_code | string | opcjonalny |
Kod kraju w formacie ISO 3166-1 alpha-2
więcej informacji |
county | string | opcjonalny | Hrabstwo (tylko przesyłki międzynarodowe) |
phone | string | opcjonalny | Numer telefonu |
Struktura PickupDate | |||
---|---|---|---|
date | string | wymagany | Data odbioru przesyłki |
min_time | string | wymagany | Minimalny czas podjęcia przesyłki |
max_time | string | wymagany | Maksymalny czas podjęcia przesyłki |
Struktura PickupFee | |||
---|---|---|---|
price_gross | float | wymagany | Cena brutto w PLN |
price_net | float | wymagany | Cena netto w PLN |
tax | int | wymagany | Procent podatku VAT |
packages_ids | int [] | opcjonalny | Identyfikatory przesyłek, których dotyczy opłata |
Struktura PickupParams | |||
---|---|---|---|
auth | Auth | wymagany | Dane autoryzacyjne |
packages_ids | int [] | wymagany | Identyfikatory przesyłek dla których ma zostać zlecony odbiór (maksymalnie 20) |
Struktura PickupResult | |||
---|---|---|---|
ordered_packages_ids | int [] | opcjonalny | Lista identyfikatorów zamówionych przesyłek |
pickup_fees | PickupFee [] | opcjonalny | Struktura zawierająca informacje o opłatach za podjazd kuriera (InPost Kurier) |
packages_order_errors | PackageOrderError [] | opcjonalny | Lista zawierająca informacje o przesyłkach, dla których wystąpił błąd podczas zlecania odbioru |
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Struktura Pricing | |||
---|---|---|---|
price_gross | float | wymagany | Cena brutto w PLN |
price_net | float | wymagany | Cena netto w PLN |
price_base_net | float | wymagany | Cena podstawowa netto w PLN - cena bez usług dodatkowych |
tax | int | wymagany | Procent podatku VAT |
details | PricingDetails [] | wymagany | Struktura zawierająca szczegółową wycenę przesyłki |
pickup_fee | PickupFee | opcjonalny | Struktura zawierająca informacje o opłacie za podjazd kuriera (InPost Kurier) |
Struktura PricingDetails | |||
---|---|---|---|
price_net | float | wymagany | Cena netto w PLN |
description | string | wymagany | Opis usługi dodatkowej |
Struktura Receiver | |||
---|---|---|---|
name | string | opcjonalny | Imię i nazwisko adresata |
string | opcjonalny | Email adresata | |
company | string | opcjonalny | Nazwa firmy |
street | string | wymagany | Ulica, numer domu i lokalu adresata |
postcode | string | wymagany | Kod pocztowy adresata |
city | string | wymagany | Miasto adresata |
country_code | string | opcjonalny |
Kod kraju w formacie ISO 3166-1 alpha-2
więcej informacji |
county | string | opcjonalny | Hrabstwo adresata (tylko przesyłki międzynarodowe) |
phone | string | opcjonalny | Numer telefonu adresata |
point | string | opcjonalny | Punkt odbioru (UPS Access Point, InPost Paczkomaty, Poczta Polska, Paczka w RUCHu, DPD Pickup). |
Struktura Regulations | |||
---|---|---|---|
name | string | wymagany | Nazwa |
version | int | wymagany | Wersja regulaminu (timestamp ostatniej zmiany) |
datetime | string | wymagany | Data ostatniej zmiany regulaminu |
service_type | string | wymagany |
Type przewoźnika (np. dpd, fedex, inpost)
więcej informacji |
documents | RegulationsDocument [] | wymagany | Lista dokumentów |
Struktura RegulationsDocument | |||
---|---|---|---|
name | string | wymagany | Nazwa |
url | string | wymagany | Adres URL regulaminu |
Struktura Sender | |||
---|---|---|---|
name | string | opcjonalny | Imię i nazwisko nadawcy |
string | opcjonalny | Email nadawcy | |
company | string | opcjonalny | Nazwa firmy |
street | string | wymagany | Ulica, numer domu i lokalu nadawcy |
postcode | string | wymagany | Kod pocztowy nadawcy |
city | string | wymagany | Miasto nadawcy |
country_code | string | opcjonalny |
Kod kraju w formacie ISO 3166-1 alpha-2
więcej informacji |
county | string | opcjonalny | Hrabstwo nadawcy (tylko przesyłki międzynarodowe) |
phone | string | opcjonalny | Numer telefonu nadawcy |
point | string | opcjonalny | Punkt nadania (UPS Access Point, InPost Paczkomaty, Poczta Polska, Paczka w RUCHu, DPD Pickup). |
Struktura Service | |||
---|---|---|---|
name | string | wymagany | Nazwa własna przewoźnika |
type | string | wymagany |
Typ przewoźnika (np. dpd, fedex, inpost)
więcej informacji |
id | int | wymagany | Id przewoźnika |
additionalServices | string [] | wymagany |
Tablica dostępnych usług dodatkowych przewoźnika
więcej informacji |
Struktura ServicePricing | |||
---|---|---|---|
service | string | wymagany |
Typ przewoźnika
więcej informacji |
service_id | int | wymagany | Id przewoźnika skonfigurowanego w serwisie |
pricing | Pricing | opcjonalny | Wycena |
errors | Error [] | opcjonalny | Tablica z błędami walidacji |
Struktura Services | |||
---|---|---|---|
cod | Cod | opcjonalny | Struktura zawierająca informacje o usłudze pobraniowej. Dostępny dla: DPD, UPS, FedEx, GEIS (-KEX), InPost Paczkomaty, InPost Kurier, Poczta Polska, X-press. |
rod | bool | opcjonalny | Dokumenty zwrotne. Dostępny dla: DPD, UPS, FedEx, InPost Kurier |
guarantee_0930 | bool | opcjonalny | Doręczenie do godziny 9:30 / 10:30. Dostępny dla: DPD. |
guarantee_1200 | bool | opcjonalny | Doręczenie do godziny 12:00. Dostępny dla: DPD. |
guarantee_next_day | bool | opcjonalny | Doręczenie w następnym dniu roboczym. Dostępny dla: DPD. |
saturday_delivery | bool | opcjonalny | Doręczenie w sobotę. Dostępny dla: DPD, InPost Kurier. Wymaga aby data nadania wypadała w piątek. |
additional_handling | bool | opcjonalny | Element niestandardowy |
ups_saver | bool | opcjonalny | UPS Express Saver |
sending_at_point | bool | opcjonalny | Nadanie w punkcie (DPD Pickup, UPS Access Point) |
private_shipping | bool | opcjonalny | Doręczenie do osoby prywatnej |
sms_predelivery_information | bool | opcjonalny | Awizacja SMS-owa doręczenia. Dostępny dla: InPost Kurier. |
insurance | bool | opcjonalny | Ubezpieczenie, dopuszczalne wartości: 0 - Ubezpieczenie przesyłki, 1 - Przesyłka wartościowa. Dostępny dla: Poczta Polska. |
fragile | bool | opcjonalny | Usługa "Ostrożnie". Dostępny dla: Poczta Polska. |
fedex_priority | bool | opcjonalny | Usługa Fedex Priority - czas doręczenia nawet dwukrotnie szybszy od opcji Economy (do 3 dni roboczych). Dostępny dla: FedEx |
xpress_plus | bool | opcjonalny | Usługa X-Press Plus. Dostępny dla: X-Press. |
documents_supply | bool | opcjonalny | Usługa dostarczenia dokumentów przewozowych przez firmę kurierską. Dostępny dla: DPD. |
saturday_sunday_delivery | bool | opcjonalny | Usługa "Paczka w Weekend" - doręczenie przesyłki do paczkomatu w sobotę lub niedzielę, przesyłka powinna być nadana od czwartku od godzinny 20:00 do soboty do godziny 13:00. |
Struktura Tracking | |||
---|---|---|---|
state | string | wymagany |
Stan przesyłki
więcej informacji |
status | string | wymagany | Status opisowy |
datetime | string | wymagany | Data i godzina statusu |
branch | string | wymagany | Oddział/stacja gdzie przebywa przesyłka |
Struktura TrackingPackage | |||
---|---|---|---|
package_no | string | wymagany | Numer przesyłki |
Struktura TrackingPackageResult | |||
---|---|---|---|
package_no | string | wymagany | Numer przesyłki |
tracking | Tracking [] | opcjonalny |
Struktura ValidateResult | |||
---|---|---|---|
errors | Error [] | opcjonalny |
Tablica z błędami
więcej informacji |
Przewoźnicy
Przewoźnik | Typ (wartość ENUM) | Regulaminy |
---|---|---|
DPD | dpd |
Regulamin Świadczenia Usług W Obrocie Krajowym DPD Polska sp. z o.o.
|
UPS | ups |
Ogólne Warunki Świadczenia Usług UPS
Politykę Prywatności UPS |
GLS | gls |
Regulamin Świadczenia Usług przez General Logistics Systems Poland Spółka z o.o.
|
GEIS (K-EX) | kex | |
FedEx | fedex |
Warunki Przewozu FEDERAL EXPRESS dla Europy, Bliskiego Wschodu, Subkontynentu Indyjskiego oraz Afryki
|
InPost Paczkomaty | inpost |
Regulamin świadczenia usługi „Paczkomaty 24/7” przez InPost Paczkomaty Sp. z o.o.
|
InPost Kurier | inpostkurier |
Regulamin świadczenia usług pocztowych i przewozowych przez InPost Express Sp. z o.o.
|
Paczka w Ruchu | ruch |
REGULAMIN ŚWIADCZENIA USŁUG POCZTOWYCH W RUCH S.A
|
Poczta Polska | poczta |
OWU Poczty Polskiej
OGÓLNE WARUNKI UBEZPIECZENIA PRZESYŁEK NADANYCH PRZEZ KLIENTA BIZNESOWEGO Poczty Polskiej |
DHL Parcel | dhl |
DHL Parcel
|
DHL Express | dhlinternational |
DHL Express
|
X-press | xpress | |
Patron Service | patronservice |
REGULAMIN ŚWIADCZENIA USŁUG PATRON SERVICE SP. Z O.O.
|
Usługi dodatkowe
Kod usługi | Usługa |
---|---|
cod | Pobranie przy doręczeniu |
cod_express | Pobranie przy doręczeniu Express |
guarantee_0930 | Doręczenie do godziny 9:30 |
guarantee_1200 | Doręczenie do godziny 12:00 |
saturday_delivery | Doręczenie przesyłki w sobotę. W celu realizacji usługi przesyłka powinna być nadana w piątek. |
rod | Dokumenty zwrotne |
fragile | Usługa "Ostrożnie" |
sms_predelivery_information | Awizacja SMS-owa dostawy |
ups_saver | UPS Express Saver |
private_shipping | Doręczenie do osoby prywatnej |
fedex_priority | FedEx Priority |
sending_at_point | Nadanie w punkcie (DPD Pickup, UPS Access Point) |
insurance | Usługa "Ostrożnie" |
Typy przesyłek
Typ | Opis | Obsługiwani przewoźnicy |
---|---|---|
package | Paczka | DPD, UPS, GLS, InPost Paczkomaty, InPost Kurier, FedEx, Poczta Polska, DHL Parcel, DHL Express, Paczka w Ruchu, GEIS (K-EX), X-press |
dox | Koperta | DPD, UPS, GLS, DHL Parcel |
pallette | Paleta | DPD, FedEx, DHL Parcel |
Stany przesyłki
Stan | Opis |
---|---|
waiting | Przesyłka oczekuje na zamówienie/nadanie |
ordered | Przesyłka zamówiona (poprzednio sent) |
collected | Przesyłka odebrana od nadawcy |
collect-problem | Występuje problem z odbiorem przesyłki od nadawcy |
transit | Przesyłka w przewozie |
delivery | Przesyłka w trakcie doręczenia |
delivery-problem | Występuje problem w trakcie doręczenia przesyłki |
delivered | Przesyłka doręczona |
canceled | Przesyłka anulowana |
returned | Przesyłka zwrócona do nadawcy |
unexpected-situation | Wystąpiła nieoczekiwana sytuacja |
Formaty dokumentów
Przewoźnik | Formaty |
---|---|
DPD | EPL, ZPL, PDF |
UPS | EPL, ZPL, PDF |
GLS | EPL, ZPL, PDF (dla usług P&S, P&R, oraz Exchange etykietę przynosi kurier) |
GEIS (K-EX) | EPL, ZPL, PDF |
InPost Paczkomaty | EPL, ZPL, PDF |
InPost Kurier | EPL, ZPL, PDF |
Paczka w Ruchu | EPL, ZPL, PDF |
Poczta Polska | EPL, ZPL, PDF |
DHL Parcel | EPL, ZPL, PDF |
DHL Express | EPL, ZPL, PDF |
X-press | EPL, ZPL, PDF |
FedEx | EPL, ZPL, PDF |
Data odbioru przesyłki
Przewoźnik | Ilość przedziałów | Możliwość modyfikacji |
---|---|---|
DPD | Wiele | Nie |
DHL | 1 | Tak |
FedEx | 1 | Nie |
Poczta Polska | 1 | Nie |
UPS | Wiele | Nie |
Kody błędów
Kod błędu | Opis |
---|---|
ERROR_CREATE_LABEL | Wystąpił problem podczas generowania listu przewozowego. |
ERROR_PICKUP_DATE | Błędna data lub godziny odbior przesyłki. |
ERROR_PICKUP | Wystąpił problem podczas zlecania odbioru przesyłki. |
Przykład użycia WebAPI w PHP
Przykładowy request dla metody createPackage
<?php
try {
// do obsługi Furgonetka WebAPI posłużymy się klasą SoapClient
$client = new \SoapClient('http://biznes-test.furgonetka.pl/api/soap/v2?wsdl', [
'trace' => true,
'cache_wsdl' => false,
]);
// Access token uzyskać możesz pod adresem: https://furgonetka.pl/api/oauth
$auth = [
'access_token' => 'eyJ...v6A',
];
// pobieram listę przewoźników skonfigurowanych na koncie
$services = $client->getServices([
'data' => [
'auth' => $auth,
],
])->getServicesResult;
if (!$services->services) {
if (!empty($services->errors)) {
$errors = $services->errors->item;
}
throw new \Exception('Nie zdołano pobrać listy przewoźników.');
}
$services = $services->services->item;
// przewoźnik, którym chcę nadać paczkę
$service_type = 'dpd';
// ustalam service_id dla wybranego przewoźnika
foreach ($services as $service) {
if ($service->type === $service_type) {
$service_id = $service->id;
break;
}
}
if (!isset($service_id)) {
throw new \Exception('Nie zdołano ustalić service_id dla ' . $service_type);
}
// pobieram listę aktualnych regulaminów
$regulations = $client->getRegulations([
'data' => [
'auth' => $auth,
],
])->getRegulationsResult;
if (!$regulations->services) {
if (!empty($regulations->errors)) {
$errors = $regulations->errors->item;
}
throw new \Exception('Nie zdołano pobrać listy regulaminów.');
}
$regulations = $regulations->services->item;
// ustalam aktualną wersję regulaminu dla wybranego przewoźnika
foreach ($regulations as $service) {
if ($service->service_type === $service_type) {
$regulations_accept = $service->version;
break;
}
}
if (!isset($regulations_accept)) {
throw new \Exception('Nie ustalono regulaminu dla ' . $service_type);
}
// parametry naszej przesyłki
$paramsPackages = [
'data' => [
'auth' => $auth,
'partner_reference_number' => 147861,
'service_id' => $service_id,
'type' => 'package',
'regulations_accept' => $regulations_accept,
'sender' => [
'name' => 'Jan Kowalski',
'email' => 'jan@kowalski.pl',
'street' => 'Polna 1/2',
'postcode' => '82-300',
'city' => 'Elbląg',
'phone' => '+48 500 999 888',
],
'receiver' => [
'name' => 'Adam Mickiewicz',
'email' => 'adam@mickiewicz.pl',
'street' => 'Grunwaldzka 22/33',
'postcode' => '80-300',
'city' => 'Gdańsk',
'phone' => '+48 600 999 888',
],
'label' => [
'file_format' => 'pdf',
'page_format' => 'a6',
],
'parcels' => [
[
'width' => 10,
'height' => 20,
'depth' => 30,
'value' => 555,
'weight' => 11,
'description' => 'Buty dziecięce',
],
],
'services' => [
'cod' => [
'amount' => 555,
'iban' => '47114020040000350275770660',
'express' => true,
'name' => 'Jan Kowalski'
],
'guarantee_0930' => false,
'guarantee_1200' => false,
'saturday_delivery' => false,
'sms_predelivery_information' => false,
'insurance' => false,
'fragile' => false,
],
],
];
// wykonuje metodę "validatePackage", która sprawdzi poprawność parametrów przesyłki
$validate = $client->validatePackage($paramsPackages)->validatePackageResult;
if (!empty($validate->errors)) {
$errors = $validate->errors->item;
throw new \Exception('Popraw parametry przesyłki.');
}
// parametry poprawne, wykonuje metodę "createPackage" aby utworzyć przesyłkę
$package = $client->createPackage($paramsPackages)->createPackageResult;
if (!empty($package->errors)) {
$errors = $package->errors->item;
throw new \Exception('Nie udało się dodać przesyłki.');
}
// wyświetlam etykietę
header('Content-type: application/pdf');
header('Content-Disposition: inline; filename='
. 'etykieta_dla_zamowienia_' . ($package->partner_reference_number).'.pdf');
echo \base64_decode($package->documents->label->content);
} catch (\Exception $e) {
echo 'Błąd: ', $e->getMessage();
// lista błędów zwrócona przez metodę z WebAPI Furgonetka Biznes
if (isset($errors)) {
\var_dump($errors);
}
}
Wersje tego dokumentu
Wersja dokumentu | Zmiany |
---|---|
1.0 (2018-01-11) | Stworzenie dokumentacji |
1.1 (2018-02-05) |
Umożliwienie wyceny przesyłki za pomocą metody validatePackage bez podania service_id
Dodanie parametru reference_id do metody pay Dodanie parametru pickup_date do metod validatePackage oraz createPackage Dodanie listy typów przesyłek Aktualizacja przykładów |
1.2 (2018-02-06) |
Poprawki typo i opisów pól
Dodanie listy typów przewoźników Podlinkowanie typów danych do tabel Dodanie listy stanów przesyłki Dodanie informacji na temat dat odbioru przesyłki |
1.3 (2018-02-06) | Rozdzielenie metody validatePackage z metodą calculatePackage |
1.4 (2018-02-14) | Dodanie usług dodatkowych guarantee_0930, guarantee_1200, saturday_delivery w strukturze Services |
1.5 (2018-02-16) | Dodanie usług dodatkowych Cod/express, sms_predelivery_information, insurance, fragile oraz self_pickup w strukturze Services |
1.6 (2018-03-16) | Dodanie przykładowego użycia WebAPI w PHP |
1.7 (2018-04-04) | Dodanie usługi dodatkowej fedex_priority w strukturze Services |
1.8 (2018-05-11) |
Dodanie pola regulation w strukturze Documents
Aktualizacja przykładów |
1.9 (2018-05-17) | Zmiana nazwy usługi dodatkowej ap_pickup na sending_at_point i opisu w strukturze Services |
2.0 (2018-05-22) |
Dodanie wysyłki e-maili w trakcie wykonywania metody createPackage.
1. Nadawca otrzyma instrukcję nadania oraz dokumenty (protokół, etykietę). 2. Odbiorca przesyłki otrzyma informację o nadaniu do niego przesyłki oraz o możliwości jej śledzenia. |
2.1 (2018-05-24) | Dodanie metody getBalance służącej do sprawdzania salda oraz limitu kredytowego na koncie użytkownika. |
2.2 (2018-08-02) | Dodanie pola weight w strukturze GetAvailablePickupHoursParams |
2.3 (2018-08-08) |
Dodanie pola name w strukturze Cod
Aktualizacja przykładów |
2.4 (2018-08-20) |
Dla DPD pole phone w strukturze Receiver jest zawsze wymagane.
|
2.5 (2018-09-13) |
Dodanie brakującego parametru w przykładzie użycia WebAPI w PHP
|
2.6 (2018-10-18) |
Dodanie pola additionalServices w strukturze Service
|
2.7 (2019-06-18) | Dodanie pola request_collection w strukturze Package oraz dodanie metody pickup, służącej do zlecania odbioru przesyłek. |
2.8 (2019-06-19) | Aktualizacja listy stanów przesyłki |
2.9 (2019-10-31) | Usunięcie pola alternative_point w strukturze Receiver |
2.10 (2019-11-26) | user_reference_number - Dodanie informacji o ilości znaków umieszczanych na etykietach poszczególnych przewoźników Receiver |
2.11 (2020-05-06) | Dodanie usługi dodatkowej saturday_sunday_delivery w strukturze Services |
2.12 (2020-06-01) | Dodanie usługi dodatkowej guarantee_next_day w strukturze Services |