Versions Compared

Old Version 19

changes.mady.by.user Michał Machowski

Saved on

compared with

New Version Current

changes.mady.by.user Michał Machowski

Saved on

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 piątku do godziny 1318:00. Nie uwzględniamy świąt ani dni wolnych

  • Usługa nie jest dostępna dla Punktów Obsługi Przesyłek (POP) oraz Paczkomat® z parametrem "location_247":false

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

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

PanelbgColor#f0f0f0titleBGColor#f0f0f0titleContents

Na tej stronie

Table of Contents
minLevel

Implementacja usługi

2
Implementacja
Info

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

Parametry

code

Parametr

Typ

Opis

Walidacja

end_of_week_collection

code

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:

tworzeniu
tworzeniu
tworzeniu
aktualizacji

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

ustawionym na true (location_247": true)

 

 lub użyć https://api-shipx-pl.easypack24.net/v1/points?location_247=true.

Informacje o błędach

Warning

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

  • Paczkomat® 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 dostępne 24/7 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 /
curl --location 'https://api-shipx-pl.easypack24.net/v1/organizations/
123
1/shipments
HTTP/1.1 Host: api-shipx-pl.easypack24.net 
' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1Ni...' \
--header 'Content-Type: application/json
Authorization: Bearer lkfjasd9f70y43ohriw...[ommited for brevity]...
' \
--data-raw '{
    "sender": {
        "
receiver
name":
{
"Name",
        "company_name": "Company_name",
"email
     "first_name": "
receiver@example.com
first_name",
        "last_name": "last_name",
        "
phone
email": "
888000000"
test@grupainteger.pl",
}
"phone": "321321321",
        "
parcels
address":
[
 {
{ 
"street": "Czerniakowska",
            "
template
building_number": "
small
87A",
}
],
"city": "Warszawa",
            "
custom
post_
attributes
code":
{
"00-718",
            
"
target
country_
point
code": "
KRA010"
PL"
        }
    },
    "receiver": {
        "
insurance
name":
{
"Name",
        "company_name": "Company name",
"amount
      "first_name":
25
"Jan",
        "last_name": "Kowalski",
        "
currency
email": "
PLN" 
test@inpost.pl",
        "phone": "111222333"
    },
    "parcels": {
        "template": "small"
"cod
},
    "insurance": {
        "amount": 25,
        "
amount
currency":
12.50
 "PLN"
    },
    "cod": {
        "amount": 12.50,
        "currency": "PLN"
    },
    "custom_attributes": {
},
       "
end_of_week_collection":true 
sending_method": "dispatch_order",
        "target_point": "KRA012"
    },
    "service": "inpost_locker_standard",
    "reference": "Test",
    "end_of_week_collection": true
}'

Modyfikacja wyszukiwania przesyłek

usługę

  • 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

  • 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

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

szczegółowe

Modyfikacja usług 

obiekt

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

dla

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

id: end_of_week_collection

szczegółowe

Modyfikacja przeliczania cen przesyłki

analogicznie

  • 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

  • Parametr nie jest wymagany

w

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

szczegółowe

  • Szczegółowe informacje na stronie 

[1.7.0]

Przykład odpowiedzi:

Code Block
languagejson
[



      {



             "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"