This endpoint creates a new transport order for the current authenticated company.

Definition

uri: /v5/transportOrders
method: PUT
authentication: Bearer-token for company-based authentication

Parameters

All parameters that should be given with te PUT request can be found here.

Responses

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

201: Created

The endpoint creates a transport order and returns the created TransportOrders object.

The returned object is an instance of transport order.

{
    "externalAttributes": {
        "id": "test-uuid"
    },
    "consignments": [
        {
            "associationType": "inline",
            "entity": {
                "description": "This is a test consignment.",
                "externalAttributes": {
                    "reference": "#A12345",
                    "maximumPrice": {
                        "value": 250.75,
                        "currency": "EUR"
                    }
                },
                "constraint": {
                    "associationType": "inline",
                    "entity": {
                        "value": {
                            "type": "routeConstraint",
                            "route": {
                                "type": "addressGeoReference",
                                "street": "Raamdwarsstraat",
                                "houseNumber": "7",
                                "houseNumberAddition": "H",
                                "postalCode": "1016XN",
                                "city": "Amsterdam",
                                "country": "NL"
                            }
                        }
                    }
                },
                "goods": [
                    {
                        "entity": {
                            "externalAttributes": {
                                "productTypeId": 276383,
                                "packagingMaterialId": 178464
                            },
                            "productType": "Puin",
                            "packagingMaterial": "3m3",
                            "type": "items"
                        },
                        "associationType": "inline"
                    }
                ],
                "documents": [
                    {
                        "entity": {
                            "name": "Location #A044",
                            "externalAttributes": {
                                "documentType": "location"
                            },
                            "content": {
                                "uri": "https://location.com/A",
                                "contentType": "link"
                            },
                            "filename": "location_#A0044.png",
                            "mimeType": "image/png"
                        },
                        "associationType": "inline"
                    }
                ],
                "actions": [
                    {
                        "associationType": "inline",
                        "entity": {
                            "actionType": "unload",
                            "constraint": {
                                "associationType": "inline",
                                "entity": {
                                    "value": {
                                        "type": "timeWindowConstraint",
                                        "startTime": "2022-11-30T10:00:00Z",
                                        "endTime": "2022-11-30T15:00:00Z"
                                    }
                                }
                            }
                        }
                    }
                ],
                "actors": [
                    {
                        "associationType": "inline",
                        "roles": "Receiver",
                        "entity": {
                            "name": "Coen de Rijter",
                            "contactDetails": [
                                {
                                    "type": "phone",
                                    "remark": "Phone number of contact person",
                                    "value": "088227723"
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ],
    "actors": [
        {
            "associationType": "inline",
            "roles": "Consignor",
            "entity": {
                "name": "Bluey B.V.",
                "contactDetails": [
                    {
                        "type": "coc",
                        "remark": "CoC number",
                        "value": 54554
                    }
                ]
            }
        }
    ],
    "type": "items"
}