Przesyłka

id

Integer

Tylko do odczytu. Identyfikator przesyłki w platformie ShipX.

status

String

Tylko do odczytu. Aktualny status przesyłki.

tracking_number

String

Numer trackingowy przesyłki (identyfikator na poziomie systemu logistycznego).

return_tracking_number

String

Numer przesyłki zwrotnej, pojawi się tylko wtedy gdy przesyłka otrzyma status returned_to_sender.
Informację można pobrać GETem:

• Dla pojedynczej przesyłki - GET /v1/shipments/ID_Shipments

• Dla wszystkich przesyłek organizacji - GET /v1/organizations/:organization_id/shipments

Numer zwracany jest również w powiadomieniach webhook https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/18153630/Webhooki#Dane-wysy%C5%82ane-w-przypadku-gdy-przesy%C5%82ka-otrzyma-status-ZDN-(Zwrot-do-Nadawcy---returned_to_sender)

service

String

Wybrana przez klienta usługa.

Dostępne wartości https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/11731062.

reference

String

Dodatkowy opis dla przesyłki, np. numer zamówienia lub ID klienta.

is_return

Boolean

Określa czy przesyłka jest zwrotna. Dedykowany parametr dla serwisów: inpost_courier_standard, inpost_courier_express_1000, inpost_courier_express_1200, inpost_courier_express_1700

application_id

Integer

Unikalny identyfikator aplikacji.

created_by_id

Integer

Id użytkownika, który utworzył przesyłkę, jeśli użytkownik jest zalogowany.

external_customer_id 

String

Identyfikator broker'a generującego przesyłki w ramach innej organizacji.

sending_method

String

Powielenie pola z custom_attributes.

end_of_week_collection

Boolean

Określa czy przesyłka posiada usługę “Paczka w Weekend”.

comments

String

Dowolny komentarz.

mpk

String

Nazwa miejsca powstania kosztów.

additional_services

Array[String]

Usługi dodatkowe wybrane przy tworzeniu przesyłki (różne oferty mogą zawierać różne usługi dodatkowe).

Dostępne usługi dodatkowe: sms, email, saturday. https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/11731062

custom_attributes

CustomAttributes

Dodatkowe, opcjonalne atrybuty dla przesyłki.

cod

MoneyData

Pobranie za przesyłkę.

insurance

MoneyData

Ubezpieczenie przesyłki.

sender

Peer

Dane nadawcy.

receiver

Peer

Dane odbiorcy.

selected_offer

Offer

Usługa, która została wybrana podczas kupowania etykiety dla przesyłki.

offers

Array[Offer]

Lista dostępnych usług wraz z cenami, które możliwe są do nabycia w ramach tej przesyłki.

transactions

Array[Transaction]

Lista transakcji płatniczych związanych z daną przesyłką.

parcels

Array[Parcel]

Lista paczek w ramach przesyłki.

created_at

DateTime

Tylko do odczytu. Data utworzenia przesyłki w systemie ShipX.

updated_at

DateTime

Tylko do odczytu. Data aktualizacji przesyłki w systemie ShipX.

id

String

Wymagany przy tworzeniu przesyłki z wieloma paczkami. Unikalny identyfikator danej paczki w ramach przesyłki, który pozwala zwrócić użytkownikowi informację o błędach walidacji przypisanych do konkretnej paczki. Id nie jest zapisywany w bazie danych i nie jest zwracany jak atrybut utworzonej paczki.

template

String

Nazwa predefiniowanego szablonu wymiarów i wagi paczki. Listę predefiniowanych szablonów wymiarów i rozmiarów paczek można znaleźć na stronie https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/11731062 .

dimensions

Object

Wymiary paczki.

• length - długość

• width - szerokość

• height - wysokość

• unit - jednostka, w której podane są wymiary. Aktualnie tylko mm (millimetry)

Uzupełniane automatycznie w przypadku wybrania prawidłowego szablonu template.

weight

Object

Waga paczki

• amount - waga,

• unit - jednostka, w której podana jest waga paczki. Aktualnie tylko kg (kilogramy)

Uzupełniana automatycznie w przypadku wybrania prawidłowego szablonu template.

tracking_number

String

Numer danej przesyłki. Nadawany w trakcie kupowania wybranej oferty.

is_non_standard

Bool

Ustawiany na true jeżeli przesyłka jest niestandardowa. Parametr można ustawić tylko dla przesyłek kurierskich.

Paczka realizowana tylko w ramach usług kurierskich w serwisie krajowym, której jeden z wymiarów przekracza 120 cm lub której suma wymiarów (długość + szerokość + wysokość) przekracza 220 cm. Paczką niestandardową są również: elementy o kształcie okrągłym, cylindrycznym lub owalnym, o nieregularnych kształtach lub/i z wystającymi elementami.
Opcja paczek niestandardowych nie dotyczy paczek dłużycowych.

id

Integer

Unikalny identyfikator usługi oferowanej w ramach przesyłki

service

Service

Obiekt oferowanej usługi.

carrier

Carrier

Obiekt przewoźnika.

additional_services

Array[String]

Usługi dodatkowe wybrane przy tworzeniu przesyłki - dostępne w danej ofercie.

status

String

Status oferty. Możliwe statusy oferty: in_preparation, available, unavailable, selected, bought, expired  

expires_at 

DateTime

Data i godzina do której możliwe jest zakupienie oferty.

rate

Decimal

Cena za usługę.

currency

String

Waluta, w której podana jest cena za usługę.

unavailability_reasons

Array

Przyczyny niedostępności danej oferty.

id

String

Identyfikator usługi

name

String

Nazwa usługi

description 

String

Opis usługi

id

String

Identyfikator przewoźnika

name 

String

Nazwa przewoźnika

description 

String

Opis przewoźnika

id 

String

Identyfikator transakcji

status

String

Status transakcji. Możliwe statusy: initiated, success, failure

created_at

DateTime

Data utworzenia transakcji.

updated_at

DateTime

Data ostatniej modyfikacji transakcji.

offer_id

Integer

Id oferty, której transakcja dotyczy.

id 

String

Identyfikator obiektu Peer

name 

String

Nazwa

company_name

String

Nazwa firmy

first_name

String

Imię

last_name

String

Nazwisko

email

String

Adres e-mail

phone

String

Numer telefonu

address

Address

Adres

id 

String

Identyfikator obiektu adres

line1

String

Pierwsza linia adresu

line2

String

Druga linia adresu

street 

String

Nazwa ulicy

building_number 

String

Numer domu

city

String

Miasto

post_code

String

Kod pocztowy

country_code

String

Kod kraju