Versions Compared

Old Version 3

changes.mady.by.user Michał Machowski

Saved on

compared with

New Version Current

changes.mady.by.user Michał Machowski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Info

title

Warning!

The

resource

is

available

only

in

the

following

countries:

PL

Dispatch points define addresses from which shipments can be picked up by the courier. which Which have been specified in the dispatch order.

panel

bgColor#f0f0f0titleBGColor#f0f0f0title

On this page

Table of Contents
minLevel
2 

Structure

Dispatch points resource has the following attributes:

Attribute

Type

Description

Valid values

Availability

id

Integer

Dispatch point identifier

PL


name

String

Dispatch point name

PL


office_hours

String

Dispatch point operating hours

PL


phone

String

Dispatch point phone number

PL


email

String

Dispatch point email address

PL


comments

String

Additional

informations

PL


address

Object

Dispatch point address

PL


status

String

Dispatch point status

created, activated, suspended

PL

Dispatch Point example in JSON:

Code Block
languagejson
{
  "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)
Info

To get a dispatch point list for a specific organization, the user must be a member of it.

Code Block
languagejson
GET /v1/organizations/:organization_id/dispatch_points

Request example

Code Block
languagejson
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
languagejson
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:

  • 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

Code Block
languagejson
GET /v1/dispatch_points/:id

Request example

Code Block
languagejson
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
languagejson
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

  • resource_not_found - dispatch point with given ID does not exist.