Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Info |
---|
Warning! Resource is available only in the following countries: PL, IT |
Organization
resource represents a company that has a signed agreement for provision for provision of services.
Within the organization the user can manage shipments.
On this page
Table of Contents |
---|
Structure
Organization
resource has the following attributes:
Attribute | Type | Description | Availability |
---|---|---|---|
| Integer | Organization's ID | PL, IT |
| Integer | Organization owner's ID | PL, IT |
| String | Organization name (company name) | PL, IT |
| String | Tax identification number | PL, IT |
| DateTime | Organization's creation date | PL, IT |
| DateTime | Date of the last update of the organization | PL, IT |
| Array[String] | List of services available for the organization | PL, IT |
| String | Bank account number | PL, IT |
| Address | Organization address | PL, IT |
Structure of the address
object:
Attribute | Type | Description | Availability |
---|---|---|---|
| String | Address object identifier | PL, IT |
| String | Street | PL, IT |
| String | Building number | PL, IT |
| String | Street name | PL, IT |
| String | House number | PL, IT |
| String | City | PL, IT |
| String | Postal code | PL, IT |
| String | Country code | PL, IT |
Organization
resource example JSON format:
Code Block | ||
---|---|---|
| ||
{
"href": "https://api.shipx.pl.easypack24.net/v1/organizations/34",
"id": 34,
"owner_id": 1,
"tax_id": "3973902075",
"name": "Random org name39739020755741",
"created_at": "2016-10-04T10:36:49.631+02:00",
"updated_at": "2016-10-04T10:36:49.631+02:00",
"services": [
"inpost_locker_standard",
"inpost_courier_standard"
],
"address": {
"id": 808,
"line1": null,
"line2": null,
"street": "Ulica jakaś39739020755741",
"building_number": "Budynek39739020755741",
"city": "Szczecin39739020755741",
"post_code": "22-100",
"country_code": "PL"
}
} |
Authentication
Resource access requires an
active access token.
Organization list
Organization list within the given organization:
Info |
---|
The resource is paged. More information on the |
Code Block | ||
---|---|---|
| ||
GET /v1/organizations |
Request example
Code Block | ||
---|---|---|
| ||
$ curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations -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/organizations",
"count": 100,
"page": 1,
"per_page": 30,
"items": [
{
"href": "https://api-shipx-pl.easypack24.net/v1/organizations/1",
"id": 1,
... other organization's attributes omitted for brevity ...
},
... other collection's items omitted for brevity ...
]
} |
Organization details
Retrieving organization information to which the user has access to
Code Block | ||
---|---|---|
| ||
GET /v1/organizations/:id |
Request example
Code Block | ||
---|---|---|
| ||
$ curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1 -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/organizations/34",
"id": 34,
"owner_id": 1,
"tax_id": "3973902075",
"name": "Random org name39739020755741",
"created_at": "2016-10-04T10:36:49.631+02:00",
"updated_at": "2016-10-04T10:36:49.631+02:00",
"services": [
"inpost_locker_standard",
"inpost_courier_standard"
],
"address": {
"id": 808,
"line1": null,
"line2": null,
"street": "Ulica jakaś39739020755741",
"building_number": "Budynek39739020755741",
"city": "Szczecin39739020755741",
"post_code": "22-100",
"country_code": "PL"
}
} |
Warning |
---|
Error information The response can contain the following errors:
|
Organization statistics
List of the organization's statistics.
Code Block | ||
---|---|---|
| ||
GET /v1/organizations/:organization_id/statistics |
Search criteria
Parameter | Description | Availability | |||||
---|---|---|---|---|---|---|---|
|
| PL, IT | |||||
|
| PL, IT | |||||
|
| PL, IT |
Request example
Code Block | ||
---|---|---|
| ||
curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/statistics -H 'Authorization: Bearer token' -H 'Content-Type: application/json' |
Response
Code Block | ||
---|---|---|
| ||
{
"to_send": 23,
"in_logistics": 31,
"delivered": 58
} |