Get list of contractors

Allows to get full list of contractors added in Contractors module using Trans.eu Platform.

Url parameters and connection settings

URL: https://api.platform.trans.eu
Endpoint: /ext/partners-api/v1/partners
Method: GET

Headers:

Content-type: application/json
Accept: application/json
Authorization: Bearer {access_token}
Api-key: {unique_app_api-key}

Authorization

Authorization process is described here.

Available filters

List of available filters

company officeId (?filter={“company_id”:{“$eq”:“11111111”}})
company vat number (?filter={“vat_id”:{“$regex”:“PL11111111111111”}})
company country (?filter={“country”:{“$in”:[“pl”]}})
cooperation status — can be either suspended or active (?filter={“cooperation_status”:{“$in”: [“SUSPENDED”]}})

Example response

{
  "page": 4,
  "page_count": 6,
  "page_size": 25,
  "partners": [
    {
      "company": {
        "address": {
          "country": "de",
          "locality": "Berlin",
          "number": null,
          "postal_code": "14979",
          "street": "Street 67"
        },
        "email": "info@trans.eu",
        "fax": "0049 111111111111",
        "financial_verification_status": null,
        "flags": [],
        "id": 12647,
        "name": "Test Spedition GmbH",
        "permissions": {
          "is_authorized": true,
          "is_blocked": false,
          "was_authorized_at_least_once": true
        },
        "roles": [
          "CARRIER"
        ],
        "status": "SUSPENDED",
        "telephone": "0049 111111111110",
        "vat_id": "DE11111111111"
      },
      "groups": [],
      "id": "3f6246fd-45ea-4641-8481-18f8e07bb22d",
      "notes": [
        "note"
      ]
    },
    {
      "next_contractor_example": "next_contractor_example"
    }
  ],
  "total_items": 140
}

Paging

When calling GET method, page should be added as parameter in the URL, for example:

GET https://api.platform.trans.eu/ext/partners-api/v1/partners?page=4