Page Comparison

Sercem Platformy Usług Zintegrowanych są przesyłki. Na definicję przesyłki składają się:

dane nadawcy i odbiorcy
paczka (jedna lub więcej), która będzie fizycznie przesyłana
wybrana usługa (opcjonalnie usługi dodatkowe)
inne dodatkowe atrybuty w zależności od preferencji użytkownika, np.:
- Ubezpieczenie
- Pobranie

Aby utworzyć przesyłkę gotową do nadania, wymagane są 3 kroki:

Utworzenie przesyłki, na co składa się podanie danych nadawcy, odbiorcy oraz informacji o paczce (fioletowe figury na poniższym diagramie),
Pobranie informacji o dostępnych usługach dla utworzonego wcześniej obiektu przesyłki (niebieskie figury na poniższym diagramie),
Zakupienie etykiety poprzez wskazanie określonej usługi, dostępnej dla przesyłki, która została utworzona w kroku 1 (zielona figura na poniższym diagramie)

Panel

bgColor	#efefef
title	Na tej stronie

Table of Contents

maxLevel	2
minLevel	2

Uwierzytelnianie

Aby uzyskać dostęp do zasobu Shipment wymagane jest podanie aktualnego i prawidłowego access tokenu.

Diagram tworzenia przesyłki

Image Removed

Ceny usług mogą różnić się w zależności od wymiarów paczki oraz parametrów przesyłki, zdefiniowanych podczas jej tworzenia.

Listę wszystkich usług można znaleźć na stronie Rozmiary i usługi dla przesyłek

Dostępność usług zależy od przewoźników z którymi dana organizacja podpisała umowy.

Dla Klientów, których umowa pozwala na utworzenie debetu w systemie InPost (klient debetowy), nie będą zwracane ceny w odpowiedzi JSON, na wysłane żądanie do API.

Zasób Shipments dostępny jest dla Organizacji (z ID organization_id)

Code Block
https://api-shipx-pl.easypack24.net/v1/organizations/:organization_id/shipments

Atrybuty

AtrybutTypOpishrefstringTylko do odczytu. Adres URL do zasobu.idintegerTylko do odczytu. Identyfikator przesyłki w platformie Ship X.statusStringTylko do odczytu. Aktualny status przesyłki.

Sercem Platformy Usług Zintegrowanych są przesyłki. Na definicję przesyłki składają się:

dane nadawcy i odbiorcy
paczka (jedna lub więcej), która będzie fizycznie przesyłana
wybrana usługa (opcjonalnie usługi dodatkowe)
inne dodatkowe atrybuty w zależności od preferencji użytkownika, np.:
- Ubezpieczenie
- Pobranie

Aby utworzyć przesyłkę gotową do nadania, wymagane są 3 kroki:

Utworzenie przesyłki, na co składa się podanie danych nadawcy, odbiorcy oraz informacji o paczce (fioletowe figury na poniższym diagramie),
Pobranie informacji o dostępnych usługach dla utworzonego wcześniej obiektu przesyłki (niebieskie figury na poniższym diagramie),
Zakupienie etykiety poprzez wskazanie określonej usługi, dostępnej dla przesyłki, która została utworzona w kroku 1 (zielona figura na poniższym diagramie)

Info

Ceny usług mogą różnić się w zależności od wymiarów paczki oraz parametrów przesyłki, zdefiniowanych podczas jej tworzenia.

Listę wszystkich usług można znaleźć na stronie Rozmiary i usługi dla przesyłek

Dostępność usług zależy od przewoźników z którymi dana organizacja podpisała umowy.

Dla Klientów, których umowa pozwala na utworzenie debetu w systemie InPost (klient debetowy), nie będą zwracane ceny w odpowiedzi JSON, na wysłane żądanie do API.

Na tej stronie

Table of Contents

Diagram tworzenia przesyłki

Image Added

Struktura

Zasób Shipment posiada następujące atrybuty:

Atrybut	Typ	Opis
`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`.
`service`	String	Wybrana przez klienta usługa. Dostępne wartości Rozmiary i usługi dla przesyłek.
`reference`	String	Dodatkowy opis dla przesyłki, np. numer zamówienia lub ID klienta.
`is_return`	Boolean	Określa czy przesyłka jest zwrotna.
`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`. Rozmiary i usługi dla przesyłek
`custom_attributes`	CustomAttributes	Dodatkowe, opcjonalne atrybuty dla przesyłki.

parcelsArray[Parcel]Lista paczek w ramach przesyłki.created_atdatetimeTylko do odczytu. Data utworzenia przesyłki w systemie Ship X.created_by_idintegerId użytkownika, który utworzył przesyłkę, jeśli użytkownik jest zalogowany.codinsuranceMoneyDataUbezpieczenie MoneyDataPobranie za przesyłkę.additional_servicesString]

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. API X Rozmiary i usługi dla przesyłek

referenceStringDodatkowy opis dla przesyłki, np. numer zamówienia lub ID klienta.is_returnBoolOkreśla czy przesyłka jest zwrotna.offersObjectselected_offerObjectUsługa, która została wybrana podczas kupowania etykiety dla przesyłki.transactionsArray[Transaction]

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

Struktura obiektu Transaction:

Struktura obiektu Offer:

Atrybut	Typ	Opis
`id`	Integer	Unikalny identyfikator usługi oferowanej w ramach przesyłki
`service`	Object	Obiekt oferowanej usługi.
`carrier`	Object	Obiekt przewoźnika.
`additional_services`	Array[String]	Usługi dodatkowe wybrane przy tworzeniu przesyłki - dostępne w danej ofercie.
`status`	String	Status oferty
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.

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

Struktura obiektu service:

Atrybut	Typ	Opis
`id`	String	Identyfikator usługi
`name`	String	Nazwa usługi
description	String	Opis usługi

Struktura obiektu carrier:

Atrybut	Typ	Opis
`id`	String	Identyfikator przewoźnika
`name`	String	Nazwa przewoźnika
description	String	Opis przewoźnika

`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.

Atrybuty obiektu Parcel

Atrybut	Typ	Opis
`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 Rozmiary i usługi dla przesyłek .
`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.

Struktura obiektu Offer

Atrybut	Typ	Opis
`id`

StringIdentyfikator transakcjistatusStringStatus transakcji. Możliwe statusy: initiated, success, failurecreated_atDateTimeData utworzenia transakcji.updated_atDateTimeData ostatniej modyfikacji transakcji.offer_idIntegerId oferty, której transakcja dotyczy.tracking_numberStringNumer trackingowy przesyłki (identyfikator na poziomie systemu logistycznego).sending_methodStringPowielenie pola z custom_attributes.

external_customer_id

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

Atrybuty obiektu Parcel:

AtrybutTypOpisidStringWymagany 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.templateString

Nazwa predefiniowanego szablonu wymiarów i wagi paczki. Listę predefiniowanych szablonów wymiarów i rozmiarów paczek można znaleźć na stronie API X Rozmiary i usługi dla przesyłek.

dimensionsObject

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.

weightObject

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_numberStringNumer danej przesyłki. Nadawany w trakcie kupowania wybranej oferty.is_non_standardBool

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.

Atrybuty obiektu Peer:

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.

Struktura obiektu Service

Atrybut	Typ	Opis
`id`	String	Identyfikator usługi
`name`	String	Nazwa usługi
`description`	String	Opis usługi

Struktura obiektu Carrier

Atrybut	Typ	Opis
`id`	String	Identyfikator przewoźnika
`name`	String	Nazwa przewoźnika
`description`	String	Opis przewoźnika

Struktura obiektu Transaction

Atrybut	Typ	Opis
`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.

Atrybuty obiektu Peer

Atrybut	Typ	Opis
`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`

Object:

Note
Atrybut line1 i line2 jest jeszcze wspierany, jednak zalecane jest używanie street i building_number.

Atrybut	Typ	Opis
`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`

_codeStringKod pocztowycountry_codeStringKod kraju

Atrybut line1 i line2 jest jeszcze wspierany, jednak zalecane jest używanie street i building_number.

Atrybuty obiektu MoneyData:

Atrybut	Typ	Opis
`amount`	decimal	Kwota
`currency`	string	Waluta

Przygotowując przesyłkę, możliwe jest określenie dodatkowych parametrów w ramach obiektu custom_attributes:

AtrybutTypOpistarget_pointstringNazwa punktu docelowego, do którego ma zostać dostarczona przesyłka, z którego podejmie ją odbiorca, np. nazwa paczkomatu.
Tylko przesyłki paczkomatowe.sending_methodstring

Sposób nadania przesyłki.

Wymagane dla przesyłek Allegro.

dropoff_pointstring

Nazwa punktu nadawczego, do którego nadawca dostarczy przesyłkę do wysłania, np. nazwa paczkomatu.

Wymagane przy podaniu metody nadania pok, courier_pok, parcel_locker.

allegro_transaction_idstringNumer transakcji formularza posprzedażowego Allegro, w którym kupujący wybrał formę dostawy Allegro Paczkomaty InPost. Podanie tego parametru skutkuje koniecznością podania parametru allegro_user_id.allegro_user_idstringNumer użytkownika Allegro, w ramach transkacji określonej parameterem allegro_user_id, który jest sprzedającym. Podanie tego parametru skutkuje koniecznością podania parametru allegro_transaction_id.dispatch_order_idinteger

Numer zlecenia odbioru.

Atrybut tylko do odczytu, występuje gdy przesyłka posiada zdefiniowane zlecenie odbioru.

Przykład zasobu w formacie JSON (przesyłka paczkomatowa).

Code Block{ "href": "https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments/1234567890", "id": "1234567890", "status": "offers_prepared", "parcels": [ { "id": "small package", "template": "small", "dimensions": { "length": "80", "width": "360", "height": "640", "unit": "mm" }, "weight": { "amount": "25", "unit": "kg" }, "tracking_number": null,

`_code`	String	Kod pocztowy
`country_code`	String	Kod kraju

Atrybuty obiektu MoneyData

Atrybut	Typ	Opis
`amount`	Decimal	Kwota
`currency`	String	Waluta

Atrybuty obiektu CustomAttributes

Atrybut	Typ	Opis
`target_point`	String	Nazwa punktu docelowego, do którego ma zostać dostarczona przesyłka, z którego podejmie ją odbiorca, np. nazwa Paczkomat®. Tylko przesyłki Paczkomat®.
`sending_method`	String	[1.8.1] Sposób nadania Wymagane dla przesyłek Allegro.
`dropoff_point`	String	Nazwa punktu nadawczego, do którego nadawca dostarczy przesyłkę do wysłania, np. nazwa Paczkomat®. Wymagane przy podaniu metody nadania `pok`, `courier_pok`, `parcel_locker`.
`dispatch_order_id`	Integer	Numer zlecenia odbioru. Atrybut tylko do odczytu, występuje gdy przesyłka posiada zdefiniowane zlecenie odbioru.

Przykład zasobu Shipment w formacie JSON (przesyłka Paczkomat®).

Code Block

language	json

{
    "href": "https://api-shipx-pl.easypack24.net/v1/shipments/12345",
    "id": 12345,
    "status": "created",
    "tracking_number": null,
    "return_tracking_number": null,
    "service": "inpost_locker_standard",
    "reference": "Test",
    "is_return": false,
    "application_id": 25,
    "created_by_id": null,
    "external_customer_id": "8877xxx",
    "sending_method": "dispatch_order",
    "end_of_week_collection": false,
    "comments": null,
    "mpk": null,
    "additional_services": [],
    "custom_attributes": {
        "target_point": "KRA012",
        "sending_method": "dispatch_order"
    },
    "cod": {
        "amount": 12.5,
        "currency": "PLN"
    },
    "insurance": {
        "amount": 25.0,
        "currency": "PLN"
    },
    "sender": {
        "id": 12345,
        "name": "Name",
        "company_name": "Company_name",
        "first_name": "first_name",
        "last_name": "last_name",
        "email": "test@grupainteger.pl",
        "phone": "321321321",
        "address": {
            "id": 1764397634,
            "street": "Czerniakowska",
            "building_number": "87A",
            "line1": null,
            "line2": null,
            "city": "Warszawa",
            "post_code": "00-718",
            "country_code": "PL"
        }
    },
    "receiver": {
        "id": 12345,
        "name": "Name",
        "company_name": "Company name",
        "first_name": "Jan",
        "last_name": "Kowalski",
        "email": "test@inpost.pl",
        "phone": "111222333",
        "address": null
    },
    "selected_offer": null,
    "offers": [],
    "transactions": [],
    "parcels": [
        {
            "id": 12345,
            "identify_number": null,
            "tracking_number": null,
            "is_non_standard": false,
            "template": "small",
            "dimensions": {
                "length": 380.0,
                "width": 640.0,
                "height": 80.0,
                "unit": "mm"
            },
            "weight": {
                "amount": 25.0,
                "unit": "kg"
            }
        }
    ],
    "created_at": "2023-08-16T10:53:47.958+02:00",
    "updated_at": "2023-08-16T10:53:47.958+02:00"
}

Lista przesyłek Organizacji

Lista przesyłek w ramach określonej organizacji.

Info
Aby pobrać listę przesyłek dla określonej organizacji, użytkownik musi być jej członkiem.

Code Block

language	json

GET /v1/organizations/:organization/shipments

Przykładowe zapytanie

Code Block

language	json

curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments -H 'Authorization: Bearer token' -H 'Content-Type: application/json'

Odpowiedź

Code Block

language	json

HTTP/1.1 200 OK 
Content-Type: application/json  
{
    "href": "http://api-shipx-pl.easypack24.net/v1/organizations/115/shipments?owner_id=22&page=1&per_page=100&sort_by=id&sort_order=desc",
    "count": 42,
    "page": 1,
    "per_page": 100,
    "items": [
        {
            "href": "https://api-shipx-pl.easypack24.net/v1/shipments/12345",
            "id": 12345,
            "status": "confirmed",
            "tracking_number": "602677277331630317859008",
            "return_tracking_number": null,
            "service": "inpost_locker_standard",
            "reference": "Test",
            "is_return": false,
            "application_id": 25,
            "created_by_id": null,
            "external_customer_id": "8877xxx",
            "sending_method": "dispatch_order",
            "end_of_week_collection": false,
            "comments": null,
            "mpk": null,
            "additional_services": [],
            "custom_attributes": {
                "target_point": "KRA012",
                "sending_method": "dispatch_order"
            },
            "cod": {
                "amount": 12.5,
                "currency": "PLN"
            },
            "insurance": {
                "amount": 25.0,
                "currency": "PLN"
            },
            "sender": {
                "id": 12345,
                "name": "Name",
                "company_name": "Company_name",
                "first_name": "first_name",
                "last_name": "last_name",
                "email": "test@grupainteger.pl",
                "phone": "321321321",
                "address": {
                    "id": 1764397634,
                    "street": "Czerniakowska",
                    "building_number": "87A",
                    "line1": null,
                    "line2": null,
                    "city": "Warszawa",
                    "post_code": "00-718",
                    "country_code": "PL"
                }
            },
            "receiver": {
                "id": 12345,
                "name": "Name",
                "company_name": "Company name",
                "first_name": "Jan",
                "last_name": "Kowalski",
                "email": "test@inpost.pl",
                "phone": "111222333",
                "address": null
            },
            "selected_offer": {
                "id": 12345,
                "status": "bought",
                "expires_at": null,
                "rate": null,
                "currency": "PLN",
                "additional_services": [],
                "carrier": {
                    "id": "inpost_locker",
                    "name": "InPost Paczkomaty",
                    "description": "InPost Paczkomaty - Przesyłki paczkomatowe"
                },
                "service": {
                    "id": "inpost_locker_standard",
                    "name": "Paczkomatowa standardowa",
                    "description": "Przesyłka paczkomatowa standardowa"
                },
                "unavailability_reasons": null
            },
            "offers": [
                {
                    "id": 12345,
                    "status": "bought",
                    "expires_at": null,
                    "rate": null,
                    "currency": "PLN",
                    "additional_services": [],
                    "carrier": {
                        "id": "inpost_locker",
                        "name": "InPost Paczkomaty",
                        "description": "InPost Paczkomaty - Przesyłki paczkomatowe"
                    },
                    "service": {
                        "id": "inpost_locker_standard",
                        "name": "Paczkomatowa standardowa",
                        "description": "Przesyłka paczkomatowa standardowa"
                    },
                    "unavailability_reasons": null
                }
            ],
            "transactions": [
                {
                    "id": 12345,
                    "status": "success",
                    "offer_id": 12345,
                    "details": {},

"is_non_standard":false } ], "custom_attributes":{ targetpointKRA010 "dropoff_point": null, "sending_method": "parcel_locker","dispatch_order_id":1 , "sender": { "id": "123", "name": "Nazwa", "company_name": "InPost S.A.", "first_name": "Jan", "last_name": "Nowak", "email": "sender@email.com", "phone": "888000000", "address": { "id": "123", "street": "Malborska", "building_number": "130", "city": "Kraków", "post_code": "30-624", "country_code": "PL" } }, "receiver": { "id": "123", "name": "Nazwa", "company_name": null, "first_name": null, "last_name": null, "email": "sender@email.com", "phone": "888000000", "address": null }, "created_at": "2015-09-06T19:21:00.000+02:00", "cod": { "amount": 12.50, "currency": "PLN" }, "insurance": { "amount": 25, "currency": "PLN" }, "additional_services": [], "reference": "Order No. 12345", "is_return": false, null,"created_by_id3 "offers": [{"id":1278,carrier"id":"inpost_locker","name":"InPostPaczkomaty", "description":"InPostPaczkomaty-Przesyłkipaczkomatowe." }"service": {"id":"inpost_locker_standard","name":"PaczkomatowaStandardowa", descriptionPrzesyłka paczkomatowa standardowa.}, "status": "available", "expires_at": "2015-09-06T19:21:00.000+02:00",rate 2.02,"currency":"PLN",unavailability_reasons null} ], "selected_offer":null, "transactions":[], "sending_method":"parcel_locker", external_customer_id8877xxx", }

Lista przesyłek Organizacji

Lista przesyłek w ramach określonej organizacji:

Code Block
GET /v1/organizations/:organization/shipments

Uprawnienia

Aby pobrać listę przesyłek dla określonej organizacji użytkownik musi być jej członkiem.

Przykładowe zapytanie

Code Block
GET /v1/organizations/12345/shipments HTTP/1.1 Host: api-shipx-pl.easypack24.net Content-Type: application/json Authorization: Bearer lkfjasd9f70y43ohriw...[ommited for brevity]...

W odpowiedzi na poprawnie przesłane zapytanie, serwer zwróci odpowiedź z kodem HTTP 200 OK:

Code BlockHTTP/1.1 200 OK Content-Type: application/json { "href": "https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments", "count": 15, "per_page": 30, "page": 1, "items": [ { "href": "https://api-shipx-pl.easypack24.net/v1/organizations/1/shipments/123", "id": 123, ... other attribute omitted for brevity .... } ... other items omitted for brevity ... ] }

kg"
                    }
                }
            ],
            "created_at": "2023-08-16T10:53:47.958+02:00",
            "updated_at": "2023-08-16T10:53:50.460+02:00"
        },

Warning

Informacje o błędach

Błędy jakie mogą wystąpić podczas pobierania listy przesyłek:

resource_not_found - organizacja, dla której użytkownik chce pobrać listę przesyłek nie istnieje lub nie ma do niej dostępu.

`cod`	MoneyData	Pobranie za przesyłkę.
`insurance`	MoneyData	Ubezpieczenie przesyłki.
`sender`	Peer	Dane nadawcy.
`receiver`	Peer	Dane odbiorcy.

Versions Compared

Old Version 3

New Version Current

Key

Uwierzytelnianie

Diagram tworzenia przesyłki

Diagram tworzenia przesyłki

Struktura

Uwierzytelnianie

Lista przesyłek Organizacji

Przykładowe zapytanie

Lista przesyłek Organizacji

Uprawnienia

Przykładowe zapytanie