1. Trans.eu Api
  2. Freights section
  3. Get private exchanges list

Get private exchanges list

Down­load­ing a list of pri­vate exchanges (not brand­ed) ded­i­cat­ed for your com­pa­ny.

The response con­tains a pri­vate exchange ID that is required for the sub­se­quent pub­li­ca­tion request.

GET
/ext/private-exchange-api/v1/exchange
Request Authorization

Every request MUST include a valid access token obtained dur­ing the user autho­riza­tion process, pro­vid­ed using the Bear­er token scheme in the Autho­riza­tion head­er.

Request

Request Head­er

Successful Response

Response Fields

Response Body

Error Response

Client errors (400)

Gen­er­al API errors

Request Header
GET /ext/private-exchange-api/v1/exchange HTTP/1.1 
Host: api.platform.trans.eu 
Content-Type: application/json
Accept: application/json
Authorization: Bearer {access_token) 
Api-key: {unique_app_api-key}
Response Fields
AttributeTypeExam­pleDescrip­tion
exchangesArray of ObjectsCon­tain­er with pri­vate exchange descrip­tion
exchanges.createdString“2021–09-09T06:06:25+00:00”Date of cre­ation of the exchange
exchanges.idString“051d6148-903a-4735-bc57-feebfd­d8c900”Pri­vate exchange ID
exchanges.nameString“Pri­vate”Pri­vate exchange name
has_next_pageBooleanFalseIndi­cates whether there are sub­se­quent pages
pageInt1Cur­rent page num­ber
page_sizeInt1Page size
Response Body
{
    "exchanges": [
        {
            "created": "2021-10-07T11:17:21.000+00:00",
            "id": "49b9aa2b-1987-48d9-9a77-147f97594233",
            "name": "Prywatna"
        }
    ],
    "has_next_page": false,
    "page": 1,
    "page_size": 1
}

Client errors (code 400)

HTTP 4xx sta­tus codes indi­cate client errors, mean­ing that the request could not be processed due to an issue on the client side. Below is a list of request-spe­cif­ic errors.

Example response 1

No pri­vate exchanges

{
    "exchanges": [],
    "has_next_page": false,
    "page": 1,
    "page_size": 0
}