TFS API Endpoints Reference

Version: 1

Base URL: https://tfs.system.trans.eu/api/rest/v1

Resources

TFS

Get dedicated order

Scopes

tfs.dedicated-orders.basic.read

Endpoint

GET /dedicated-orders/{order-id}

Query parameters

Param	Type	Description	Required
order-id	String	Order identifier received with POST response in `id` field	yes

Responses

Http status	Description
200	Returned the dedicated order entity
400	Bad request
401	Unauthorized
403	Forbidden (i.e. wrong or missing access token)
404	Dedicated order not found
500	Internal Server Error

Response data structure

Property	Type	Description
id	String	Unique order id (as UUID)
number	String	Assigned order number (unique in scope of company)
status	String	{`pending`,`accepted`}
route	Object (Route)	Route details
payment	Object (Payment)	Payment details
carrier	Object (Contractor)	Carrier details
shipper	Object (Contractor)	Shipper details
loads	Array (of Load)	Loads details
_links	Object	External resources references

Route object structure

Field	Type	Description
events	Array (of RouteEvent)	Sorted list of route events

RouteEvent object structure

Field	Type	Description
place	Object (Place)	Details of event place
type	Enum	Event type. Possible values: `loading`, `unloading`

Place object structure

Field	Type	Description
address	Object (Address)	Address details

Address object structure

Field	Type	Description
locality	String	City name
postal_code	String	Postal code
country	String	Country code in format ISO 3166-1 alpha-2

Payment object structure

Field	Type	Description
price	Object (Price)	Price definition
date_interval	String	Payment date interval in days, ISO 8601 formatted (see PHP DateInterval for more information)

Price object structure

Field	Type	Description
value	Number	Price value
currency	String	Price currency (ISO 4217)

Contractor object structure

Field	Type	Description
company	Object (Company)	Contractor company details
contact_person	Object (ContactPerson)	Contact person details

Company object structure

Field	Type	Description
name	String	Company name
vat_id	String	Company VAT id
address	Object (Address)	Company address details

ContactPerson object structure

Field	Type	Description
given_name	String	Person's given name
family_name	String	Person's last name
email	String	E-mail address
telephone	String	Telephone number in format: `(XX) XXXXXXXXX`

Load object structure

Field	Type	Description
weight	Object (Weight)	Load weight details

Weight object structure

Field	Type	Description
value	Number	Weight value
unit	String	Weight unit Possible values: `TNE` (tons)

Example

GET /api/rest/v1/dedicated-orders/123e4567-e89b-12d3-a456-426655440000 HTTP/1.1
Host: tfs.system.trans.eu
Accept: application/hal+json
Authorization: Bearer {access_token}

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "id": "123e4567-e89b-12d3-a456-426655440000",
    "number": "PL/2016/05/05/1234",
    "route": {
        "events": [
            {
                "place": {
                    "address": {
                        "locality": "Wrocław",
                        "postal_code": "12-345",
                        "country": "PL"
                    }
                },
                "type": "loading"
            },
            {
                "place": {
                    "address": {
                        "locality": "Warszawa",
                        "postal_code": "54-321",
                        "country": "PL"
                    }
                },
                "type": "unloading"
            }
        ]
    },
    "payment": {
        "price": {
            "value": 50,
            "currency": "PLN"
        },
        "date_interval": "P10D"
    },
    "loads" : [
        {
            "weight" : {
                "value" : 23,
                "unit" : "T"
            }
        },
        {
            "weight" : {
                "value" : 4,
                "unit" : "T"
            }
        }
    ],
    "_links": {
        "self": {
            "href": "https://tfs.system.trans.eu/api/rest/v1/dedicated-orders/123e4567-e89b-12d3-a456-426655440000"
        }
    }
}

Dedicated Orders

Add dedicated order