Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Dispatch points define addresses from which shipments can be picked up by the courier. Which have been specified in the dispatch order.
On this page
Table of Contents |
---|
Structure
Dispatch points resource has the following attributes:
Attribute | Type | Description | Valid values |
---|---|---|---|
| Integer | Dispatch point identifier | |
| String | Dispatch point name | |
| String | Dispatch point operating hours | |
| String | Dispatch point phone number | |
| String | Dispatch point email address | |
| String | Additional informations | |
| Object | Dispatch point address | |
| String | Dispatch point status |
|
Dispatch Point
example in JSON:
Code Block | ||
---|---|---|
| ||
{ "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": "Long", "building_number": "24", "city": "Cracow", "post_code": "30-624", "country_code": "PL" } } |
Authentication
Access to the resource requires a valid access token.
List of dispatch points
List of dispatch points within a specific organization.
Info |
---|
To get a dispatch point list for a specific organization, the user must be a member of it. |
Code Block | ||
---|---|---|
| ||
GET /v1/organizations/:organization_id/dispatch_points |
Request example
Code Block | ||
---|---|---|
| ||
curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/dispatch_points -H 'Authorization: Bearer token' -H 'Content-Type: application/json' |
Response
Code Block | ||
---|---|---|
| ||
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 |
---|
Errors Errors that may occur while getting the list of dispatch points:
|
Dispatch point details
Code Block | ||
---|---|---|
| ||
GET /v1/dispatch_points/:id |
Request example
Code Block | ||
---|---|---|
| ||
curl -X GET https://api-shipx-pl.easypack24.net/v1/dispatch_points/1 -H 'Authorization: Bearer token' -H 'Content-Type: application/json' |
Response
Code Block | ||
---|---|---|
| ||
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 |
---|
Errors
|