[1.2.5] Punkty odbioru
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
Struktura
Zasób DispatchPoint
posiada następujące atrybuty:
| Integer | Adres URI do zasobu | |
| String | ID punktu odbioru | |
| String | Nazwa punktu odbioru | |
| String | Godziny funkcjonowania punktu | |
| String | Numer telefonu do punktu | |
| String | Adres e-mail punktu | |
| Object | Dodatkowe informacje | |
| String | Adres | |
| String | Status |
|
Przykład zasobu DispatchPoint
w formacie JSON:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"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"
}
} |
Lista punktów odbioru
Lista punktów odbioru w ramach określonej organizacji.
Aby pobrać listę punktów odbioru dla określonej organizacji, użytkownik musi być jej członkiem.
1
GET /v1/organizations/:organization_id/dispatch_points |
Przykładowe zapytanie
1
curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/dispatch_points -H 'Authorization: Bearer token' -H 'Content-Type: application/json' |
Odpowiedź
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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"
}
}
]
} |
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
1
GET /v1/dispatch_points/:id |
Przykład zapytania
1
curl -X GET https://api-shipx-pl.easypack24.net/v1/dispatch_points/1 -H 'Authorization: Bearer token' -H 'Content-Type: application/json' |
Odpowiedź
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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"
}
} |
Informacje o błędach
resource_not_found
- punkt odbioru o podanym ID nie istnieje