Page Comparison

To collect the list of dispatch points for a particular organization the user needs to be a member thereof.

The dispatch point is defined by the physical address where the shipment collection can be made from by the courier, which have been specified under the collection order.

PanelbgColor#f0f0f0titleBGColor#f0f0f0title

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

minLevel	2

Authentication

Access to the resource requires provision of the correct and valid access token.

The DispatchPoint Correct hrefstring

URI address to the resource

integer IDstringstringPoint working Point's stringstringPoint's e-mail string informationAddressStatusSample DispatchPoint resource in the JSON format

Dispatch Point example in JSON:

Code Block

language	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": "

DługaKrakow

Collecting information about the point

Code Block

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

language	json

GET /v1/organizations/:organization_id/dispatch_points

/:idSample requestv1dispatch_points/1 HTTP/1.1 Host: Content-Type: application/json lkfjasd9f70y43ohriw...[ommited for brevity]... { " } with the stated ID ,

List of dispatch points

The list of dispatch points within the given organization can be collected at:

Code Blockorganizationsorganization_/dispatch_points

Rights

Aby pobrać listę punktów odbioru dla określonej organizacji użytkownik musi być jej członkiem.

Sample request

Code BlockGET /v1/organizations/12345 HTTP.1 Host: api-shipx-pl.easypack24.net Authorization: Bearer lkfjasd9f70y43ohriw...[ommited for brevity]...

In reply to a correctly sent request, the server will return a response with HTTP 200 OK code:

code{ --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 ... ] }

Errors that may occur when collecting the collection orders list:

• resource_not_found - the organization which the user wants to collect the collection orders list for does not exist,
• forbidden - the token does not authorize to collect the collection orders list for the selected organization

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

resource_not_found - dispatch point with given ID does not exist.

Versions Compared

Old Version 4

New Version Current

Key

Structure

Collecting information about the point

Authentication

List of dispatch points

List of dispatch points

Dispatch point details

Rights

Sample request

identifier
`name`

String	Dispatch point name
`office_hours`

String	Dispatch point operating hours
`phone`

String	Dispatch point phone number
`email`