Versions Compared

Old Version 3

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.



PanelbgColor#f0f0f0titleBGColor#f0f0f0title

Na tej stronie

Table of Contents
minLevel2
 

Uwierzytelnianie

Dostęp do zasobu wymaga podania aktualnego i ważnego access token.

Struktura

Zasób DispatchPointposiada następujące atrybuty:

Atrybut

Typ

Opis

Poprawne wartości

href

string

Integer

Adres URI do zasobu


id

integer

String

ID punktu odbioru


name

string

String

Nazwa punktu odbioru


office_hours

string

String

Godziny funkcjonowania punktu


phone

string

String

Numer telefonu do punktu


email

string

String

Adres e-mail punktu


comments

string

Object

Dodatkowe informacje


address

Object

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"
  }
}

Pobieranie informacji o punkcie

Code Block
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
/:idPrzykład zapytania
Przykładowe zapytanie
 Code Block
languagejson
curl -X GET https:/
v1
/
dispatch_points/1 HTTP/1.1
Host: 
api-shipx-pl.easypack24.net

Content-Type: application/json

/v1/organizations/1/dispatch_points -H 'Authorization: Bearer
 lkfjasd9f70y43ohriw...[ommited for brevity]...
 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"
			}
		}
    
}
]
}
Błedy
 Warning
Informacje o błędach
Błędy jakie mogą wystąpić podczas pobierania listy zleceń odbioru:
  • resource_not_found
 - punkt odbioru o podanym ID 
  •  - organizacja, dla której użytkownik chce pobrać listę zleceń odbioru nie istnieje,
Lista punktów odbioru
Listę punktów odbioru w ramach określonej organizacji można pobrać pod adresem:
 Code Block
  • forbidden - token nie uprawnia do pobrania listy zleceń odbioru dla wybranej organizacji.
Szczegóły punktu odbioru
 Code Block
languagejson
GET /v1/
organizations
dispatch_points/:
organization_
id
/dispatch_points
Uprawnienia
Aby pobrać listę punktów odbioru dla określonej organizacji użytkownik musi być jej członkiem.
Przykładowe zapytanie
 Code BlockGET /v1/organizations/12345
Przykład zapytania
 Code Block
languagejson
curl -X GET https://api-shipx-pl.easypack24.net/v1/dispatch_points
 HTTP
/1
.1
Host: api-shipx-pl.easypack24.net

 -H 'Authorization: Bearer token' -H '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 Block
'
Odpowiedź
 Code Block
languagejson
HTTP/1.1 200 OK
Content-Type: application/json
 {

{
  
	
"href": "https://test.api
-
.shipx
-
.pl.easypack24.net/v1/
organizations/1/dispatch_points",
	"count": 15,
	"per_page": 30,
	"page": 1,
	"items": [
		{
			"href": "https://api-shipx-pl.easypack24.net/v1/dispatch_points/3",
			"id": 123,
			... other attribute omitted for brevity ....
		}
		... other items omitted for brevity ...
	]
}
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 do pobrania listy zleceń odbioru dla wybranej organizacji.
    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