You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 5
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
Dispatch points resource has the following attributes:
Attribute
Type
Description
Valid values
id
Integer
Dispatch point identifier
name
String
Dispatch point name
office_hours
Dispatch point operating hours
phone
Dispatch point phone number
email
Dispatch point email address
comments
Additional informations
address
Object
Dispatch point address
status
Dispatch point status
created, activated, suspended
created
activated
suspended
Dispatch Point example in JSON:
Dispatch Point
{ "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" } }
Access to the resource requires a valid access token.
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
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" } } ] }
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.
resource_not_found
forbidden - the specific access token does not entitle you to get the dispatch point list for the selected organization.
forbidden
GET /v1/dispatch_points/:id
curl -X GET https://api-shipx-pl.easypack24.net/v1/dispatch_points/1 -H 'Authorization: Bearer token' -H 'Content-Type: application/json'
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" } }
resource_not_found - dispatch point with given ID does not exist.