Operacja umożliwiająca modyfikowanie informacji zawartych w przesyłce.
PUT /v1/shipments/:shipment_id
Zasady aktualizacji przesyłek:
- Aktualizować można wszystkie atrybuty przesyłki opisane w sekcji [1.9.0] Aktualizowanie przesyłki.
- Aktualizować można tylko przesyłki, które nie zostały jeszcze zakupione, tzn. posiadają status
created,offers_preparedalbooffer_selected. - Możliwe jest także aktualizowanie przesyłki utworzonej w trybie uproszczonym jeśli nie doszło do jej zakupu, np. z powodu braku ofert,
- Nie można aktualizować przesyłek, które są w trakcie pobierania ofert lub w trakcie dokonywania transakcji zakupu.
- Aktualizacja przesyłki spowoduje rekalkulację ofert - nieaktualne oferty zostaną usunięte, a w ich miejsce przygotowane zostaną nowe.
- Możliwe jest usunięcie wartości podanych przy tworzeniu przesyłki, poprzez ustawienie ich wartości na
null.
Uwaga! Klienci debetowi
Po utworzeniu przesyłki, nie zwracamy cen dla klientów debetowych.
Atrybut
rate przyjmuje wartość null
Przykład zapytania
PUT https://api-shipx-pl.easypack24.net/v1/shipments/1 HTTP/1.1
{
"mpk":"miejsce_powstania_kosztow",
"comments": "dowolny komentarz",
"external_customer_id": "8877xxx",
"receiver": {
"company_name": "Some company inc.",
"first_name": "John",
"last_name": "Due",
"name": "Nazwa",
"email": "john@due.com",
"phone": "456123789",
"address": {
"id": "123",
"street": "Santa st",
"building_number": "130",
"city": "New York",
"post_code": "44-556",
"country_code": "PL"
}
},
"sender": {
"name": "Nazwa",
"company_name": "Some company inc.",
"first_name": "John",
"last_name": "Due",
"email": "john@due.com",
"phone": "321654987",
"address": {
"id": "123",
"street": "Santa st",
"building_number": "130",
"city": "New York",
"post_code": "33-333",
"country_code": "PL"
}
},
"cod": {
"amount": "132",
"currency": "PLN"
},
"reference": "69854156",
"is_return": true,
"only_choice_of_offer":true,
"parcels": [
{
"id": "small package",
"template": "small",
"dimensions": {
"length": "80",
"width": "360",
"height": "640",
"unit": "mm"
},
"weight": {
"amount": "25",
"unit": "kg"
}
}
],
"insurance": {
"amount": "33",
"currency": "PLN"
},
"custom_attributes": {
"allegro_transaction_id": "98754641",
"allegro_user_id": "98757"
},
"mpk": "Nazwa miejsca powstania kosztów."
}
Lista błędów, które mogą wystąpić przy opłacaniu przesyłki:
resource_not_found- może wystąpić gdy określona przesyłka nie istnieje lub użytkownik nie ma do niej dostępu,invalid_action- występuje przy próbie aktualizacji przesyłki już zakupionej (statusconfirmedlub późniejszy),shipment_locked- występuje przy próbie aktualizacji przesyłki, dla której proces kalkulacji ofert nie został ukończony (albo wykonywana jest inna operacja na przesyłce).forbidden- użyty token nie uprawnia do dokonywania aktualizacji wskazanej przesyłki.