[1.2.5] Dispatch points
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
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:
{
"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.
To get a dispatch point list for a specific organization, the user must be a member of it.
GET /v1/organizations/:organization_id/dispatch_points
Request example
curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/dispatch_points -H 'Authorization: Bearer token' -H 'Content-Type: application/json'
Response
Errors
Errors that may occur while getting the list of dispatch points:
resource_not_found
- the organization for which the user wants to get the dispatch point list does not exist.forbidden
- the specific access token does not entitle you to get the dispatch point list for the selected organization.
Dispatch point details
Request example
Response
Errors
resource_not_found
- dispatch point with given ID does not exist.