[1.6.4] Address book



 

AddressBook resource represents an address book assigned to organization.


Structure

AddressBook resource has the following attributes:

Attribute

Type

Description

Availability

Attribute

Type

Description

Availability

id

Integer

unique identifier

PL, IT

name

String

name of entry, unique in the context of the organization.

PL, IT

first_name

String

First name

PL, IT

last_name

String

Last name

PL, IT

phone

String

Phone

PL, IT

email

String

E-mail address

PL, IT

organization_id

Integer

organization ID which owns this entry

PL, IT

main_address

Address

Addressee's main address

PL, IT

delivery_address

Address

Shipment delivery address

PL, IT

sender_parcel

Boolean

Paczkomat parcel station shipment sender

PL, IT

sender_courier

Boolean

Courier shipment sender

PL, IT

sender_letter

Boolean

Letter shipment sender

PL, IT

kind

String

Type of entry

PL, IT

company_name

String

Company name

PL, IT

preferred_dropoff_point

String

Preferred shipping point

PL, IT

created_at

DateTime

Address book creation date and time. 

PL, IT

updated_at

DateTime

Last address book update date and time.

PL, IT

 

AddressBook resource example JSON format:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 {           "id":5,          "first_name":"Jan",          "last_name":"Nowak",          "email":"jan@nowak.pl",          "phone":"123456789",          "created_at":"2016-02-24T09:22:27.212+01:00",          "updated_at":"2016-02-24T09:22:27.212+01:00",          "organization_id":1,          "name":"Nowak Corp",          "sender_parcel":false,          "sender_courier":false,          "sender_letter":true,          "kind": "sender",          "company_name": "MyCompanyName",          "preferred_dropoff_point": "KRA120",          "main_address":{             "id": "123",             "street": "Malborska",             "building_number": "130",             "city":"Warsaw","id": "123",             "post_code":"33-666",             "country_code":"PO"          },          "delivery_address":{             "id": "123",             "street": "Malborska",             "building_number": "140",             "city":"Cracow",             "post_code":"66-666",             "country_code":"AZ"          }       }

 

Authentication

Resource access requires an active access token.


 

Address book list

Address book list within the given organization:

1 GET /v1/organizations/:organization_id/address_books

Request example

1 curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/address_books -H "Authorization: Bearer token" -H "Content-Type: application/json"

Response

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 HTTP/1.1 200 OK Content-Type: application/json { "href":"https://api-shipx-pl.easypack24.net/v1/address_books", "count":1, "page":1, "per_page":30, "items":[ { "id":5, "first_name":"Jan", "last_name":"Nowak", "email":"jan@nowak.pl", "phone":"123456789", "created_at":"2016-02-24T09:22:27.212+01:00", "updated_at":"2016-02-24T09:22:27.212+01:00", "organization_id":1, "name":"Nowak Corp", "sender_parcel":false, "sender_courier":false, "sender_letter":true, "kind": "sender", "company_name": "MyCompanyName", "preferred_dropoff_point": "KRA120",  "main_address":{ "id": "123", "street": "Malborska", "building_number": "130", "city":"Warsaw","id": "123", "post_code":"33-666", "country_code":"PO" }, "delivery_address":{ "id": "123", "street": "Malborska", "building_number": "140", "city":"Cracow", "post_code":"66-666", "country_code":"AZ" } } ] }

 

Address book details

Retrieving address book information to which the user has access to

1 GET /v1/address_books/:id

Request example

1 curl -X GET https://api-shipx-pl.easypack24.net/v1/address_books/1 -H 'Authorization: Bearer token' -H 'Content-Type: application/json'

Response

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 HTTP/1.1 Content-Type: application/json { "id": 6, "first_name": "Jan", "last_name": "nowak", "email": "jan@nowak.pl", "phone": "123456789", "created_at": "2016-02-24T09:22:35.032+01:00", "updated_at": "2016-02-24T09:22:35.032+01:00", "organization_id": 1, "name": "Nowak Corp", "sender_parcel": true, "sender_courier": false, "sender_letter": true, "kind": "receiver", "company_name": "MyCompanyName", "preferred_dropoff_point": "KRA120",  "main_address": { "id": "123", "street": "Malborska", "building_number": "130", "city": "Cracow", "post_code": "33-666", "country_code": "PO" }, "delivery_address": { "id": "123", "street": "Malborska", "building_number": "130", "city": "Warsow", "post_code": "66-666", "country_code": "AZ" } }

 

Address book creation

Creating a new address book for organization

1 POST v1/organizations/:organization_id/address_books

Parameters

Parameter

Type

Description

Availability

Parameter

Type

Description

Availability

name

String

The attribute is required.

  • Maximum length: 255

  • Unique in the context of the organization    

PL, IT

first_name

String

The attribute is required.

  • Maximum length: 255

PL, IT

last_name

String

The attribute is required.

  • Maximum length: 255

PL, IT

phone

String

The attribute is required.

  • Maximum length: 255

  • 9 characters  

  • Digits only  

PL, IT

email

String

The attribute is required.

  • Maximum length: 255

  • Format consistent with RFC 5322 and RFC 5321

PL, IT

kind

String

The attribute is required.

  • Maximum length: 255

  • Accepted values (sender, receiver)

PL, IT

company_name

String

The attribute is not required.

  • Maximum length: 255

PL, IT

preferred_dropoff_point 

String

The attribute is not required.

  • Maximum length: 255

PL, IT

main_address

Address

The attribute is required.

PL, IT

delivery_address

Address

The attribute is required.

PL, IT

sender_parcel

Boolean

The attribute is not required.

  • Default value: false

PL, IT

sender_courier

Boolean

The attribute is not required.

  • Default value: false

PL, IT

sender_letter

Boolean

The attribute is not required.

  • Default value: false

PL, IT

Request example

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/address_books -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{ "name": "Nowak Corp", "first_name": "Jan", "last_name": "Nowak", "email": "jan@nowak.com", "phone": "123456789", "sender_parcel": true, "sender_letter": true, "kind": "sender", "company_name": "MyCompanyName", "preferred_dropoff_point": "KRA120", "main_address": { "street": "Malborska", "building_number": "130", "city": "Warsaw", "post_code": "33-666", "country_code": "PO" }, "delivery_address": { "street": "Malborska", "building_number": "130", "city": "Cracow", "post_code": "66-666", "country_code": "AZ" } }'

Response

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 HTTP/1.1 Content-Type: application/json { "id": 7, "first_name": "Jan", "last_name": "Nowak", "email": "jan@nowak.com", "phone": "123456789", "created_at": "2016-02-24T10:38:03.835+01:00", "updated_at": "2016-02-24T10:38:03.835+01:00", "organization_id": 1, "name": "Nowak Corp", "sender_parcel": true, "sender_courier": false, "sender_letter": true, "kind": "sender", "company_name": "MyCompanyName", "preferred_dropoff_point": "KRA120", "main_address": { "id": "123", "street": "Malborska", "building_number": "130", "city": "Warsaw", "post_code": "33-666", "country_code": "PO" }, "delivery_address": { "id": "123", "street": "Malborska", "building_number": "130", "city": "Cracow", "post_code": "66-666", "country_code": "AZ" } }

 

Address book editing

Edition of an existing address book

1 PUT /v1/address_books/:id

Parameters

Parameter

Type

Description

Availability

Parameter

Type

Description

Availability

name

String

The attribute is required.

  • Maximum length: 255

  • Unique in the context of the organization    

PL, IT

first_name

String

The attribute is required.

  • Maximum length: 255

PL, IT

last_name

String

The attribute is required.

  • Maximum length: 255

PL, IT

phone

String

The attribute is required.

  • Maximum length: 255

  • 9 characters  

  • Digits only  

PL, IT

email

String

The attribute is required.

  • Maximum length: 255

  • Format consistent with RFC 5322 and RFC 5321

PL, IT

kind

String

The attribute is required.

  • Maximum length: 255

  • Accepted values (sender, receiver)

PL, IT

company_name

String

The attribute is not required.

  • Maximum length: 255

PL, IT

preferred_dropoff_point

String

The attribute is not required.

  • Maximum length: 255

PL, IT

main_address

Address

The attribute is required.

PL, IT

delivery_address

Address

The attribute is required.

PL, IT

sender_parcel

Boolean

The attribute is not required.

  • Default value: false

PL, IT

sender_courier

Boolean

The attribute is not required.

  • Default value: false

PL, IT

sender_letter

Boolean

The attribute is not required.

  • Default value: false

PL, IT

Request example

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 curl -X POST https://api-shipx-pl.easypack24.net/v1/address_books/1 -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{ "name": "New name", "first_name": "John", "last_name": "Smith", "email": "some@email.pl", "phone": "123456798", "sender_courier": true, "kind": "receiver", "company_name": "MyCompanyName", "preferred_dropoff_point": "KRA120",  "main_address": { "id": "123", "street": "Malborska", "building_number": "130", "city": "Warsaw", "post_code": "33-333", "country_code": "PL" }, "delivery_address": { "id": "123", "street": "Malborska", "building_number": "134", "city": "Warsaw", "post_code": "33-333", "country_code": "PL" } }'

Response

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 HTTP/1.1 Content-Type: application/json; charset=utf-8 { "id": 7, "first_name": "Jan", "last_name": "Nowak", "email": "jan@nowak.com", "phone": "123456789", "created_at": "2016-02-24T10:38:03.835+01:00", "updated_at": "2016-02-24T10:38:03.835+01:00", "organization_id": 1, "name": "Nowak Corp", "sender_parcel": true, "sender_courier": false, "sender_letter": true, "kind": "receiver", "company_name": "MyCompanyName", "preferred_dropoff_point": "KRA120",  "main_address": { "id": "123", "street": "Malborska", "building_number": "130", "city": "Warsaw", "post_code": "33-666", "country_code": "PO" }, "delivery_address": { "id": "123", "street": "Malborska", "building_number": "140", "city": "Cracow", "post_code": "66-666", "country_code": "AZ" } }

 

Address book deletion

Deleting an existing address book

1 DELETE /v1/address_books/:id

Request example

1 DELETE /v1/address_books/123

Response

1 2 HTTP/1.1 204 NO_CONTENT Content-Type: application/json