Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Informacje ogólne


Podstawowe cechy usługi:

  • Usługa będzie dostępna w określonym oknie czasowym, np. od czwartku od godziny 20:00 do soboty do godziny 13:00. Nie uwzględniamy świąt ani dni wolnych

  • Usługa nie jest dostępna dla Punktów Obsługi Przesyłek (POP)

  • Usługa dostępna jest dla klientów postpaid/prepaid

  • Usługa jest obsługiwana przez paczkomaty dostępne 24/7



Panel
bgColor#f0f0f0
titleBGColor#f0f0f0
titleContents
Table of Contents
minLevel2


Implementacja usługi


Parametry

Parametr

Typ

Opis

Walidacja

Code Block
end_of_week_collection
Code Block
Boolean

Ustawienie parametru na true będzie oznaczać, że wybieramy usługę dodatkową.

Możliwość wyboru usługi dostępna tylko w określonym przedziale czasowym opisanym w informacjach ogólnych usługi

Atrybut nie jest wymagany.

  • Defaultowa wartośćfalse

Modyfikację obiektu przesyłki

Zmiana powinna zostać zaimplementowana w:


Pobieranie listy punktów dostępnych dla usługi

Aby pobrać listę punktów obsługujących usługę, należy wywołać metodę do pobierania maszyn z parametrem type=parcel_locker_only np.: https://api-shipx-pl.easypack24.net/v1/points?type=parcel_locker_only  następnie należy odfiltrować maszyny które nie są dostępne 24/7 za pomocą parametr location_247 ustawiony jest na true (location_247": true


Informacje o błędach

Błędy, jakie mogą wystąpić podczas tworzenia przesyłki:

  • invalid_end_of_week_collection - w przypadku wybrania usługi dodatkowej poza wskazanym przedziałem czasowym spowoduje zwrócenie wyjątku przez aplikację

  • invalid_target_point_for_end_of_week_collection- w przypadku wybrania Punktu Obsługi Przesyłek który nie jest dostępny 24/7 jako sposobu odbioru przesyłki zostanie zwrócony wyjątek. Tylko maszyny filtrowane za pomocą parametru type=parcel_locker_only obsługują Dostawy Weekendowe

  • invalid_target_point_247_for_end_of_week_collection- w przypadku wybrania  paczkomatu który nie jest dostępny 24/7 jako sposobu odbioru przesyłki zostanie zwrócony wyjątek. Tylko maszyny filtrowane za pomocą parametru type=parcel_locker_only obsługują Dostawy Weekendowe

  • invalid_allegro_for_end_of_week_collection- dla przesyłek allegro usługa nie jest dostępna. Próba utworzenia przesyłki allegro z usługą Dostawy Weekendowej spowoduje zwrócenie wyjątku przez aplikację


Przykładowe zapytanie dla tworzenia przesyłki w trybie uproszczonym

Code Block
languagejson
POST /v1/organizations/123/shipments HTTP/1.1
Host: api-shipx-pl.easypack24.net
Content-Type: application/json
Authorization: Bearer lkfjasd9f70y43ohriw...[ommited for brevity]...
{
      "receiver": {
             "email": "receiver@example.com",
             "phone": "888000000"
      },
      "parcels": [
      {
             "template": "small"
      }
      ],
      "custom_attributes": {
             "target_point": "KRA010"
      },
      "insurance": {
             "amount": 25,
             "currency": "PLN"
      },
      "cod": {
             "amount": 12.50,
             "currency": "PLN"
      },
      "end_of_week_collection":true
      "service": "inpost_locker_standard"
}

Modyfikacja wyszukiwania przesyłek

  • usługę Dostaw Weekendowych będzie można wyszukać poprzez wywołanie w filtrze parametru end_of_week_collectionktóry będzie przyjmował wartości true/false

  • w przypadku, gdy parametr będzie ustawiony na end_of_week_collection=true, będą zwracane tylko przesyłki, w których została wybrana opcja Dostaw Weekendowych

  • w przypadku braku parametru end_of_week_collection w filtrze będą zwracane wszystkie przesyłki

  • szczegółowe informacje na stronie [1.6.0] Wyszukiwanie przesyłek


Modyfikacja usług 

  • obiekt serwisu zostanie zaktualizowany o usługę dodatkową Dostaw Weekendowych,

  • dla serwisu inpost_locker_standard zostanie zwrócona usługa dodatkowa o identyfikatorze

id: end_of_week_collection


Modyfikacja przeliczania cen przesyłki


  • analogicznie jak przy tworzeniu przesyłki w metodzie post będzie można podać parametr end_of_week_collection z wartością true lub false,

  • parametr nie jest wymagany

  • w odpowiedzi zostanie zwrócony cennik zaktualizowany o parametr end_of_week_collection_charge_amount

  • szczegółowe informacje na stronie [1.7.0] Przeliczanie cen przesyłek


Przykład odpowiedzi:

[

      {

             "id":"SHIPMENT1",

             "calculated_charge_amount":"27.20",

             "fuel_charge_amount":"0.00",

             "notification_charge_amount":"0.00",

             "cod_charge_amount":"0.00",

             "insurance_charge_amount":"20.00",

             "calculated_charge_amount_non_commission":"7.20",

             "end_of_week_collection_charge_amount":"4.99",

      },

      {

             "id":"SHIPMENT2",

             "calculated_charge_amount":"18.00",

             "fuel_charge_amount":null,

             "notification_charge_amount":null,

             "cod_charge_amount":null,

             "insurance_charge_amount":null,

             "calculated_charge_amount_non_commission":null,

             "end_of_week_collection_charge_amount":"4.99"