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

Parametry

ParametrTypOpisWymagania
nameStringNazwa miejsca powstania kosztów
  • Atrybut jest wymagany
  • Wartość atrybutu jest unikatowa w ramach organizacji
  • Maksymalna długość 255 znaków
descriptionStringOpis miejsca powstania kosztów
  • Atrybut jest wymagany


Zasób MPK - miejsce powstania kosztu - wartość słownikowa definiowana przez użytkownika, z założenia oznacza np. dział, który wygenerował koszt (np. wysłał przesyłkę) - Dział Marketingu, Dział Logistyki itp. Wartości można dowolnie definiować. Numer MPK powinien być unikalny. Numer MPK przypisujemy do przesyłki tak, by po zmianie nazwy MPK nie zmieniała się ona w danych historycznych.

Na potrzeby rozliczeń miejsc powstawania kosztów widoczne jest w Raportu COD dotyczy tylko przesyłek kurierskich.

Na tej stronie

 

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

AtrybutTypOpis
nameStringNazwa miejsca powstania kosztów
descriptionStringOpis miejsca powstania kosztów


Przykład zasobu MPK w formacie JSON:

{
    "href": "https://api-shipx-pl.easypack24.net/v1/mpks/1",
    "id": 1,
    "name": "Nazwa miejsca powstania kosztów",
    "description": "Opis miejsca powstania kosztów",
    "created_at": "2018-05-15T21:58:49.427+02:00",
    "updated_at": "2018-05-17T10:35:59.644+02:00"
}


Autoryzacja

Dostęp do zasobu wymaga podania prawidłowego i ważnego access tokenu dla Organizacji.

Pobranie kolekcji miejsc powstania kosztów

Pobieranie listy wszystkich miejsc powstania kosztów dla wybranej organizacji.

GET /v1/organizations/:organization_id/mpks


(info) Zasób jest stronicowany.

Parametry

ParametrOpis
sort_byOkreśla atrybut po którym mają zostać posortowane wyniki.
sort_orderOkreśla rodzaj sortowania - w kolejności malejącej (desc) lub rosnącej (asc).


Przykład zapytania

GET /v1/organizations/:organization_id/mpks HTTP/1.1
Host: api-shipx-pl.easypack24.net
Content-Type: application/json


Odpowiedź

W odpowiedzi serwer zwróci kolekcje z listą MPK i kodem HTTP 200 OK

HTTP/1.1 200 OK
Content-Type: application/json
 
{
    "href": "http://api-shipx-pl.easypack24.net:3000/v1/organizations/1/mpks",
    "count": 3,
    "page": 1,
    "per_page": 30,
    "items": [
        {
            "href": "https://api-shipx-pl.easypack24.net/v1/mpks/3",
            "id": 3,
            "name": "First",
            "description": "Some New Description 1",
            "created_at": "2018-05-16T13:36:28.332+02:00",
            "updated_at": "2018-05-16T13:36:28.332+02:00"
        },
        {
            "href": "https://api-shipx-pl.easypack24.net/v1/mpks/2",
            "id": 2,
            "name": "Second",
            "description": "Some New Description 2",
            "created_at": "2018-05-16T13:33:03.745+02:00",
            "updated_at": "2018-05-17T09:56:11.500+02:00"
        },
        {
            "href": "https://api-shipx-pl.easypack24.net/v1/mpks/1",
            "id": 1,
            "name": "Third",
            "description": "Some New Description 3",
            "created_at": "2018-05-15T21:58:49.427+02:00",
            "updated_at": "2018-05-15T22:31:04.316+02:00"
        }
    ]
}

Tworzenie miejsca powstania kosztów

POST /admin/v1/organizations/organization_id/mpks

Serwer zwróci odpowiedź HTTP ze statusem 201 Created


Parametry

ParametrTypOpisWymagania
nameStringNazwa miejsca powstania kosztów
  • Atrybut jest wymagany
  • Wartość atrybutu jest unikatowa w ramach organizacji
  • Maksymalna długość 255 znaków
descriptionStringOpis miejsca powstania kosztów
  • Atrybut jest wymagany



Przykładowe zapytanie

POST /v1/organizations/:organization_id/mpks HTTP/1.1
Host: api-shipx-pl.easypack24.net
Content-Type: application/json
 
{
  "name": "Nazwa miejsca powstania kosztów",
  "description": "Opis miejsca powstania kosztów"
}


Przykładowa odpowiedź

HTTP/1.1 201 Created
Location: https://api-shipx-pl.easypack24.net/v1/mpks/3
Content-Type: application/json
 
{
    "href": "https://api-shipx-pl.easypack24.net/v1/mpks/3",
    "id": 3,
    "name": "Nazwa miejsca powstania kosztów",
    "description": "Opis miejsca powstania kosztów",
    "created_at": "2018-05-16T13:36:28.332+02:00",
    "updated_at": "2018-05-16T13:36:28.332+02:00"
}


Błedy:

  • resource_not_found - organizacja o podanym ID nie istnieje

Aktualizacja miejsca zlecenia odbioru

PUT /v1/mpks/:mpk_id


Parametry

ParametrTypOpisWymagania
nameStringNazwa miejsca powstania kosztów
  • Atrybut jest wymagany
  • Wartość atrybutu jest unikatowa w ramach organizacji
  • Maksymalna długość 255 znaków
descriptionStringOpis miejsca powstania kosztów
  • Atrybut jest wymagany



Przykładowe zapytanie

PUT /v1/mpks/:mpk_id HTTP/1.1
Host: api-shipx-pl.easypack24.net
Content-Type: application/json
 
{
  "name": "Nazwa miejsca powstania kosztów",
  "description": "Opis miejsca powstania kosztów",
}


Odpowiedź

W przypadku poprawnego wykonania zapytania serwer zwróci odpowiedź zawierającą obiekt mpk ze zmienionymi danymi, z kodem HTTP 200 OK.

HTTP/1.1 200 OK
Content-Type: application/json
 
{
    "href": "https://api-shipx-pl.easypack24.net/admin/v1/mpks/1",
    "id": 1,
    "name": "Nazwa miejsca powstania kosztów",
    "description": "Opis miejsca powstania kosztów",
    "created_at": "2018-05-15T21:58:49.427+02:00",
    "updated_at": "2018-05-17T10:35:59.644+02:00"
}


Błedy:

  • resource_not_found - webhook o podanym ID nie istnieje,


Pobranie pojedynczego obiektu

GET /v1/mpks/1


Przykład zapytania

GET /v1/mpks/1 HTTP/1.1
Host: api-shipx-pl.easypack24.net
Content-Type: application/json
X-ShipX-OrganizationId: 1


Odpowiedź

HTTP/1.1 200 No Content
Content-Type: application/json
 
{
    "href": "https://api-shipx-pl.easypack24.net/v1/mpks/1",
    "id": 1,
    "name": "Nowa nazwa miejsca powstania kosztów",
    "description": "Nowy opis miejsca powstania kosztów",
    "created_at": "2018-05-15T21:58:49.427+02:00",
    "updated_at": "2018-05-15T22:31:04.316+02:00"
}
  • No labels