Organization
- Former user (Deleted)
- Michał Machowski
Organization resource represents a company that has a signed agreement for provision of services.
Within the organization the user can manage shipments.
On this page
Structure
Organization resource has the following attributes:
Attribute | Type | Description |
|---|---|---|
| Integer | Organization's ID |
| Integer | Organization owner's ID |
| String | Organization name (company name) |
| String | Tax identification number |
| DateTime | Organization's creation date |
| DateTime | Date of the last update of the organization |
| Array[String] | List of services available for the organization |
| String | Bank account number |
| Address | Organization address |
Structure of the address object:
Attribute | Type | Description |
|---|---|---|
| String | Address object identifier |
| String | Street |
| String | Building number |
| String | Street name |
| String | House number |
| String | City |
| String | Postal code |
| String | Country code |
Organization resource example JSON format:
HTTP/1.1 200 OK
Content-Type: application/json
{
"href": "http://api-shipx-pl.easypack24.net/v1/organizations",
"count": 1,
"page": 1,
"per_page": 100,
"items": [
{
"href": "https://api-shipx-pl.easypack24.net/v1/organizations/1",
"id": 1,
"owner_id": 11,
"name": "ShpiX",
"tax_id": "PL1234567890",
"bank_account_number": null,
"carriers": [
"inpost_locker",
"inpost_letter",
"inpost_courier"
],
"services": [
"inpost_locker_allegro",
"inpost_locker_pass_thru",
"inpost_locker_standard",
"inpost_letter_allegro",
"inpost_courier_palette",
"inpost_courier_allegro",
"inpost_courier_standard",
"inpost_courier_express_1000",
"inpost_courier_express_1200",
"inpost_courier_express_1700",
"inpost_courier_c2c",
"inpost_locker_standard_smart",
"inpost_locker_allegro_smart"
],
"address": {
"id": 123456,
"street": "Pana Tadeusza",
"building_number": "4",
"line1": null,
"line2": null,
"city": "Kraków",
"post_code": "30-727",
"country_code": "PL"
},
"invoice_address": null,
"contact_person": {
"id": 12344,
"email": null,
"phone": null,
"first_name": null,
"last_name": null
},
"created_at": "2016-07-27T12:00:33.923+02:00",
"updated_at": "2023-10-30T12:59:09.555+01:00"
}
]
}
Organization list
Organization list within the given organization:
The resource is paged. More information on the Authorization / Query Collections
GET /v1/organizationsRequest example
$ curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations -H "Authorization: Bearer token" -H 'Content-Type: application/json'Response
Organization details
Retrieving organization information to which the user has access to
Request example
Response
Error information
The response can contain the following errors:
resource_not_found- organization doesn't existtoken_invalid- user has no access to organization
Organization statistics
List of the organization's statistics.
Search criteria
Parameter | Description |
|---|---|
|
|
|
|
|
|
Request example
Response