Miejsce powstania kosztów (MPK)
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.
Struktura
Zasób MPK
posiada następujące atrybuty:
Atrybut | Typ | Opis |
---|---|---|
| Integer | Unikalny identyfikator |
| String | Nazwa miejsca powstania kosztów |
| String | Opis miejsca powstania kosztów |
| DateTime | Ostatnia aktualizacja |
| DateTime | Data utworzenia |
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"
} |
Lista miejsc powstania kosztów
Pobieranie listy wszystkich miejsc powstania kosztów dla wybranej organizacji.
Zasób jest stronicowany. Więcej informacji na stronie Autoryzacja / Kolekcje zapytań
GET /v1/organizations/:organization_id/mpks |
Sortowanie wyników
Parametr | Opis |
---|---|
| Określa atrybut po którym mają zostać posortowane wyniki. |
| Określa rodzaj sortowania - w kolejności malejącej ( |
Przykład zapytania
curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/mpks -H 'Authorization: Bearer token' -H 'Content-Type: application/json' |
Odpowiedź
Szczegóły miejsca powstania kosztu
Przykład zapytania
Odpowiedź
Tworzenie miejsca powstania kosztów
Parametry
Parametr | Typ | Opis | Wymagania |
---|---|---|---|
| String | Nazwa miejsca powstania kosztów |
|
| String | Opis miejsca powstania kosztów |
|
Przykładowe zapytanie
Odpowiedź
Informacja o błędach:
resource_not_found
- organizacja o podanym ID nie istnieje
Aktualizowanie miejsca powstania kosztu
Parametry
Parametr | Typ | Opis | Wymagania |
---|---|---|---|
| String | Nazwa miejsca powstania kosztów |
|
| String | Opis miejsca powstania kosztów |
|
Przykładowe zapytanie
Odpowiedź
Informacje o błędach:
resource_not_found
- webhook o podanym ID nie istnieje