Ważne zmiany dotyczące BREXITu
Brexit – wymagania w odprawie exportowej i importowej po 01-01-2021
W dniu 01-01-2021 wszystkie przesyłki wysyłane do UK będą podlegać odprawie exportowej oraz importowej w UK. W związku z powyższym wprowadzamy nowe wymagania co do danych podawanych podczas generowania etykiet. Powstanie konieczność podania nowych dodatkowych wartości oraz dodanie minium jednego produktu.
W celu zrealizowania odprawy wymagane jest podanie numer EORI oraz numer VAT UK. W celu uproszczenia zmian, wartości te należy jednorazowo podać w profilu użytkownika w systemie Global24.
Nowe zmiany zostaną wprowadzone w dniu 29-12-2020 (tak aby towar odprawiany po 01-01-2021 na granicy posiadał już wszystkie niezbędne dane).
Nowe wymagane wartości
Nazwa pola | Typ | Wymagane | Opis |
---|---|---|---|
invoiceNumber | string(30) | Tak dla GB od 29.12.2020 |
Numer faktury sprzedażowej |
orderValue | float(8,2) | Tak dla GB od 29.12.2020 |
Wartość zamówienia |
currency | string(3) | Tak dla GB od 29.12.2020 |
Waluta Możliwe wartości:
|
Obowiązkowy minimum jeden produkt
Nazwa pola | Typ | Wymagane | Opis |
---|---|---|---|
name | string(255) | Tak dla GB od 29.12.2020 | Nazwa produktu |
number | string(255) | Tak dla GB od 29.12.2020 | SKU, EAN, ASIN (kod produktu) |
quantity | integer | Tak dla GB od 29.12.2020 | Ilość produktu na zamówieniu |
price | float(8,2) | Tak dla GB od 29.12.2020 | Cena brutto sprzedaży produktu w walucie podanej w polu currency |
tariffCode | string(10) | Tak dla GB od 29.12.2020 | Kod taryfy celnej (8 lub 10 cyfr) |
originCountry | string(2) | Tak dla GB od 04.01.2021 | Kraj pochodzenia (ISO) |
Przykładowy request
{ "userName": "username", "password": "password", "CreateShipmentsRequest002": { "shipmentType": "Delivery", "carrierName": "GB-ROYALMAIL", "shipperAddress": { "additionalDescription": "description" }, "receiverAddress": { "nameOrCompany": "Birmingham Hippodrome", "additionalDescription": "description", "address1": "Hurst Street", "address2": "Southside", "city": "Birmingham", "zipCode": "B5 4TB", "region": "", "country": "GB", "email": "test@email.com", "phone": "123456765", "taxId": "", "pickupId": null }, "invoiceNumber": "TT100/12/01/001", "orderValue": 100.50, "currency": "EUR", "payerAddress": null, "items": [ { "referenceID": "GoLabel0000", "referenceID2": "", "type": "RP", "weight": "2.50", "products": [ { "name": "turbocharger v1.3", "number": "458152587412584", "quantity": "1", "price": 80.50, "tariffCode": "85044030", "originCountry": "DE", "imageUrl": null } ] } ], "serviceLevel": { "service": "T48" }, "shipmentDescription1": "description", "shipmentDescription2": "" } }
1. Ogólne informacje
1.1 CreateShipment
Metoda pozwala na generowanie przesyłek. Przesyłki będą tworzone tylko wtedy, gdy wszystkie dane przesyłki przejdą proces weryfikacji. Jeśli wystąpi błąd i nie można utworzyć przesyłek odpowiedni komunikat o błędzie zostanie odesłany do XML.
Adres na który wysyłamy żądanie:
- produkcyjny: https://gorest.goglobal24.com/create-shipment
- testowy: http://test-gorest.goglobal24.com/create-shipment
I. Struktura żądania
Autoryzacja
Struktura autoryzacji jest wymagana we wszystkich żądaniach. Istnieją dwa sposoby przejścia przez autoryzację w GoLabel REST API. Pierwszym jest podanie hasła oraz nazwy użytkownika, natomiast drugim jest hash użytkownika. Dane te są dostarczane przez administratorów GoLabel.
"hash": "{TwójHash}", "userName": "{TwojaNazwaUżytkownika}", "password": "{TwojeHasło}",
CreateShipmentsRequest002
Właściwa część żądania, w niej zawarte są najważniejsze informacje.
Rodzaje przesyłek
Nazwa pola | Typ | Wymagane | Opis |
---|---|---|---|
shipmentType | string() | Tak |
Rodzaj przesyłki Możliwe wartości:
|
Przykład:
"shipmentType":"Delivery",
Nazwa kuriera
Nazwa pola | Typ | Wymagane | Opis |
---|---|---|---|
carrierName | string() | Tak |
Nazwa kuriera Możliwe wartości:
|
Przykład:
"carrierName":"GB-ROYALMAIL",
Adresy
Pola adresowe są wykorzystywane w danych w zapytaniu zawierających informacje o nadawcy, płatniku oraz odbiorcy. Wszystkie dane adresowe nadawcy na wysyłkach typu „Delivery” oraz w adresie odbiorcy typu „Return” z wyjątkiem additionalDescription zostaną uzupełnione danymi adresowymi punktów zagranicznych Global24.
Nazwa pola | Typ | Wymagane | Opis |
---|---|---|---|
nameOrCompany | string(35) | Tak |
Nazwa |
additionalDescription | string(35) | Nie |
Dodatkowe informacje dotyczące nazwy / firmy lub dodatkowy opis adresu. |
address1 | string(35) | Tak |
Nazwa ulicy i numer domu/mieszkania |
address2 | string(35) | Nie |
Dodatkowy opis adresu |
City | string(35) | Tak |
Nazwa miasta |
zipCode |
|
Tak |
Kod pocztowy |
Region | string(35) | Nie |
Województwo |
Country | string(2) | Tak |
Kod kraju |
|
Tak |
Adres email |
|
Phone |
|
Nie |
Numer telefonu |
taxId | string(40) | Nie |
Numer podatkowych |
pickupId | string(6) | Nie |
Numer punktu odbioru osobistego |
Przykład:
"shipperAddress": null, "receiverAddress":{ "nameOrCompany":"Birmingham Hippodrome", "additionalDescription":"", "address1":"Hurst Street", "address2":"Southside", "city":"Birmingham", "zipCode":"B5 4TB", "region":"", "country":"GB", "email":"test@email.com", "phone":"123456765", "taxId":"", "pickupId":null }, "payerAddress":null,
Pozycje
Tablica zawierająca elementy ze specyfikacją pozycji (paczki).
Nazwa pola | Typ | Wymagane | Opis |
---|---|---|---|
referenceID |
|
Tak |
Niepowtarzalny numer referencyjny zamówienia dla danego klienta, wymagany dla każdej pozycji w przypadku jeśli zamówienie obejmuje więcej niż 1 przedmiot. Dozwolone znaki:
|
referenceID2 |
|
Nie |
Dozwolone znaki:
W przypadku wysyłki za pobraniem kurierem PL-FEDEX należy tu podać numer konta bankowego(wymagany format zgodny ze standardami NRB, 26 cyfr). |
type | string(3) | Tak |
Możliwe wartości są opisane w omówieniu poszczególnych kurierów. |
weight | float(10,2) | Tak |
Waga paczki. |
products | array | Nie |
Produkty. |
Produkty
Tablica zawierająca elementy ze specyfikacją produktów.
Nazwa pola | Typ | Wymagane | Opis |
---|---|---|---|
name | string(255) | Nie | Nazwa produktu lub nazwa oferty na portalach sprzedażowych |
number |
|
Nie | SKU, EAN, ASIN (kod kreskowy na produkcie) |
quantity | int | Nie | Ilość produktu na zamówieniu |
price | string(255) | Nie | Cena brutto sprzedaży produktu |
tariffCode | string(10) | Nie | Kod taryfy celnej (8 lub 10 cyfr) |
originCountry | string(2) | Nie | Kraj pochodzenia (ISO) |
imageUrl | string(255) | Nie | Link z zdjęciem produktu |
Przykład:
"items":[ { "referenceID":"GoLabel0001", "referenceID2":"", "type":"RP", "weight":"2.50" }, { "referenceID":"GoLabel0002", "referenceID2":"", "type":"RP", "weight":"2.50", "products":[ { "name": "turbocharger v1.3", "number": "458152587412584", "quantity": "1", "price": "1125.45", "tariffCode": "85044030", "originCountry": "DE", "imageUrl": "url_to_photo.com" }, { "name": "socks", "number": "398155774553544", "quantity": "3" } ] } ],
Poziom usług
Serwis
Określa typ usługi wysyłki. Możliwe typy dla danych kurierów są przedstawione w ich szczegółowych opisach.
Nazwa pola | Typ | Wymagane | Opis |
---|---|---|---|
service | string(3) | Tak |
Serwis. Możliwe wartości są opisane w omówieniu poszczególnych kurierów |
Przykład:
"service":"T48",
Usługa płatności za pobraniem
COD musi zawierać dane takie jak kwota oraz rodzaj waluty. Możliwe waluty dla danych kurierów są przedstawione w ich szczegółowych opisach.
Nazwa pola | Typ | Wymagane | Opis |
---|---|---|---|
amount | float(10,2) | Tak, jeśli dodajemy płatność za pobraniem |
Kwota |
currency | string(3) | Tak, jeśli dodajemy płatność za pobraniem |
Waluta |
Przykład:
"cod":{ "amount": 100, "currency": "EUR" }
Ubezpieczenie
Insurance musi zawierać dane takie jak kwota oraz rodzaj waluty. Możliwe waluty dla danych kurierów są przedstawione w ich szczegółowych opisach.
Nazwa pola | Typ | Wymagane | Opis |
---|---|---|---|
amount | float(10,2) | Tak, jeśli dodajemy ubezpieczenie |
Kwota |
currency | string(3) | Tak, jeśli dodajemy ubezpieczenie |
Waluta |
description | string(255) | Tak, jeśli dodajemy ubezpieczenie |
Opis |
Przykład:
"insurance":{ "description": "", "amount": 100, "currency": "EUR" }
Opis
Istnieje możliwość opisu paczki, przy danych kurierach opis będzie wyświetlany na etykiecie.
Nazwa pola | Typ | Wymagane | Opis |
---|---|---|---|
shipmentDescription1 | string(255) | Nie |
Opis paczki |
shipmentDescription2 | string(255) | Nie |
Dodatkowy opis paczki |
Przykład:
"shipmentDescription1":"Car parts", "shipmentDescription2":""
II. Przykładowe żądanie
{ "userName":"username", "password":"password", "CreateShipmentsRequest002":{ "shipmentType":"Delivery", "carrierName":"DE-DHL", "shipperAddress":{ "additionalDescription":"description" }, "receiverAddress":{ "nameOrCompany":"Kathleen", "additionalDescription":"", "address1":"Packstation 131", "address2":"903729505", "city":"Weil am Rhein", "zipCode":"79576", "region":"", "country":"DE", "email":"test@email.com", "phone":"123456765", "taxId":"", "pickupId": null }, "payerAddress":null, "items":[ { "referenceID":"GoLabel00001", "referenceID2":"", "type":"NP", "weight":"1" }, { "referenceID":"GoLabel00002", "referenceID2":"", "type":"NP", "weight":"2.5" } ], "serviceLevel":{ "service":"DST", "cod":null, "insurance":null }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
III. Struktura odpowiedzi
Status
Status wysłanego żądania. Możliwe wartości:
- “OK” - żądanie przyjęte pomyślnie
- “Error” - żądanie nie zostało przyjęte, żądanie wymaga modyfikacji
Message
Komunikat o błędzie lub dodatkowe informacje związane z wysyłką
Przykład:
"message": { "uid": 14, "code": "E1108", "content": "The specified combination of the full zipCode and city could not be validated" }
Reponses
Tablica zawierające informacje zwrotne dla poszczególnej paczki. W przypadku gdy jedna paczka nie posiada żadnych błędów, natomiast druga tak, nie zostaje utworzona żadna z nich.
Przykład:
"responses": [ { "referenceID": "GoLabel00001", "created": "2019-02-12", "message": { "uid": 46, "code": "G0032", "content": "ReferenceID already used." }, "status": "Error", "id": 22674 }, { "referenceID": "GoLabel00002", "created": "2019-02-12", "status": "OK", "barcode": "123123123123", "tracking_number": "123123123", "id": 22675, "message": null } ],
IV. Przykład odpowiedzi
{ "responses": [ { "referenceID": "GoLabel00004", "created": "2019-02-12", "message": { "uid": 46, "code": "G0032", "content": "ReferenceID already used." }, "status": "Error", "id": 22674 }, { "referenceID": "GoLabel00005", "created": "2019-02-12", "status": "OK", "barcode": "WW123123123123", "tracking_number": "WW123123123", "id": 22675, "message": null } ], "status": "Error", "message": { "uid": 46, "code": "G0032", "content": "ReferenceID already used." } }
1.2 GetLabel
Metoda umożliwia pobieranie pojedynczych lub zbiorczych etykiet wysyłkowych z systemu. Wykonanie tego żądania wymagane jest by paczka pojawiła się w systemie danego kuriera. Etykiety mogą być generowane w różnych formatach oraz rozmiarach.
Adres na który wysyłamy żądanie:
- produkcyjny: https://gorest.goglobal24.com/get-label
- testowy: http://test-gorest.goglobal24.com/get-label
I. Struktura żądania
Autoryzacja
Struktura autoryzacji jest wymagana we wszystkich żądaniach. Istnieją dwa sposoby przejścia przez autoryzację w GoLabel REST API. Pierwszym jest podanie hasła oraz nazwy użytkownika, natomiast drugim jest hash użytkownika. Dane te są dostarczane przez administratorów GoLabel.
"hash": "{TwójHash}", "userName": "{TwojaNazwaUżytkownika}", "password": "{TwojeHasło}",
GetLabelRequest
Właściwa część żądania, w niej zawarte są najważniejsze informacje.
Nazwa pola | Typ | Wymagane | Opis |
---|---|---|---|
referenceID | string(35) | Tak |
Niepowtarzalny numer referencyjny zamówienia dla danego klienta. |
collectiveLabel | integer(1) | Tak |
Możliwe wartości:
|
labelFormat | string(3) | Tak |
Format etykiety. Możliwe wartości: PDF, SVG, JPG |
labelSize | string(2) | Tak |
Rozmiar etykiety. Możliwe wartości: A6, A4, A3 |
II. Przykładowe żądanie
{ "userName": "username", "password": "password", "GetLabelRequest": { "referenceID": "GoLabel00001", "collectiveLabel": 1, "labelFormat": "PDF", "labelSize": "A4" } }
III. Struktura odpowiedzi
Status
Status wysłanego żądania. Możliwe wartości:
- “OK” - żądanie przyjęte pomyślnie
- ‘Error” - żądanie nie zostało przyjęte, żądanie wymaga modyfikacji
Message
Komunikat o błędzie.
Przykład:
"message": { "uid": 48, "code": "G0029", "content": "Incorrect labelFormat." }
Reponses
Tablica zawierające informacje zwrotne dla poszczególnej paczki.
Nazwa | Opis |
---|---|
referenceID |
Niepowtarzalny numer referencyjny zamówienia dla danego klienta. |
labelData |
Dane binarne (Base64) zawierające link do pobrania etykiety. |
status |
Status etykiety Możliwe wartości:
|
labelFormat |
Format etykiety. |
trackingNo |
Numer śledzenia paczki u wybranego kuriera. |
IV. Przykład odpowiedzi
{ "responses": [ { "referenceID": "GoLabel00001", "labelData": "aHR0cHM6Ly9sYWJlbC5nb2dsb2JhbDI0LmNvbS9mMWFiZDY3MDM1OGUwMzZjMzEyOTZlNjZiM2I2NmMzODJhYzAwODEyLzQxZDA4Nzc4YzNmYjgyNTkxNjgxODdlMTBmZWI4MDEzNDhmMWY0MGVtZ2jduywe", "status": "OK", "labelFormat": "PDF", "trackingNo": "TT008242375GB" }, { "referenceID": "GoLabel00002", "labelData": "aHR0cHM6Ly9sYWJlbC5nb2dsb2JhbDI0LmNvbS9mMWFiZDY3MDM1OGUwMzZjMzEyOTZlNjZiM2I2NmMzODJidmrsODEyLzQxZDA4Nzc4YzNmYjgyNTkxNjgxODdlMTBmZWI4MDEzNDhmMWY0MGVtZ2jduywe", "status": "OK", "labelFormat": "PDF", "trackingNo": "TT008242389GB" } ] }
1.3 Wiadomości błędów
Kod błędu | Opis błędu |
---|---|
G9003 | Authentication failed |
E1084 | shipmentType is a required field |
E1085 | The shipmentType specified is not valid |
E1087 | service is a required field |
E1088 | The service specified is not valid |
E1099 | Address zipCode does not match the stored Returns address |
E1100 | zipCode is a required field for domestic services |
E1101 | nameOrCompany is a required field |
E1102 | address1 is a required field |
E1103 | city is a required field |
E1104 | The country specified is not valid |
E1106 | The country is not valid for the specified Service |
E1107 | The specified combination of the partial zipCode and city could not be validated |
E1108 | The address hasn\'t been recognized please check the correctness of the postal code |
E1110 | The phone specified contained too many characters |
E1111 | The email specified was too long |
E1113 | Invalid email |
E1117 | Weight must be a positive number with max 10 digits and 3 fraction digits |
E1118 | You must enter the Postnummer (PostNumber) in the address2 field if the place of delivery is a Packstation. |
E1119 | If you choose a Packstation, you can only enter 'Packstation' and a number in the address1 field, e.g. 'Packstation 123'. |
G0002 | 2 Invalid userName and password format. Values may not be empty and are case-sensitive. |
G0004 | 4 Not proper length of given value. |
G0005 | 5 There is no default courier set for this partner. |
G0006 | 6 Float value of given value need to be greater than 0. |
G0007 | 7 Integer value of given value need to be greater than 0. |
G0008 | 8 Missing parcel type - either fill in element in type (PackageType structure) in XML or set up default parcel size in Global24 system. |
G0009 | 9 Missing parcel weight - either fill in element in weight (PackageType structure) in XML or set up default weight in Global24 system. |
G0010 | 10 Default courier service does not match API service. |
G0011 | 11 COD not available with selected service. |
G0012 | 12 Insurance not available with selected service. |
G0013 | 13 Service combination is Not Applicable. |
G0014 | 14 ShipmentType does not match possible combinations. |
G0015 | 15 CarrierName does not match possible combinations. |
G0016 | 16 Order cannot be modified. |
G0017 | 17 Cannot modify order that is being processed by system. |
G0018 | 18 Need at least one item of PackageType. |
G0019 | 19 Array needs to contain items of proper type. |
G0020 | 20 Missing default carrier name. |
G0031 | Specified carrierName is not valid. |
G0101 | 101 Not proper ISO 3166-1 format of Country code. |
G0102 | 102 Country code seems not to be supported by our system. Please contact administrator. |
G0202 | 202 Unknown error. If appears contact Global24 administrator. |
G0105 | 105 Missing service level - either fill in element in service (ServiceLevel structure) in XML or set up default service in Global24 system. |
G0021 | 21 Collective label value needs to be either 0 or 1. |
G0022 | 22 There is no order with given referenceId. |
G0200 | 200 Label is being created. |
G0201 | 201 Order with given reference has been removed. |
G0032 | ReferenceID already used. |
G0021 | 21 Collective label value needs to be either 0 or 1. |
G0029 | Incorrect labelFormat. |
G0030 | Incorrect labelSize. |
G9002 | Service temporarily unavailable. |
G9001 | Service unavailable |
G9004 | Not proper soap endpoint. |
G0033 | No more 1D ranges available for selected service. |
G0034 | No more 2D ranges available. |
G0035 | Email cannot be blank. |
G0036 | Country is required field. |
G0037 | ReferenceId is required. |
G0038 | Specified package type is not valid. |
G0039 | Specified weight is not alllowed for selected service. |
G0040 | Please fill in collectiveLabel field. |
G0041 | Not proper value of NameOrCompany field. |
G0042 | Not proper value of additionalDescription field. |
G0043 | Not proper value of address field. |
G0044 | Not proper value of city or region field. |
G0045 | Not proper value of zipCode field. |
G0046 | Not proper value of email field. |
G0047 | Not proper value of phone field. |
G0048 | Not proper value of taxId field. |
G0049 | Not proper value of referenceID or referenceID2 fields. |
G0023 | 23 COD service is not available. Please contact system Administrator. |
G0024 | 24 High Insurance service is not available. Please contact system Administrator. |
G0013 | 13 Service combination is Not Applicable. |
E1099 | Address zipCode does not match the stored Returns address |
G0050 | Shipper address is obligatory for Return. |
D0001 | Dispatch depot cannot be found. |
D0002 | Routing info cannot be saved. |
D0003 | Delivery address do not exists in DHL address database. Please change the address or contact Global24 Customer Service Support. |
G0051 | Product price must be a number. |
G0203 | Option unavailable on test instance. |
2. Kurierzy
2.1 Royal Mail
I. Dostępne serwisy
Nazwa serwisu | Wartość w GoLabel | Rodzaj przesyłki |
---|---|---|
Royal Mail "Untracked 24" | U24 | Delivery |
Royal Mail "Untracked 48" | U48 | Delivery |
Royal Mail "Tracked 24" | T24 | Delivery |
Royal Mail "Tracked 48" | T48 | Delivery |
Royal Mail "Tracked Returns 24" | R24 | Return |
Royal Mail "Tracked Returns 48" | R48 | Return |
Royal Mail "TRACKED 24 SIGN FOR" | S24 | Delivery |
Royal Mail "TRACKED 48 SIGN FOR" | S48 | Delivery |
II. Dostępne typy
Nazwa typu | Wartość w GoLabel | Dla seriwsów |
---|---|---|
Royal Mail "Royal Parcel" | RP | S24, S48, T24, T48, R24, R48 |
Royal Mail "Royal Letter" | RL | U24, U48 |
Pozostawione puste pole spowoduje wpisanie wartości domyślnych. Dla serwisów U24 i U48 będzie to wartość RL, dla pozostałych RP.
III. Waga
Serwis | Typ | Maksymalna waga |
---|---|---|
U24, U48 | RL | 0.75 |
R48 | RP | 5.00 |
R24, T24, T48, S24, S48 | RP | 20.00 |
Pozostawione puste pole spowoduje wpisanie wartości 1.00.
IV. Ubezpieczenie
Serwis niedostępny dla tego kuriera.
V. Usługa płatności za pobraniem (COD)
Serwis niedostępny dla tego kuriera.
VI. Dodatkowe informacje
Untracked
Serwisy U24 i U48 nie posiadają w RoyalMail własnego numeru śledzenia, dlatego też w systemie GoLabel został dodany własny numer - przykładowo 0044154;0038643.
VII. Przykłady żądań
CreateShipment - Delivery
{ "userName": "username", "password": "password", "CreateShipmentsRequest002": { "shipmentType": "Delivery", "carrierName": "GB-ROYALMAIL", "shipperAddress": { "additionalDescription": "description" }, "receiverAddress": { "nameOrCompany": "Birmingham Hippodrome", "additionalDescription": "description", "address1": "Hurst Street", "address2": "Southside", "city": "Birmingham", "zipCode": "B5 4TB", "region": "", "country": "GB", "email": "test@email.com", "phone": "123456765", "taxId": "", "pickupId": null }, "invoiceNumber": "TT100/12/01/001", "orderValue": 100.50, "currency": "EUR", "payerAddress": null, "items": [ { "referenceID": "GoLabel00010", "referenceID2": "", "type": "RP", "weight": "2.50", "products": [ { "name": "turbocharger v1.3", "number": "458152587412584", "quantity": "1", "price": 80.50, "tariffCode": "85044030", "originCountry": "DE", "imageUrl": null } ] } ], "serviceLevel": { "service": "T48" }, "shipmentDescription1": "description", "shipmentDescription2": "" } }
CreateShipment - Return
{ "userName": "userName", "password": "password", "CreateShipmentsRequest002":{ "shipmentType":"Return", "carrierName":"GB-ROYALMAIL", "shipperAddress": { "nameOrCompany":"Birmingham Hippodrome", "additionalDescription":"", "address1":"Hurst Street", "address2":"Southside", "city":"Birmingham", "zipCode":"B5 4TB", "region":"", "country":"GB", "email":"test@email.com", "phone":"123456765", "taxId":"", "pickupId":null }, "receiverAddress":{ "additionalDescription":"description" }, "invoiceNumber": "TT100/12/01/001", "orderValue": 100.50, "currency": "EUR", "payerAddress":null, "items":[ { "referenceID":"GoLabel000011", "referenceID2":"", "type":"RP", "weight":"2.50", "products": [ { "name": "turbocharger v1.3", "number": "458152587412584", "quantity": "1", "price": 80.50, "tariffCode": "85044030", "originCountry": "DE", "imageUrl": null } ] } ], "serviceLevel":{ "service":"R48" }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
GetLabel
{ "userName": "username", "password": "password", "GetLabelRequest": { "referenceID": "GoLabel00010", "collectiveLabel": 0, "labelFormat": "PDF", "labelSize": "A4" } }
2.2 Colissimo
I. Dostępne serwisy
Nazwa serwisu | Wartość w GoLabel | Rodzaj przesyłki |
---|---|---|
Colissimo "Standard Tracked" | STC | Delivery, Return |
Colissimo "Standard Proof of Delivery" | SPO | Delivery, Return |
Colissimo "Standard Pick-Up" | SPU | Delivery |
II. Dostępne typy
Nazwa typu | Wartość w GoLabel | Dla seriwsów |
---|---|---|
Colissimo Small (Maksymalne wymiary: długość + szerokość + wysokość < 150 cm) | CS | STC, SPO, SPU |
Colissimo Regular (Maksymalne wymiary: długość + szerokość + wysokość < 200 cm) | CR | STC, SPO, SPU |
Pozostawione puste pole spowoduje wpisanie wartości CS.
III. Waga
Serwis | Typ | Maksymalna waga |
---|---|---|
STC, SPO, SPU | CS | 30.00 |
STC, SPO, SPU | CR | 30.00 |
Pozostawione puste pole spowoduje wpisanie wartości 1.00.
IV. Ubezpieczenie
Jedyną walutą obsługiwaną przez Colissimo jest EUR, a maksymalna wartość to 1500.
V. Usługa płatności za pobraniem (COD)
Jedyną walutą obsługiwaną przez Colissimo jest EUR, a maksymalna wartość to 1500.
VI. Dodatkowe informacje
Brak
VII. Przykłady żądań
CreateShipment - Delivery
{ "userName":"username", "password":"password", "CreateShipmentsRequest002":{ "shipmentType":"Delivery", "carrierName":"FR-COLISSIMO", "shipperAddress":{ "additionalDescription":"description" }, "receiverAddress":{ "nameOrCompany":"Lucas About", "additionalDescription":"", "address1":"17 Rue Baron le Roy", "address2":"", "city":"Paris", "zipCode":"75012", "region":"", "country":"FR", "email":"test@email.com", "phone":"123456765", "taxId":"", "pickupId": null }, "payerAddress":null, "items":[ { "referenceID":"GoLabel000013", "referenceID2":"", "type":"CS", "weight":"1.00" } ], "serviceLevel":{ "service":"STC", "cod":null, "insurance":null }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
GetLabel
{ "userName": "username", "password": "password", "GetLabelRequest": { "referenceID": "GoLabel000013", "collectiveLabel": 0, "labelFormat": "PDF", "labelSize": "A4" } }
2.3 DPD
I. Dostępne serwisy
Nazwa serwisu | Wartość w GoLabel | Rodzaj przesyłki |
---|---|---|
DPD "Standard Tracked" | STT | Delivery |
DPD "Next Day 12" | E12 | Delivery |
DPD "Next Day 18" | E18 | Delivery |
DPD "Next Day 12 Saturday Delivery" | NE6 | Delivery |
DPD “Return” | STT | Return |
II. Dostępne typy
Nazwa typu | Wartość w GoLabel | Dla seriwsów |
---|---|---|
DPD Small (Paczka o maksymalnej objętości 111 cm) | KP | STT, E12, E18, NE6 |
DPD Regular (Paczka o maksymalnej objętości 300 cm) | NP | STT, E12, E18, NE6 |
Pozostawione puste pole spowoduje wpisanie wartości KP.
III. Waga
Serwis | Typ | Maksymalna waga |
---|---|---|
STT, E12, E18, NE6 | KP | 20.00 |
STT, E12, E18, NE6 | NP | 20.00 |
Pozostawione puste pole spowoduje wpisanie wartości 1.00.
IV. Ubezpieczenie
Serwis dostępny dla tego kuriera.
V. Usługa płatności za pobraniem (COD)
Serwis dostępny dla tego kuriera.
VI. Dodatkowe informacje
Return
DPD przy zwrotach tworzy dwie etykiety, dlatego też przy metodzie getLabel zwracane są dwa zakodowane linki.
VII. Przykłady żądań
CreateShipment - Delivery
{ "userName":"username", "password":"password", "CreateShipmentsRequest002":{ "shipmentType":"Delivery", "carrierName":"DE-DPD", "shipperAddress":{ "additionalDescription":"description" }, "receiverAddress":{ "nameOrCompany":"John Smith", "additionalDescription":"description", "address1":"Oldenburger Ring 3", "address2":"","city":"Markersdorf", "zipCode":"02829", "region":"", "country":"DE", "email":"john@smith.com", "phone":"", "taxId":"", "pickupId":null }, "payerAddress":null, "items":[ { "referenceID":"GoLabel000011", "referenceID2":"", "type":"NP", "weight":"1.00" } ], "serviceLevel":{ "service":"STT", "cod":null, "insurance":null }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
CreateShipment - Return
{ "userName": "userName", "password": "password", "CreateShipmentsRequest002":{ "shipmentType":"Return", "carrierName":"DE-DPD", "shipperAddress": { "nameOrCompany":"John Smith", "additionalDescription":"description", "address1":"Oldenburger Ring 3", "address2":"", "city":"Markersdorf", "zipCode":"02829", "region":"", "country":"DE", "email":"john@smith.com", "phone":"", "taxId":"" }, "receiverAddress":{ "additionalDescription":"description" }, "payerAddress":null, "items":[ { "referenceID":"GoLabel00012", "referenceID2":"", "type":"NP", "weight":"1.00" } ], "serviceLevel":{ "service":"STT" }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
GetLabel
{ "userName": "username", "password": "password", "GetLabelRequest": { "referenceID": "GoLabel000011", "collectiveLabel": 0, "labelFormat": "PDF", "labelSize": "A4" } }
2.4 DHL
I. Dostępne serwisy
Nazwa serwisu | Wartość w GoLabel | Rodzaj przesyłki |
---|---|---|
DHL Standard | DST | Delivery, Return |
DHL Packstation | DST | Delivery |
DHL Postfiliale | DST | Delivery |
DHL Warenpost | WAR | Delivery |
Serwisy DHL w systemie GoLabel odróżniane są za pomocą wpisanych danych w polu address1. Przykładowo gdy chcemy wybrać Packstation wpisujemy tę frazę wraz z numerem paczkomatu.
Przykład:
“address1”: “Packstation 131”,
II. Dostępne typy
Nazwa typu | Wartość w GoLabel | Dla seriwsów |
---|---|---|
DHL Standard | NP | DST |
DHL Warenpost | NP | WAR |
Pozostawione puste pole spowoduje wpisanie wartości NP.
III. Waga
Serwis | Typ | Maksymalna waga |
---|---|---|
DST | NP | 31.50 |
WAR | NP | 1.00 |
Pozostawione puste pole spowoduje wpisanie wartości 1.00.
IV. Ubezpieczenie
Serwis niedostępny dla tego kuriera.
V. Usługa płatności za pobraniem (COD)
Jedyną walutą obsługiwaną przez DHL jest EUR. Możliwe wszystkie konta bankowe z obszaru SEPA.
Nazwa pola | Typ | Wymagane | Opis |
---|---|---|---|
amount | float(10,2) | Tak |
Kwota |
currency | string(3) | Tak |
Waluta |
bankAccountOwner | string(100) | Nie |
Właściciel konta bankowego |
bankName | string(100) | Nie |
Nazwa banku |
bankAccountNumber | string(60) | Nie |
Numer IBAN |
bic | string(11) | Nie |
Kod BIC/SWIFT (8 lub 11 znaków) |
Przykład:
"cod":{ "amount": 100, "currency": "EUR", "bankAccountOwner": "Test Company", "bankName": "Deutsche Bank", "bankAccountNumber": "DE12345678901234567890", "bic": "DEUTDEHHXXX" }
W przypadku nie podania danych konta bankowego, zostaną one uzupełnione danymi konta bankowego dla COD DHL z profilu Global24 użytkownika.
VI. Dodatkowe informacje
Paczki międzynarodowe
Istnieje możliwość tworzenia paczek międzynadorowych dla DHL
Nazwa dodatkowa
Dopuszczalna ilość znaków w pozycji additionalDescription w adresie nadawcy (w przypadku shipmentType: Delivery) oraz adres odbiorcy (w przypadku shipmentType: Return) wynosi 5 znaków.
Packstation
W przypadku wyboru Packstation należy w polu address1 podać "Packstation" oraz numer paczkomatu, np. "Packstation 131", natomiast w polu address2 obowiązkowo musi znaleźć się numer pocztowy (Postnummer).
VII. Przykłady żądań
CreateShipment - Delivery
{ "userName":"username", "password":"password", "CreateShipmentsRequest002":{ "shipmentType":"Delivery", "carrierName":"DE-DHL", "shipperAddress":{ "additionalDescription":"description" }, "receiverAddress":{ "nameOrCompany":"Kathleen", "additionalDescription":"", "address1":"Packstation 131", "address2":"903729505", "city":"Weil am Rhein", "zipCode":"79576", "region":"", "country":"DE", "email":"test@email.com", "phone":"123456765", "taxId":"", "pickupId": null }, "payerAddress":null, "items":[ { "referenceID":"GoLabel000014", "referenceID2":"", "type":"NP", "weight":"1.00" } ], "serviceLevel":{ "service":"DST", "cod":null, "insurance":null }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
GetLabel
{ "userName": "username", "password": "password", "GetLabelRequest": { "referenceID": "GoLabel000014", "collectiveLabel": 0, "labelFormat": "PDF", "labelSize": "A4" } }
2.5 Fedex
I. Dostępne serwisy
Nazwa serwisu | Wartość w GoLabel | Rodzaj przesyłki |
---|---|---|
Fedex Standard | FST | Delivery |
II. Dostępne typy
Nazwa typu | Wartość w GoLabel | Dla seriwsów |
---|---|---|
Fedex Standard | PC | FST |
Pozostawione puste pole spowoduje wpisanie wartości "PC".
III. Waga
Serwis | Typ | Maksymalna waga |
---|---|---|
FST | PC | 30.00 |
Pozostawione puste pole spowoduje wpisanie wartości 1.00.
IV. Ubezpieczenie
Ubezpieczenie jest wymagane w przypadku korzystania z usługi płatności za pobaniem. Pole Opis (Insurance description) jest wymagane. Kwota ubezpieczneia musi być podna w walucie PLN oraz nie może być niższa niż kwota pobrania.
V. Usługa płatności za pobraniem (COD)
Jedyną walutą obsługiwaną przez Fedex jest PLN.
VI. Dodatkowe informacje
W przypadku użycia usługi płatności za pobraniem(COD) pole referneceID2 jest wymagane (należy podać w nim numer konta bankowego). Etykiety dla tego kuriera dostępne są tylko w formacie PDF i wielkości A4.
VII. Przykłady żądań
CreateShipment - Delivery
{ "userName":"username", "password":"password", "CreateShipmentsRequest002":{ "shipmentType":"Delivery", "carrierName":"PL-FEDEX", "receiverAddress":{ "nameOrCompany":"Jan Nowak", "address1":"Stara 4", "address2":"", "city":"Karwiany", "zipCode":"52-200", "region":"", "country":"PL", "email":"test@email.com", "phone":"123456765", "taxId":"", "pickupId": null }, "payerAddress":null, "items":[ { "referenceID":"GoLabel000014", "referenceID2":"", "type":"PC", "weight":"1.00" } ], "serviceLevel":{ "service":"FST", "cod":null, "insurance":null }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
GetLabel
{ "userName": "username", "password": "password", "GetLabelRequest": { "referenceID": "GoLabel000014", "collectiveLabel": 0, "labelFormat": "PDF", "labelSize": "A4" } }
2.6 Parcel Post
I. Dostępne serwisy
Nazwa serwisu | Wartość w GoLabel | Rodzaj przesyłki |
---|---|---|
Parcel Post | PP | Delivery |
II. Dostępne typy
Nazwa typu | Wartość w GoLabel | Dla seriwsów |
---|---|---|
Regular | NP | PP |
Pozostawione puste pole spowoduje wpisanie wartości NP.
III. Waga
Serwis | Typ | Maksymalna waga |
---|---|---|
PP | NP | 20.00 |
Pozostawione puste pole spowoduje wpisanie wartości 1.00.
IV. Ubezpieczenie
Serwis niedostępny dla tego kuriera.
V. Usługa płatności za pobraniem (COD)
Serwis niedostępny dla tego kuriera.
VI. Dodatkowe informacje
Return
Przesyłka pocztowa
VII. Przykłady żądań
CreateShipment - Delivery
{ "userName":"username", "password":"password", "CreateShipmentsRequest002":{ "shipmentType":"Delivery", "carrierName":"Parcel Post", "shipperAddress":{ "additionalDescription":"description" }, "receiverAddress":{ "nameOrCompany":"John Smith", "additionalDescription":"description", "address1":"Oldenburger Ring 3", "address2":"","city":"Markersdorf", "zipCode":"02829", "region":"", "country":"DE", "email":"john@smith.com", "phone":"", "taxId":"", "pickupId":null }, "payerAddress":null, "items":[ { "referenceID":"GoLabel000011", "referenceID2":"", "type":"NP", "weight":"1.00" } ], "serviceLevel":{ "service":"PP", "cod":null, "insurance":null }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
GetLabel
{ "userName": "username", "password": "password", "GetLabelRequest": { "referenceID": "GoLabel000011", "collectiveLabel": 0, "labelFormat": "PDF", "labelSize": "A4" } }
2.7 Post AT
I. Dostępne serwisy
Nazwa serwisu | Wartość w GoLabel | Rodzaj przesyłki |
---|---|---|
Austrian Post Standard | APS | Delivery |
Austrian Post "Return" | APS | Return |
II. Dostępne typy
Nazwa typu | Wartość w GoLabel | Dla seriwsów |
---|---|---|
Austrian Post Standard | AP | APS |
Pozostawione puste pole spowoduje wpisanie wartości AP.
III. Waga
Serwis | Typ | Maksymalna waga |
---|---|---|
APS | AP | 31.5 |
IV. Ubezpieczenie
Serwis niedostępny dla tego kuriera.
V. Usługa płatności za pobraniem (COD)
Serwis niedostępny dla tego kuriera.
VI. Dodatkowe informacje
VII. Przykłady żądań
CreateShipment - Delivery
{ "userName":"username", "password":"password", "CreateShipmentsRequest002":{ "shipmentType":"Delivery", "carrierName":"POST-AT", "receiverAddress":{ "nameOrCompany":"Alexis Trintignant", "additionalDescription":"", "address1":"Teststrasse", "address2":"", "city":"Wien", "zipCode":"1030", "region":"", "country":"AT", "email":"test@email.com", "phone":"+33123456765", "taxId":"", "pickupId": null }, "payerAddress":null, "items":[ { "referenceID":"GoLabel000014", "referenceID2":"", "type":"AP", "weight":"1" } ], "serviceLevel":{ "service":"APS", "cod":null, "insurance":null }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
CreateShipment - Return
{ "userName": "userName", "password": "password", "CreateShipmentsRequest002":{ "shipmentType":"Return", "carrierName":"POST-AT", "shipperAddress": { "nameOrCompany":"Alexis Trintignant", "additionalDescription":"", "address1":"Teststrasse", "address2":"", "city":"Wien", "zipCode":"1030", "region":"", "country":"AT", "email":"test@email.com", "phone":"+33123456765", "taxId":"", "pickupId": null }, "receiverAddress":{ "additionalDescription":"description" }, "payerAddress":null, "items":[ { "referenceID":"GoLabel00015", "referenceID2":"", "type":"AP", "weight":"31.5" } ], "serviceLevel":{ "service":"APS" }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
GetLabel
{ "userName": "username", "password": "password", "GetLabelRequest": { "referenceID": "GoLabel000014", "collectiveLabel": 0, "labelFormat": "PDF", "labelSize": "A4" } }
2.8 GLS-IT
I. Dostępne serwisy
Nazwa serwisu | Wartość w GoLabel | Rodzaj przesyłki |
---|---|---|
GLS Standard | GLI | Delivery |
II. Dostępne typy
Nazwa typu | Wartość w GoLabel | Dla seriwsów |
---|---|---|
GLS Standard | GLI | ST |
Pozostawione puste pole spowoduje wpisanie wartości "ST".
III. Waga
Serwis | Typ | Maksymalna waga |
---|---|---|
GLI | ST | 30 |
IV. Ubezpieczenie
Serwis niedostępny dla tego kuriera.
V. Usługa płatności za pobraniem (COD)
Serwis niedostępny dla tego kuriera.
VI. Dodatkowe informacje
VII. Przykłady żądań
CreateShipment - Delivery
{ "userName":"username", "password":"password", "CreateShipmentsRequest002":{ "shipmentType":"Delivery", "carrierName":"GLS-IT", "receiverAddress":{ "nameOrCompany": "Test Company", "address1": "Piazza del Colosseo, 1", "address2": "", "city": "Roma", "zipCode": "00184", "region": "", "country": "IT", "email": "email@email.com", "phone": "123456765", "taxId": "", "pickupId": null }, "payerAddress":null, "items":[ { "referenceID":"GoLabel000014", "referenceID2":"", "type":"ST", "weight":"1" } ], "serviceLevel":{ "service":"GLI", "cod":null, "insurance":null }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
GetLabel
{ "userName": "username", "password": "password", "GetLabelRequest": { "referenceID": "GoLabel000014", "collectiveLabel": 0, "labelFormat": "PDF", "labelSize": "A4" } }
2.9 Correos
I. Dostępne serwisy
Nazwa serwisu | Wartość w GoLabel | Rodzaj przesyłki |
---|---|---|
Correos "Standard" | CST | Delivery |
Correos "Premium" | CPM | Delivery |
Correos "Return" | CRT | Return |
II. Dostępne typy
Nazwa typu | Wartość w GoLabel | Dla seriwsów |
---|---|---|
Correos Standard | ST | CST, CPM, CRT |
Pozostawione puste pole spowoduje wpisanie wartości ST.
III. Waga
Serwis | Typ | Maksymalna waga |
---|---|---|
CST, CPM, CRT | ST | 30.00 |
Pozostawione puste pole spowoduje wpisanie wartości 1.00.
IV. Ubezpieczenie
Serwis niedostępny dla tego kuriera.
V. Usługa płatności za pobraniem (COD)
Serwis niedostępny dla tego kuriera.
VI. Dodatkowe informacje
VII. Przykłady żądań
CreateShipment - Delivery
{ "userName":"username", "password":"password", "CreateShipmentsRequest002":{ "shipmentType":"Delivery", "carrierName":"ES-CORREOS", "shipperAddress":{ "additionalDescription":"description" }, "receiverAddress":{ "nameOrCompany":"John Smith", "additionalDescription":"description", "address1":"Calle Albacete 27", "address2":"PORTE 0012", "city":"Yuncosd", "zipCode":"45210", "region":"", "country":"ES", "email":"info@global24.com", "phone":"+48603040604", "taxId":"", "pickupId": null }, "payerAddress":null, "items":[ { "referenceID":"GoLabel000011", "referenceID2":"", "type":"ST", "weight":"1.00" } ], "serviceLevel":{ "service":"CST", "cod":null, "insurance":null }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
CreateShipment - Return
{ "userName": "userName", "password": "password", "CreateShipmentsRequest002":{ "shipmentType":"Return", "carrierName":"ES-CORREOS", "shipperAddress": { "nameOrCompany":"John Smith", "additionalDescription":"description", "address1":"Calle Albacete 27", "address2":"PORTE 0012", "city":"Yuncosd", "zipCode":"45210", "region":"", "country":"ES", "email":"info@global24.com", "phone":"+48603040604", "taxId":"", "pickupId": null }, "receiverAddress":{ "additionalDescription":"description" }, "payerAddress":null, "items":[ { "referenceID":"GoLabel00012", "referenceID2":"", "type":"ST", "weight":"1.00" } ], "serviceLevel":{ "service":"CRT" }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
GetLabel
{ "userName": "username", "password": "password", "GetLabelRequest": { "referenceID": "GoLabel000011", "collectiveLabel": 0, "labelFormat": "PDF", "labelSize": "A4" } }
2.10 Hermes
I. Dostępne serwisy
Nazwa serwisu | Wartość w GoLabel | Rodzaj przesyłki |
---|---|---|
Hermes "Standard" | HST | Delivery |
Hermes "Hermes Tracked 24" | H24 | Delivery |
Hermes "Standard SignFor" | HSS | Delivery |
Hermes "Hermes Tracked 24 SignFor" | H2S | Delivery |
II. Dostępne typy
Nazwa typu | Wartość w GoLabel | Dla seriwsów |
---|---|---|
Hermes Standard | ST | HST, H24, HSS, H2S |
Pozostawione puste pole spowoduje wpisanie wartości ST.
III. Waga
Serwis | Typ | Maksymalna waga |
---|---|---|
HST, H24, HSS, H2S | ST | 15 |
Pozostawione puste pole spowoduje wpisanie wartości 1.00.
IV. Ubezpieczenie
Serwis niedostępny dla tego kuriera.
V. Usługa płatności za pobraniem (COD)
Serwis niedostępny dla tego kuriera.
VI. Dodatkowe informacje
VII. Przykłady żądań
CreateShipment - Delivery
{ "userName":"username", "password":"password", "CreateShipmentsRequest002": { "shipmentType": "Delivery", "carrierName": "GB-HERMES", "shipperAddress": { }, "receiverAddress": { "nameOrCompany": "Test Company", "additionalDescription": "", "address1": "103 Gatliff Rd", "address2": "", "city": "London", "zipCode": "SW1W 8BA", "region": "", "country": "GB", "email": "email@email.com", "phone": "123456765", "taxId": "", "pickupId": null }, "invoiceNumber": "TT100/12/01/001", "orderValue": 500.50, "currency": "EUR", "payerAddress": null, "items":[ { "referenceID":"GoLabel000011", "referenceID2":"", "type":"ST", "weight":"1", "products":[ { "name": "Giant turtle toy", "number": "458152587412584", "quantity": "2", "price": "20.45", "tariffCode": "95049080", "originCountry": "DE", "imageUrl": "url_to_photo.com" }, { "name": "exchaust", "number": "398155774553544", "quantity": "3", "price": "15.32", "tariffCode": "87141090", "originCountry": "DE", "imageUrl": "url_to_photo.com" } ] } ], "serviceLevel": { "service": "HST" }, "shipmentDescription1": "", "shipmentDescription2": "" } }
GetLabel
{ "userName": "username", "password": "password", "GetLabelRequest": { "referenceID": "GoLabel000011", "collectiveLabel": 0, "labelFormat": "PDF", "labelSize": "A4" } }
2.11 Post NL
I. Dostępne serwisy
Nazwa serwisu | Wartość w GoLabel | Rodzaj przesyłki |
---|---|---|
Post NL "Tracked" | PPHD | Delivery |
Post NL "Tracked Signature" | PPHDS | Delivery |
Post NL "Return" | PPHD | Return |
II. Dostępne typy
Nazwa typu | Wartość w GoLabel | Dla seriwsów |
---|---|---|
Post Standard | ST | PPHD, PPHDS |
Pozostawione puste pole spowoduje wpisanie wartości ST.
III. Waga
Serwis | Typ | Maksymalna waga |
---|---|---|
PPHD, PPHDS | ST | 30.00 |
Pozostawione puste pole spowoduje wpisanie wartości 1.00.
IV. Ubezpieczenie
Serwis niedostępny dla tego kuriera.
V. Usługa płatności za pobraniem (COD)
Serwis niedostępny dla tego kuriera.
VI. Dodatkowe informacje
VII. Przykłady żądań
CreateShipment - Delivery
{ "userName":"username", "password":"password", "CreateShipmentsRequest002":{ "shipmentType":"Delivery", "carrierName":"POST-NL", "shipperAddress":{ "additionalDescription":"description" }, "receiverAddress":{ "nameOrCompany":"John Smith", "additionalDescription":"description", "address1":"Prinses Beatrixlaan 23", "address2":"Floor 10", "city":"Den Haag", "zipCode":"2595AK", "region":"", "country":"NL", "email":"info@global24.com", "phone":"+48603040604", "taxId":"", "pickupId": null }, "payerAddress":null, "items":[ { "referenceID":"GoLabel000011", "referenceID2":"", "type":"ST", "weight":"1.00" } ], "serviceLevel":{ "service":"PPHD", "cod":null, "insurance":null }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
CreateShipment - Return
{ "userName": "userName", "password": "password", "CreateShipmentsRequest002":{ "shipmentType":"Return", "carrierName":"POST-NL", "shipperAddress": { "nameOrCompany":"John Smith", "additionalDescription":"description", "address1":"Prinses Beatrixlaan 23", "address2":"Floor 10", "city":"Den Haag", "zipCode":"2595AK", "region":"", "country":"NL", "email":"info@global24.com", "phone":"+48603040604", "taxId":"", "pickupId": null }, "receiverAddress":{ "additionalDescription":"description" }, "payerAddress":null, "items":[ { "referenceID":"GoLabel00012", "referenceID2":"", "type":"ST", "weight":"1.00" } ], "serviceLevel":{ "service":"PPHD" }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
GetLabel
{ "userName": "username", "password": "password", "GetLabelRequest": { "referenceID": "GoLabel000011", "collectiveLabel": 0, "labelFormat": "PDF", "labelSize": "A4" } }
2.12 Nova Poshta
I. Dostępne serwisy
Nazwa serwisu | Wartość w GoLabel | Rodzaj przesyłki |
---|---|---|
Nova Poshta Standard | NPS | Delivery |
II. Dostępne typy
Nazwa typu | Wartość w GoLabel | Dla seriwsów |
---|---|---|
Nova Poshta Regular | NR | NPS |
Pozostawione puste pole spowoduje wpisanie wartości NR.
III. Waga
Serwis | Typ | Maksymalna waga |
---|---|---|
NPS | NR | 30.00 |
Pozostawione puste pole spowoduje wpisanie wartości 1.00.
IV. Ubezpieczenie
Serwis niedostępny dla tego kuriera.
V. Usługa płatności za pobraniem (COD)
Jedyną walutą obsługiwaną przez Nova Poshta jest UAH.
VI. Dodatkowe informacje
Adres
Aktualnie możliwe jest wprowadzanie danych adresowych jedynie w języku ukraińskim (cyrylicą).
Odprawa exportowa
Przesyłki do Ukrainy objęte są odprawą exportową. Obowiązkowo należy wprowadzić numer faktury, wartość zamówienia oraz walutę (odpowiadającą walucie ceny przedmiotów), a także wprowadzić znajdujące się w paczce przedmioty, z uzupełnionymi polami: nazwa produktu, numer SKU, ilość, cena, kod taryfy celnej oraz kraj pochodzenia.
Zwroty
Nie ma możliwości samodzielnego generowania zwrotów. Odbiorca paczki może skorzystać z bezpłatnej opcji "Easy Return" w aplikacji Nova Poshta lub nadać paczkę bezpośrednio w oddziale Nova Poshta.
VII. Przykłady żądań
CreateShipment - Delivery
{ "userName":"username", "password":"password", "CreateShipmentsRequest002":{ "shipmentType":"Delivery", "carrierName":"UA-NOVA-POSHTA", "receiverAddress":{ "nameOrCompany":"Випробувальна компанія", "additionalDescription":"перший поверх", "address1":"Героїв України 1", "address2":"", "city":"Бровари", "zipCode":"07400", "region":"Волинська область", "country":"UA", "email":"test@email.com", "phone":"+380660000000", "taxId":"", "pickupId":null }, "invoiceNumber":"TT100/12/01/001", "orderValue":500.50, "currency":"UAH", "payerAddress":null, "items":[ { "referenceID":"NovaPoshta000001", "referenceID2":"", "type":"NR", "weight":"3.00", "products":[ { "name":"Giant turtle toy", "number":"458152587412584", "quantity":"2", "price":"20.45", "tariffCode":"95049080", "originCountry":"DE" }, { "name":"exchaust", "number":"398155774553544", "quantity":"3", "price":"15.32", "tariffCode":"87141090", "originCountry":"DE", "imageUrl":"url_to_photo.com" } ] } ], "serviceLevel":{ "service":"NPS", "cod":null, "insurance":null }, "shipmentDescription1":"description", "shipmentDescription2":"" } }
GetLabel
{ "userName":"username", "password":"password", "GetLabelRequest":{ "referenceID":"NovaPoshta000001", "collectiveLabel":0, "labelFormat":"PDF", "labelSize":"A4" } }
Tracking (metoda GET) - Pojedyńczo - TYMCZASOWO NIEDOSTĘPNE
Metoda pozwala na zwracanie statusu paczki w formacie JSON. Uwaga: nie wszystkie zwracane pola u kurierów zwierają dane.
Adres na który wysyłamy żądanie:
- produkcyjny: http://api.goglobal24.com/tracking
- testowy: http://test-goreturns-api.goglobal24.com/tracking
I. Struktura żądania
Przesyłane parametry
Nazwa pola | Typ | Wymagane | Opis |
---|---|---|---|
code | string | Tak |
Tracking code Nie powinnien zawierać znaków specjalnych |
last | string | Nie |
Wysłanie wartości "true" spowoduje zwrot tylko ostatniego statusu Domyślnie parametr przyjmuje wartość "false" |
II. Struktura odpowiedzi
Nazwa pola | Typ | Opis |
---|---|---|
success | boolean | |
message | string | Dostępny w przypadku gdy success: false |
trackingCourierUrl | string | Bezpośredni link do śledzenia u przewoźnika |
trackingCode | string | |
trackingData | array / if last true - object |
Element trackingData
Nazwa pola | Typ | Opis |
---|---|---|
zipCode | string | |
city | string | |
country | string | |
createdDate | string | |
status | string |
Możliwe wartości:
|
statusFull | string | Rozwinięty status od przewoźnika, w zależności od kuriera może występować w ojczystym języku |
note | string | |
courier | string | Nazwa przewoźnika od którego wpłynął status |
III. Przykłady
Przykładowe żądanie
http://api.goglobal24.com/tracking?code=00340434314501512185
Przykładowa poprawna odpowiedź
{ "success": true, "trackingCourierUrl": "https://www.royalmail.com/track-your-item#/tracking-results/KT338882630GB", "trackingCode": "KT338882630GB", "trackingData": [ { "zipCode": null, "city": "Olkusz", "country": "PL", "createdDate": "17/11/19 18:20", "status": "created", "statusFull": null, "note": null, "courier": "Global24" }, { "zipCode": null, "city": "Nowa Wieś Wrocławska", "country": "PL", "createdDate": "11/12/19 10:23", "status": "received", "statusFull": null, "note": null, "courier": "Global24" }, { "zipCode": null, "city": "Medway Mail Centre", "country": "GB", "createdDate": "13/12/19 10:12", "status": "carrier", "statusFull": "Item Received", "note": null, "courier": "GB-ROYALMAIL" }, { "zipCode": null, "city": "Home Counties North MC", "country": "GB", "createdDate": "14/12/19 00:12", "status": "carrier", "statusFull": "Item Received", "note": null, "courier": "GB-ROYALMAIL" }, { "zipCode": null, "city": "Hatfield AL DO", "country": "GB", "createdDate": "14/12/19 04:12", "status": "carrier", "statusFull": "Due to be delivered today", "note": null, "courier": "GB-ROYALMAIL" }, { "zipCode": null, "city": "Hatfield AL DO", "country": "GB", "createdDate": "14/12/19 10:12", "status": "delivered", "statusFull": "Delivered by", "note": null, "courier": "GB-ROYALMAIL" } ] }
Przykładowa błędna odpowiedź
{ "success": false, "message": "No result found for your code" }
Tracking (metoda GET) - Grupowo
Metoda pozwala na zwracanie ostatnich statusów w formacie JSON dla maksymalnie 100 kodów śledzenia. Uwaga: nie wszystkie zwracane pola u kurierów zwierają dane. Zwracane są tylko znalezione paczki.
Adres na który wysyłamy żądanie:
- produkcyjny: http://api.goglobal24.com/tracking/group
- testowy: http://test-goreturns-api.goglobal24.com/tracking/group
I. Struktura żądania
Przesyłane parametry
Nazwa pola | Typ | Wymagane | Opis |
---|---|---|---|
codes | string | Tak |
Tracking code Kody powinny być rodzielone przecinkiem |
II. Struktura odpowiedzi
Nazwa pola | Typ | Opis |
---|---|---|
success | boolean | |
message | string | Dostępny w przypadku gdy success: false |
data | array | |
data.trackingCourierUrl | string | Bezpośredni link do śledzenia u przewoźnika |
data.trackingCode | string | |
data.trackingData | object |
Element trackingData
Nazwa pola | Typ | Opis |
---|---|---|
zipCode | string | |
city | string | |
country | string | |
createdDate | string | |
status | string |
Możliwe wartości:
|
statusFull | string | Rozwinięty status od przewoźnika, w zależności od kuriera może występować w ojczystym języku |
note | string | |
courier | string | Nazwa przewoźnika od którego wpłynął status |
III. Przykłady
Przykładowe żądanie
http://api.goglobal24.com/tracking/group?codes=6A16061440938,00340434314501512185,00340434314502556980
Przykładowa poprawna odpowiedź
{ "success": true, "data": [ { "trackingCourierUrl": "https://www.dhl.de/en/privatkunden/pakete-empfangen/verfolgen.html?piececode=00340434314501512185&cid=dhlde", "trackingCode": "00340434314501512185", "trackingData": { "zipCode": null, "city": "Sölden", "country": "DE", "createdDate": "06/05/20 12:05", "status": "delivered", "statusFull": "The shipment has been successfully delivered", "note": null, "courier": "DE-DHL" } }, { "trackingCourierUrl": "https://www.dhl.de/en/privatkunden/pakete-empfangen/verfolgen.html?piececode=00340434314502556980&cid=dhlde", "trackingCode": "00340434314502556980", "trackingData": { "zipCode": null, "city": "Lublin", "country": "PL", "createdDate": "27/05/20 09:17", "status": "created", "statusFull": null, "note": null, "courier": "Global24" } }, { "trackingCourierUrl": "https://www.laposte.fr/outils/track-a-parcel?code=6A16061440938", "trackingCode": "6A16061440938", "trackingData": { "zipCode": null, "city": "Lublin", "country": "PL", "createdDate": "27/05/20 09:17", "status": "created", "statusFull": null, "note": null, "courier": "Global24" } } ] }
Przykładowa błędna odpowiedź
{ "success": false, "message": "Error message" }
Inventory (metoda GET)
Metoda pozwala na zwracanie stanów magazynowych aktywnych produktów użytownika.
Adres na który wysyłamy żądanie:
- produkcyjny: http://api.goglobal24.com/warehouse/status
- testowy: http://test-goreturns-api.goglobal24.com/warehouse/status
I. Struktura żądania
Autoryzacja
Typ autoryzacji: Basic Auth
Dane dostępowe (login oraz hasło) są danymi używanymi do zalogowania się na Global24:
II. Struktura odpowiedzi
Nazwa pola | Typ | Opis |
---|---|---|
name | string | |
description | string | |
itemid | string | |
code | string | |
currentStock | int |
III. Przykłady
Przykładowa odpowiedź
[ { "name": "Iphone", "description": "Iphone X - 256GB", "itemid": "123456", "code": "123456", "currentStock": 0 }, { "name": "Samsung TV", "description": "TV 60 4k", "itemid": "123456", "code": "123456", "currentStock": 31 }, { "name": "Samsung charger", "description": "Samsung Wireless Charger Stand", "itemid": "123456", "code": "123456", "currentStock": 39 } ]