[1.23.0] Address book

Warning!

Resource is available only in the following countries: PL, IT

AddressBook resource represents an address book assigned to organization.

On this page

1 Structure
2 Authentication
3 Address book list
4 Address book details
5 Address book creation
6 Address book editing
7 Address book deletion

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:

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

GET /v1/organizations/:organization_id/address_books

Request example

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

Response

Address book details

Retrieving address book information to which the user has access to

Request example

Response

Address book creation

Creating a new address book for organization

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

Response

Address book editing

Edition of an existing address book

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

Response

Address book deletion

Deleting an existing address book

Request example

Response