[1.23.0] Organization

Warning!

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

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:

AttributeTypeDescriptionAvailability
idIntegerOrganization's IDPL, IT
owner_idIntegerOrganization owner's IDPL, IT
nameStringOrganization name (company name)PL, IT
tax_idStringTax identification numberPL, IT
created_atDateTimeOrganization's creation datePL, IT
updated_atDateTimeDate of the last update of the organizationPL, IT
servicesArray[String]List of services available for the organizationPL, IT

bank_account_number 

StringBank account numberPL, IT
addressAddress

Organization address

AttributeTypeDescriptionAvailability
id StringAddress object identifierPL, IT

line1 

StringStreetPL, IT

line2 

StringBuilding numberPL, IT
street StringStreet namePL, IT
building_number StringHouse numberPL, IT

city 

StringCityPL, IT

post_code 

StringPostal codePL, IT

country_code 

StringCountry codePL, IT
PL, IT

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"
  }
}



Organization list

Organization list within the given organization:

(info) The resource is paged. More information on the 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 ...
	]
}



Organization details

Retrieving organization information to which the user has access to

GET /v1/organizations/:id

Request example

$ curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1 -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/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
  • token_invalid - user has no access to organization



Organization statistics

List of the organization's statistics.

GET /v1/organizations/:organization_id/statistics

Search criteria

ParameterDescriptionAvailability
to_send
  • Returns the number of the organization's shipments to be shipped.

  • Shipment statuses:

    created, 
    offers_prepared, 
    offer_selected, 
    confirmed

     

PL, IT
in_logistics
  • Returns the number of the organization's shipments in the logistic process.

  • Shipment statuses:

    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
PL, IT
delivered
  • Returns the number of the organization's delivered shipments.

  • Shipment statuses: delivered   

PL, IT

Request example

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

Response

{
  "to_send": 23,
  "in_logistics": 31,
  "delivered": 58
}