Versions Compared

Old Version 4

changes.mady.by.user Michał Machowski

Saved on

compared with

New Version 5

changes.mady.by.user Michał Machowski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Parametry

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

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

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.

PanelbgColor#f0f0f0titleBGColor#f0f0f0title

Na tej stronie

Table of Contents
minLevel2
 
Zasób MPK 


posiada

Uwierzytelnianie

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

Struktura

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

Atrybut

Typ

Opis

id

Integer

Unikalny identyfikator

name

String

Nazwa miejsca powstania kosztów

description

String

Opis miejsca powstania kosztów

updated_at

DateTime

Ostatnia aktualizacja  

created_at

DateTime

Data utworzenia  

Przykład

zasobu 

zasobu MPK w formacie JSON:

Code Block
languagejson
{
    "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

Lista miejsc powstania kosztów

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

Info

Zasób jest stronicowany. Więcej informacji na stronie [1.3.0] API Informacje ogólne

Code Block
languagejson
GET /v1/organizations/:organization_id/mpks

(info) Zasób jest stronicowany.

Parametry

Sortowanie wyników

Parametr

Opis

sort_by

Określa atrybut po którym mają zostać posortowane wyniki.

sort_order

Określa rodzaj sortowania - w kolejności malejącej (desc) lub rosnącej (asc).

Przykład zapytania

Code Block
languagejson
curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/
:organization_id
1/mpks
HTTP/1.1 Host: api-shipx-pl.easypack24.net 
-H 'Authorization: Bearer token' -H 'Content-Type: application/json'

Odpowiedź

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

code

Code Block
languagejson
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

Szczegóły miejsca powstania

kosztów

kosztu

Code Block
POST
GET
/admin
/v1/
organizations
mpks/
organization_
:id
/mpks

Serwer zwróci odpowiedź HTTP ze statusem 201 Created

Parametry

ParametrTypOpisWymaganianameStringNazwa 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

Code BlockPOST /v1/organizations/:organization_id/mpks HTTP/1.1 Host: 
Przykład zapytania
 Code Block
languagejson
curl -X GET https://api-shipx-pl.easypack24.net/v1/mpks/1 
Content
-
Type: application/json
 
{
  "name": "Nazwa miejsca powstania kosztów",
  "description": "Opis miejsca powstania kosztów"
}Przykładowa odpowiedź
H 'Authorization: Bearer token' -H 'Content-Type: application/json'
Odpowiedź
 Code Block
HTTP/1.1 
201 Created
Location: https://api-shipx-pl.easypack24.net/v1/mpks/3
200 OK
Content-Type: application/json
 


{
    "href": "https://api-shipx-pl.easypack24.net/v1/mpks/
3
1",
    "id": 
3
1,
    "name": "
Nazwa
Nowa nazwa miejsca powstania kosztów",
    "description": "
Opis
Nowy opis miejsca powstania kosztów",
    "created_at": "2018-05-
16T13
15T21:
36
58:
28
49.
332
427+02:00",
    "updated_at": "2018-05-
16T13
15T22:
36
31:
28
04.
332
316+02:00"
}
Błedy:
  • resource_not_found - organizacja o podanym ID nie istnieje
Aktualizacja miejsca zlecenia odbioru
 Code BlockPUT
Tworzenie miejsca powstania kosztów
 Code Block
languagejson
POST /v1/
mpks
organizations/:
mpk
organization_id/mpks
Parametry
Parametr
Typ
Opis
Wymagania
name
String
Nazwa miejsca powstania kosztów
  • Atrybut jest wymagany
  • Wartość atrybutu jest unikatowa w ramach organizacji
  • Maksymalna długość 255 znaków
description
String
Opis miejsca powstania kosztów
  • Atrybut jest wymagany
Przykładowe zapytanie
 Code Block
languagejson
curl -X PUT 
/v1/mpks/:mpk_id HTTP/1.1
Host: 
https://api-shipx-pl.easypack24.net/v1/organizations/1/mpks -H 'Authorization: Bearer token' -H 'Content-Type: application/json' 
 
-d '{
  "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.
code
 Code Block
languagejson
HTTP/1.1 
200
201 
OK
Created
Content-Type: application/json

 

 {
    "href": "https://api-shipx-pl.easypack24.net/
admin/
v1/mpks/
1
3",
    "id": 
1
3,
    "name": "Nazwa miejsca powstania kosztów",
    "description": "Opis miejsca powstania kosztów",
    "created_at": "2018-05-
15T21
16T13:
58
36:
49
28.
427
332+02:00",
    "updated_at": "2018-05-
17T10
16T13:
35
36:
59
28.
644
332+02:00"
}
 Warning
Błedy
Informacja o błędach:
  • resource_not_found
 
  •  - 
 webhook 
  • organizacja o podanym ID nie istnieje
,Pobranie pojedynczego obiektu
Aktualizowanie miejsca powstania kosztu
 Code Block
language
GET
json
PUT /v1/mpks/
1
Przykład zapytania
 Code BlockGET /v1/mpks/1 HTTP/1.1
Host: 
:id
Parametry
Parametr
Typ
Opis
Wymagania
name
String
Nazwa miejsca powstania kosztów
  • Atrybut jest wymagany
  • Wartość atrybutu jest unikatowa w ramach organizacji
  • Maksymalna długość 255 znaków
description
String
Opis miejsca powstania kosztów
  • Atrybut jest wymagany
Przykładowe zapytanie
 Code Block
languagejson
curl -X PUT https://api-shipx-pl.easypack24.net/v1/mpks/1 -H 'Authorization: Bearer token' -H 'Content-Type: application/json' 
X-ShipX-OrganizationId: 1
-d '{
  "name": "Nazwa miejsca powstania kosztów", 
  "description": "Opis miejsca powstania kosztów"
}'
Odpowiedź
 Code Block
languagejson
HTTP/1.1 200 
No Content
OK
Content-Type: application/json

 
 {
    "href": "https://api-shipx-pl.easypack24.net/v1/mpks/1",
    "id": 1,
    "name": "
Nowa nazwa
Nazwa miejsca powstania kosztów",
    "description": "
Nowy
Opis 
opis 
miejsca powstania kosztów",
    "created_at": "2018-05-15T21:58:49.427+02:00",
    "updated_at": "2018-05-
15T22
17T10:
31
35:
04
59.
316
644+02:00"
}
 Warning
Informacje o błędach:
  • resource_not_found - webhook o podanym ID nie istnieje