Endpoints

TransportOrders view

This endpoint returns a transport order for the current authenticated company.

Definition

  • uri: /v5/transportOrders/{uuid}
  • method: GET
  • authentication: Bearer-token for company-based authentication

Responses

Besides the default responses, the following responses are specific for this endpoint.

200: successful

The endpoint returns a TransportOrders object based on a unique uuid given in the uri.

The returned object is an instance of transport order.

{
  "id": "36d591dd-7b4e-4d22-9cee-17bbf38181e1",
  "externalAttributes": [],
  "consignments": [
    {
      "entity": {
        "name": "Assignment #A0043",
        "status": "requested",
        "externalAttributes": {
          "price": {
            "value": "40.00",
            "currency": "EUR"
          },
          "maximumPrice": {
            "value": "250.75",
            "currency": "EUR"
          }
        },
        "goods": [
          {
            "entity": {
              "productType": "Puin",
              "packagingMaterial": "3m3",
              "type": "items"
            },
            "associationType": "inline"
          }
        ],
        "documents": [
          // array of Document resources...
        ],
        "actions": [
          // array of Action resources...
        ]
      },
      "associationType": "inline"
    }
  ],
  "actors": [
    {
      "entity": {
        "id": "b1de26d6-59d4-11ed-9b6a-0242ac12000",
        "name": "viaTYGO B.V.",
        "contactDetails": [
          {
            "value": 89194101,
            "remark": "Chamber of Commerce number",
            "type": "other"
          }
        ]
      },
      "roles": "Consignor",
      "associationType": "inline"
    }
  ],
  "constraint": {
    "associationType": "inline",
    "entity": {
      "value": {
        "type": "routeConstraint",
        "route": {
          "type": "addressGeoReference",
          "street": "Raamdwarsstraat",
          "houseNumber": "7",
          "houseNumberAddition": "H",
          "postalCode": "1016XN",
          "city": "Amsterdam",
          "country": "NL"
        }
      }
    }
  }
}