You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 7 Next »
Organization resource represents a company that has a signed agreement for provision of services.
Organization
Within the organization the user can manage shipments.
On this page
Organization resource has the following attributes:
Attribute
Type
Description
id
Integer
Organization's ID
owner_id
Organization owner's ID
name
String
Organization name (company name)
tax_id
Tax identification number
created_at
DateTime
Organization's creation date
updated_at
Date of the last update of the organization
services
Array[String]
List of services available for the organization
bank_account_number
Bank account number
address
Address
Organization address
Structure of the address object:
Address object identifier
line1
Street
line2
Building number
street
Street name
building_number
House number
city
City
post_code
Postal code
country_code
Country code
Organization resource example JSON format:
{ "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" } }
Resource access requires an active access token.
Organization list within the given organization:
The resource is paged. More information on the [1.3.0] API General Information
GET /v1/organizations
Request example
$ curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations -H "Authorization: Bearer token" -H 'Content-Type: application/json'
Response
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 ... ] }
Retrieving organization information to which the user has access to
GET /v1/organizations/:id
$ curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1 -H "Authorization: Bearer token" -H 'Content-Type: application/json'
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" } }
Error information
The response can contain the following errors:
resource_not_found - organization doesn't exist
resource_not_found
token_invalid - user has no access to organization
token_invalid
List of the organization's statistics.
GET /v1/organizations/:organization_id/statistics
Search criteria
Parameter
to_send
Returns the number of the organization's shipments to be shipped.
Shipment statuses:
created, offers_prepared, offer_selected, confirmed
in_logistics
Returns the number of the organization's shipments in the logistic process.
dispatched_by_sender, collected_from_sender, taken_by_courier, adopted_at_source_branch, sent_from_source_branch, adopted_at_sorting_center, sent_from_sorting_center, adopted_at_target_branch, out_for_delivery, ready_to_pickup, pickup_reminder_sent, pickup_time_expired, avizo, claimed, returned_to_sender
delivered
Returns the number of the organization's delivered shipments.
Shipment statuses: delivered
curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/statistics -H 'Authorization: Bearer token' -H 'Content-Type: application/json'
{ "to_send": 23, "in_logistics": 31, "delivered": 58 }