02 kwietnia 2024
Udostępniliśmy nowe pole “additionalProperties”, które umożliwi realizację stałych podjazdów i zwrotów dla przesyłek Packeta
Od startu serwisu allegro.cz i uruchomienia allegro.sk, sprzedający mogą korzystać z możliwości Packeta - metody dostawy z Polski do Czech oraz z Polski na Słowację.
W przypadku użytkowników dysponujących własnymi magazynami w Czechach, system Packeta nie jest jednak w stanie umożliwić stałych podjazdów oraz obsłużyć nieodebranych przesyłek do wyżej wymienionych magazynów. Dlatego chcemy zoptymalizować ten proces w API.
Co zmieniliśmy?
W odpowiedzi dla GET /shipment-management/delivery-services udostępniliśmy dzisiaj tablicę “additionalProperties”, gdzie dla metod dostawy z “carrierId”: “PACKETA”, zwrócimy dane użytkownika z systemu Packeta, które wymagane są do stałych podjazdów kuriera oraz obsługi zwrotów:
- packeta#eshopId - identyfikator magazynu nadawcy,
- packeta#apiKey - klucz API w systemie Packeta.
Przykładowy response:
…
{
"id": {
"deliveryMethodId": "1550a685-d5d3-46a4-8736-b816ca710d3d",
"credentialsId": null
},
"name": "Allegro Odbiór w Punkcie Packeta pobranie",
"carrierId": "PACKETA",
"additionalServices": [
{
"id": "additionalHandling",
"name": "Paczka niestandardowa",
"description": "Paczka o kształcie, który nie jest prostopadłościanem
(np. opona, tuba) lub taka, która jest owinięta stretchem,
folią lub innym materiałem utrudniającym przesuwanie."
}
],
"additionalProperties": [
{
“id”: "packeta#eshopId", - identyfikator magazynu nadawcy
"name": "Nadawca", - nazwa
"description": "Pole 'Nadawca' w systemie Packeta. Wymagane, gdy podano packeta#apiKey.
Tylko dla sprzedawców posiadających stałe podjazdy Packeta, więcej informacji:
https://allegro.cz/pro-prodejce/allegro-zasilkovna-informace-pro-
prodejce-E73GE8Mq0ul", - opis
"required": false, - czy dane są wymagane
"readOnly": false - informacja o tym, czy powyższe dane są tylko do odczytu;
true - dane są tylko do odczytu i zwrócimy je tylko w szczegółowych danych paczki;
false - zwracane dane użytkownik może użyć podczas tworzenia paczki
},
{
"id": "packeta#apiKey", - klucz API w systemie Packeta
"name": "Klucz API",
"description": "Pole 'Klucz API' w systemie Packeta. Wymagane, gdy podano packeta#eshopId.
Tylko dla sprzedawców posiadających stałe podjazdy Packeta, więcej informacji:
https://allegro.cz/pro-prodejce/allegro-zasilkovna-informace-
pro-prodejce-E73GE8Mq0ul”,
"required": false,
"readOnly": false
}
],
…Informacje te zwrócimy wyłącznie dla czeskich sprzedających zintegrowanych z systemem Packeta, którzy wysyłają swoje towary na terenie Czech lub na Słowację.
Więcej informacji na temat konfiguracji konta w systemie Packeta udostępniliśmy w języku czeskim, na stronie “Pro prodejce” (“Dla sprzedających”), pod tym adresem.
Jeżeli wartość w “readOnly” to:
- true - oznacza to, że są to dane tylko do odczytu. Zwrócimy je tylko w szczegółowych danych utworzonej paczki, gdy skorzystasz z GET /shipment-management/shipments/{shipmentId}. Nie przekazuj tych danych podczas tworzenia nowej paczki,
- false - oznacza to, że możesz wykorzystać te dane podczas tworzenia nowej paczki, za pomocą POST /shipment-management/shipments/create-commands.
- Na zasobie do tworzenia paczek POST /shipment-management/shipments/create-commands udostępniliśmy pole “additionalProperties”, w którym dla wybranej metody dostawy z “carrierId”: “PACKETA” przekażesz dane uzyskane za pomocą GET /shipment-management/delivery-services.
Przykładowy request:
curl -X POST \
'https://api.allegro.pl/shipment-management/shipments/create-commands' \
-H 'Authorization: Bearer {token}' \
-H 'Accept: application/vnd.allegro.public.v1+json'
-H 'Content-type: application/vnd.allegro.public.v1+json'
…
"additionalProperties": {
"packeta#eshopId": "<Twój Eshop>",
"packeta#apiKey": "<Twój API Key>"
},
…W przyszłości dla GET /shipment-management/delivery-services planujemy zwracać dane również dla innych metod dostawy. Natomiast dla tych metod, które nie wspierają “additionalProperties” - zwrócimy pustą tablicę.
Więcej informacji na temat dostawy zagranicznej Packeta, znajdziesz w Pomocy Allegro.
