Remove from Yard
The remove_from_yard API allows the caller to release a trailer from its current yard location.
Trailer Lookup by ID
POST .../entity/trailer/{id}/remove_from_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.
Trailer Lookup by Filters
POST .../entity/trailer/remove_from_yard/
Category | Name | Type | Required | Description |
---|---|---|---|---|
parameters | trailer_nbr | String | Y | Trailer number to be removed. |
parameters | facility_id | Integer | N | Trailer’s facility. |
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`.
- `facility_id` and `company_id` both additionally support string lookup by
`code` using the double-underscore notation:
- facility_id__code
- company_id_code
{
"parameters": {
"facility_id": 1,
"company_id_code": "COM-1",
"trailer_nbr": "TRLR-1"
}
}