Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Info | |
---|---|
title | Warning! Resource is available only in the following countries: PL, IT |
AddressBook
resource resource represents an address book assigned to organization
.
On this page
Table of Contents |
---|
Structure
AddressBook
resource has the following attributes:
Attribute | Type | Description | Availability |
---|---|---|---|
| Integer | unique identifier | PL, IT |
| String | name of entry, unique in the context of the organization. | PL, IT |
| String | First name | PL, IT |
| String | Last name | PL, IT |
| String | Phone | PL, IT |
| String | E-mail address | PL, IT |
| Integer | organization ID which owns this entry | PL, IT |
| Address | Addressee's main address | PL, IT |
| Address | Shipment delivery address | PL, IT |
| Boolean | Paczkomat parcel station shipment sender | PL, IT |
| Boolean | Courier shipment sender | PL, IT |
| Boolean | Letter shipment sender | PL, IT |
| String | Type of entry | PL, IT |
| String | Company name | PL, IT |
| String | Preferred shipping point | PL, IT |
| DateTime | Address book creation date and time. | PL, IT |
| DateTime | Last address book update date and time. | PL, IT |
AddressBook resource example JSON format:
Code Block | ||
---|---|---|
| ||
{
"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 list
Address book list within the given organization:
Code Block | ||
---|---|---|
| ||
GET /v1/organizations/:organization_id/address_books |
Request example
Code Block | |
---|---|
|
| |
curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/address_books -H "Authorization: Bearer token" -H "Content-Type: application/json"
|
Response
Code Block | ||
---|---|---|
| ||
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
Code Block | ||
---|---|---|
| ||
GET /v1/address_books/:id |
Request example
Code Block | ||
---|---|---|
| ||
curl -X GET https://api-shipx-pl.easypack24.net/v1/address_books/1 -H 'Authorization: Bearer token' -H 'Content-Type: application/json' |
Response
Code Block | ||
---|---|---|
| ||
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
Code Block | ||
---|---|---|
| ||
POST v1/organizations/:organization_id/address_books |
Parameters
Parameter | Type | Description | Availability |
---|---|---|---|
| String | The attribute is required.
| PL, IT |
| String | The attribute is required.
| PL, IT |
| String | The attribute is required. |
|
PL, IT | |||
| String | The attribute is required.
| PL, IT |
| String | The attribute is required. |
|
| PL, IT | |
| String | The attribute is required.
|
| PL, IT | ||
| String | The attribute is not required.
| PL, IT |
| String | The attribute is not required.
| PL, IT |
| Address | The attribute is required. | PL, IT |
| Address | The attribute is required. | PL, IT |
| Boolean | The attribute is not required.
| PL, IT |
| Boolean | The attribute is not required.
| PL, IT |
| Boolean | The attribute is not required.
| PL, IT |
Request example
Code Block | ||
---|---|---|
| ||
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
Code Block | ||
---|---|---|
| ||
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
Code Block | ||
---|---|---|
| ||
PUT /v1/address_books/:id |
Parameters
Parameter | Type | Description | Availability |
---|---|---|---|
| String | The attribute is required.
| PL, IT |
| String | The attribute is required.
| PL, IT |
| String | The attribute is required.
| PL, IT |
| String | The attribute is required.
| PL, IT |
| String | The attribute is required.
| PL, IT |
kind | String | The attribute is required.
|
| PL, IT | ||
| String | The attribute is not required.
| PL, IT |
| String | The attribute is not required.
| PL, IT |
| Address | The attribute is required. | PL, IT |
| Address | The attribute is required. | PL, IT |
| Boolean | The attribute is not required.
| PL, IT |
| Boolean | The attribute is not required.
| PL, IT |
| Boolean | The attribute is not required.
| PL, IT |
Request example
Code Block | ||
---|---|---|
| ||
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
Code Block | ||
---|---|---|
| ||
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
Code Block | ||
---|---|---|
| ||
DELETE /v1/address_books/:id |
Request example
Code Block | ||
---|---|---|
| ||
DELETE /v1/address_books/123 |
Response
Code Block | ||
---|---|---|
| ||
HTTP/1.1 204 NO_CONTENT
Content-Type: application/json |