Action load

This endpoint adds a pickup date for a transport order.

Definition

• uri: /v5/actions
• 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 returns a TransportOrder object based on the transportOrderUuid given in the JSON.

The returned object is an instance of transport order with the pickup date and time added.

{
  "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": [
          {
            "entity": {
              "id": "80cfa134-77d5-4f0f-a604-4b7ea8ce1487",
              "name": "who-i-am-square.png",
              "externalAttributes": {
                "documentType": "location"
              },
              "content": {
                "url": "app.viatygo.com/documents/80cfa134-77d5-4f0f-a604-4b7ea8ce1487/public/open?expires=1667309041&signature=6fc92324d81b0e9ce2c4fcfeed94e1642268cd11789d38e5205aaee54da77646",
                "contentType": "link"
              },
              "filename": "who-i-am-square.png",
              "mimeType": "image/png",
              "owner": {
                "uuid": "9ee0017e-47ed-462a-99a8-a27098dedfc7",
                "entityType": "actor",
                "associationType": "reference"
              }
            },
            "associationType": "inline"
          },
          {
            "entity": {
              "id": "1f7264b8-e8f7-4dce-a24f-e24e5363545b",
              "name": "background.png",
              "externalAttributes": {
                "documentType": "unknown"
              },
              "content": {
                "url": "app.viatygo.com/documents/1f7264b8-e8f7-4dce-a24f-e24e5363545b/public/open?expires=1667309041&signature=d5c4a4e07361cf80b9622bb93c9fd4a8dd720ca5180debc44377e0bdb23767ca",
                "contentType": "link"
              },
              "filename": "background.png",
              "mimeType": "image/png",
              "owner": {
                "uuid": "9ee0017e-47ed-462a-99a8-a27098dedfc7",
                "entityType": "actor",
                "associationType": "reference"
              }
            },
            "associationType": "inline"
          }
        ],
        "actions": [
          {
            "entity": {
              "actionType": "unload",
              "constraint": {
                "entity": {
                  "value": {
                    "type": "timeWindowConstraint",
                    "startTime": "2022-11-30T09:00:00Z",
                    "endTime": "2022-11-30T14:00:00Z"
                  }
                },
                "associationType": "inline"
              }
            },
            "associationType": "inline"
          },
          {
            "entity": {
              "actionType": "load",
              "constraint": {
                "entity": {
                  "value": {
                    "type": "timeWindowConstraint",
                    "startTime": "2022-12-01T08:00:00Z",
                    "endTime": "2022-12-01T13:15:00Z"
                  }
                },
                "associationType": "inline"
              }
            },
            "associationType": "inline"
          }
        ]
      },
      "associationType": "inline"
    }
  ],
  "actors": [
    {
      "entity": {
        "id": "9ee0017e-47ed-462a-99a8-a27098dedfc7",
        "name": "Bluey B.V.",
        "contactDetails": [
          {
            "value": 54554,
            "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"
        }
      }
    }
  }
}