Listing Customers and Subcontractors

This endpoint enables you to:

check which companies are in your visibility network
know what’s the onboarding status of your (sub-)contractors.

To list all partners (ie. customers and/or subcontractors), make an authenticated GET request as shown in the example below.

The response will contain a list of companies with the following attributes:

company_id: The Transporeon company id.
company_name: The name of the company as maintained in the Transporeon master data.
vat_numbers: One to many VAT numbers that can be used to identify the company.
onboarding_status: Describes whether this company is ready to provide visibility.
- onboarded - Whether this company is onboarded successfully and ready to provide visibility.
- label: Human readable label of the onboarding status. Can be any string and the values returned are a subject to change in the future.
  Examples: not_registered, registered, onboarded, onboarding_stuck
- in_progress: The onboarding is currently in progress (e.g. while setting up the telematics / API connection).
- is_blocked: Is set to true if it takes way longer than intended for the company to complete the onboarding process.
relation_reference_names: Lists the reference names assigned to the company during the invitation process.
relation_identifiers: The relation identifiers you have defined to link the partner with your operations.
- identifier_value: The value of the identifier.

https://api.transporeon.com/rtv/v1/partners

{
    "partners": [
        {
            "company_id": "406384",
            "company_name": "Schmetterling Logistics GmbH",
            "vat_numbers": [
       			{
					"value": "DE43434343"
 				}
			],
			"onboarding_status": {         
 				"onboarded": false,
				"label": "registered",
				"is_blocked": false,
				"in_progress": true
			},
			"relation_reference_names": ["Schmetterling Logistics"],
			"relation_identifiers": [
				{
					"identifier_value": "SLGH"
				}
			],
        {
            "company_id": "410794",
            "company_name": "Berlin Beverages UAB",
            "vat_numbers": [],
			"onboarding_status": {
				"onboarded": true,
				"label": "onboarded",
				"is_blocked": false,
				"in_progress": false
			},
		},
	 	{
     		…
 		}
    ]
}