Locate to Yard
The locate_to_yard API allows the caller to update a trailer’s location to or within the yard.
Regardless of the method used to identify the trailer, the following input is valid:
| Category | Name | Type | Required | Description |
|---|---|---|---|---|
| options | location_barcode | String | Y | Barcode of yard location. |
Trailer Lookup by ID
POST .../entity/trailer/{id}/locate_to_yard/
The caller knows the unique `id` value of the trailer, which is added to the request URL. No additional `parameters` data is required from the request body.
Example Request Body:
{
"options": {
"location_barcode": "LOCN-1"
}
}Trailer Lookup by Filters
POST .../entity/trailer/locate_to_yard/| Category | Name | Type | Required | Description |
|---|---|---|---|---|
| parameters | trailer_nbr | String | Y | Trailer number to be moved. |
| parameters | company_id | Integer | N | Trailer’s company. |
- Only a single trailer may be moved per request.
- The `__in` lookup is not supported for `trailer_nbr`.
- `company_id` additionally supports string lookup by `code` using the
double-underscore notation:
- company_id_code
{
"options": {
"location_barcode": "LOCN-1"
},
"parameters": {
"facility_id": 1,
"company_id_code": "COM-1",
"trailer_nbr": "TRLR-1"
}
}