Endpoints

TransportOrders list

This endpoint returns all the transport orders created by the current authenticated company.

Definition

  • uri: /v5/transportOrders
  • 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 an array with the TransportOrders from the current authenticated company.

The returned objects are an instance of transport order.

{
    data: [
        // array of TransportOrder resources...
    ],
    "links": {
        "first": "https://otm.viatygo.com/v5/transportOrders?page=1",
        "last": "https://otm.viatygo.com/v5/transportOrders?page=5",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 5,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "https://otm.viatygo.com/v5/transportOrders?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "https://otm.viatygo.com/v5/transportOrders",
        "per_page": 10,
        "to": 10,
        "total": 49
    }
}