Page tree
Skip to end of metadata
Go to start of metadata



1. Informacje ogólne


            Aktualnie operacje logistyczne prowadzone są od poniedziałku do piątku.

Celem projektu jest uruchomienie nowej usługi dodatkowej do usługi paczkomatowej, która zagwarantuje dostarczenie do paczkomatu w soboty i w niedziele.


Podstawowe cechy usługi:

  • dostarczenie do paczkomatu w niedzielę w przypadku nadania paczki najpóźniej w sobotę (w granicach standardowych godzin odbioru)
  • dostarczenie do paczkomatu w sobotę lub niedzielę w przypadku nadania w piątek
  • usługa zostanie wykonana jeżeli w momencie składania zamówienia zaznaczono opcję dodatkową jaką jest doręczenie w sobotę lub w niedzielę
  • usługa będzie dodatkowo płatna
  • usługa będzie dostępna dla klientów postpaid/prepaid
  • w fazie początkowej usługa nie będzie dostępna dla usług Allegro
  • usługa wykupowana jest per paczka a nie per podjazd
  • usługa nie jest dostępna dla Punktów Obsługi Przesyłek (POP)
  • usługa będzie dostępna w określonym oknie czasowym, np. od czwartku od godziny 18:00 do soboty do godziny 14:00. Nie uwzględniamy świąt ani dni wolnych
    • w Managerze Paczek usługa dodatkowa będzie wyszarzona a po najechaniu na szare pole wyświetli się pop-up z informacją od kiedy do kiedy usługa jest dostępna,
    • api zwróci wyjątek że usługa jest nieaktywna
  • automatyczny zwrot opłaty za usługę:
    • prepaid:
      • automatyczny zwrot nastąpi jeśli:
        • klient wykupił usługę dodatkową w danym tygodniu zgodnie z kalendarzem
        • zamówił podjazd kurierski lub dostarczył przesyłkę do Punktu/Oddziału lub umieścił w paczkomacie nadawczym zgodnie z regulaminem
        • nie umieściliśmy paczki w paczkomacie odbiorczym w sobotę lub w niedzielę w tygodniu, w którym wykupiona została usługa dodatkowa zgodnie z regulaminem.
      • postpaid:
        • opłata nie będzie uwzględniana na fakturze jeśli:
          • przesyłka nie została nadana
          • przesyłka nie została umieszczona w paczkomacie odbiorczym w sobotę lub w niedzielę w tygodniu, w którym wykupiona została usługa dodatkowa zgodnie z regulaminem


2. Implementacja usługi w apiv2


Implementacja zmian w apiv2 będzie wymagała modyfikacji w dwóch metodach.


2.1. Standardowy cennik przesyłek (https://api.paczkomaty.pl/?do=pricelist)


Wprowadzony zostanie nowy cennik dla usługi pod nazwą  endOfWeekCollection.


Przykład:

<paczkomaty>

<on_delivery_payment>minimalny_koszt_pobrania</on_delivery_payment>

<packtype>

<type>typ_przesyłki</type>

<price>cena_przesyłki</price>

</packtype>

<packtype>

<type>typ_przesyłki</type>

<price>cena_przesyłki</price>

</packtype>

<packtype>

<type>typ_przesyłki</type>

<price>cena_przesyłki</price>

</packtype>

<insurance>

<limit>górny_limit_kwoty_ubezpieczenia</limit>

<price>koszt_ubezpieczenia</price>

</insurance>

<endOfWeekCollection>

<price>cena_dostawy_weekendowej</price>

</endOfWeekCollection>

</paczkomaty>


2.2. Tworzenie przesyłek (https://api.paczkomaty.pl/?do=createdeliverypacks)


Wprowadzony zostanie nowy parametr o nazwie endOfWeekCollection

  • parametr będzie typu boolean i będzie przyjmował wartości true/false
  • wartość true będzie oznaczać ze wybieramy usługę dodatkową
  • atrybut nie jest wymagany
  • możliwość wyboru usługi dostępna tylko w określonym przedziale czasowym opisanym w informacjach ogólnych usługi
  • w przypadku wybrania usługi dodatkowej poza wskazanym przedziałem czasowym spowoduje zwrócenie wyjątku przez aplikację



Przykład:

<paczkomaty>

<pack>

             <id>tymczasowy_identyfikator_paczki</type>

<error key=”invalidEndOfWeekCollection”>Wybrana usługa dodatkowa jest poza określonym przedziałem czasowym. Przedziały czasowe w których można skorzystać z usługi opisane są w regulaminie.</error>

</pack>

</paczkomaty>

 

  • w przypadku wybrania Punktu Obsługi Klienta jako sposobu odbioru przesyłki zostanie zwrócony wyjątek. Tylko maszyny z kategoria parcel_locker_only obsługują Dostawy Weekendowe


Przykład:

<paczkomaty>

<pack>

             <id>tymczasowy_identyfikator_paczki</type>

<error key=”invalidBoxMachineNameForEndOfWeekCollection”>Wybrany punkt odbioru nie może być Punktem Obsługi Przesyłek.</error>

</pack>

</paczkomaty>


  • aby pobrać maszyny z wykluczeniem POP należy wywołać metodę do pobierania maszyn z parametrem category=parcel_locker_only np. https://api.paczkomaty.pl/?do=listmachines_xml&category=parcel_locker_only
  • 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ład:

<paczkomaty>

<pack>

             <id>tymczasowy_identyfikator_paczki</type>

<error key=”invalidAllegroForEndOfWeekCollection”>Usługa Dostawy Weekendowej nie jest dostępna dla przesyłek Allegro.</error>

</pack>

</paczkomaty>



Przykład tworzenia przesyłki:

<paczkomaty>

<autoLabels>automatyczne_etykiety</autoLabels>

<selfSend>nadawanie_w_paczkomacie</selfSend>

<pack>

             <id>tymczasowy_identyfikator_paczki</id>

            <addresseeEmail>adres_email_odbiorcy</addresseeEmail>

             <senderEmail>adres_email_nadawcy</senderEmail>

             <phoneNum>numer_telefonu_odbiorcy</phoneNum>

            <boxMachineName>oznaczenie_paczkomatu</boxMachineName>

             <packType>typ_paczki</packType>

             <endOfWeekCollection>true</endOfWeekCollection>

      </pack>

</paczkomaty>


3. Implementacja usługi w SHIPX


Wprowadzeniu usługi Dostawy Weekendowej w Shipx obejmuje:

3.1. Modyfikację obiektu przesyłki



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

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"

}


3.2. Modyfikacja wyszukiwania przesyłek (https://docs.inpost24.com/pages/viewpage.action?pageId=983165)

  • usługę Dostaw Weekendowych będzie można wyszukać poprzez wywołanie w filtrze parametru end_of_week_collection, któ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


3.3. Modyfikacja usług (https://docs.inpost24.com/pages/viewpage.action?pageId=983176)

  • 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



3.4. Modyfikacja przeliczania cen przesyłki (https://docs.inpost24.com/pages/viewpage.action?pageId=983209)

  • 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


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"

      }

]




  • No labels