Versions Compared

Old Version 4

changes.mady.by.user Michał Machowski

Saved on

compared with

New Version Current

changes.mady.by.user Michał Machowski

Saved on

Key

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

Punktu odbioru definiują fizyczne adres, z których może nastąpić odbiór przesyłek przez kuriera, które zostały określone w ramach zlecenia odbioru.



Na tej stronie

Table of Contents

Struktura

Zasób DispatchPointposiada następujące atrybuty:

Atrybut

Typ

Opis

Poprawne wartości

href

Integer

Adres URI do zasobu


id

String

ID punktu odbioru


name

String

Nazwa punktu odbioru


office_hours

String

Godziny funkcjonowania punktu


phone

String

Numer telefonu do punktu


email

String

Adres e-mail punktu


comments

Object

Dodatkowe informacje


address

String

Adres


status

String

Status

created, activated, suspended

Przykład zasobu DispatchPoint w formacie JSON:

Code Block
languagejson
{
  "href": "https://api-shipx-pl.easypack24.net/v1/dispatch_points/1",
  "id": 1,
  "name": "My dispatch point",
  "office_hours": "8-16",
  "phone": "777888999",
  "email": null,
  "comments": null,
  "status": "created",
  "address": {
    "id": 230,
    "street": "Długa",
    "building_number": "24",
    "city": "Krakow",
    "post_code": "30-624",
    "country_code": "PL"
  }
}

Uwierzytelnianie

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

Lista punktów odbioru

Lista punktów odbioru w ramach określonej organizacji.

Info

Aby pobrać listę punktów odbioru dla określonej organizacji, użytkownik musi być jej członkiem.

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

Przykładowe zapytanie

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

Odpowiedź

Code Block
languagejson
HTTP/1.1 200 OK
Content-Type: application/json
{
    "href": "https://api-shipx-pl.easypack24.net/v1/organizations/1/dispatch_points",
    "count": 15,
    "per_page": 30,
    "page": 1,
    "items": [
        {
			"href": "https://test.api.shipx.pl.easypack24.net/v1/dispatch_points/1",
			"id": 1,
			"name": "My dispatch point",
			"office_hours": "8-16",
			"phone": "777888999",
			"email": null,
			"comments": null,
			"status": "created",
			"address": {
				"id": 230,
				"street": "Długa",
				"building_number": "24",
				"city": "Krakow",
				"post_code": "30-624",
				"country_code": "PL"
			}
		}
    ]
}
Warning

Informacje o błędach

Błędy jakie mogą wystąpić podczas pobierania listy zleceń odbioru:

  • resource_not_found - organizacja, dla której użytkownik chce pobrać listę zleceń odbioru nie istnieje,

  • forbidden - token nie uprawnia do pobrania listy zleceń odbioru dla wybranej organizacji.

Szczegóły punktu odbioru

Code Block
languagejson
GET /v1/dispatch_points/:id

Przykład zapytania

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

Odpowiedź

Code Block
languagejson
HTTP/1.1 200 OK
Content-Type: application/json
 {
  "href": "https://test.api.shipx.pl.easypack24.net/v1/dispatch_points/1",
  "id": 1,
  "name": "My dispatch point",
  "office_hours": "8-16",
  "phone": "777888999",
  "email": null,
  "comments": null,
  "status": "created",
  "address": {
    "id": 230,
    "street": "Długa",
    "building_number": "24",
    "city": "Krakow",
    "post_code": "30-624",
    "country_code": "PL"
  }
}
Warning

Informacje o błędach

  • resource_not_found - punkt odbioru o podanym ID nie istnieje