Locate to Yard

The locate_to_yard API allows the caller to update a trailer’s location within the yard.

Input Parameters

Common Parameter (Applicable to All Requests)

Category	Name	Type	Required	Description
options	location_barcode	String	Yes	Barcode of the yard location.

Trailer Lookup by ID

This method requires the unique id of the trailer in the request URL. No additional parameters are required in the request body.

URL

POST… /entity/trailer/{id}/locate_to_yard/

Example Request Body

{
 "options": {
    "location_barcode":
      "YARDAJ0101"
 }
}

Trailer Lookup by Filters

URL: POST… /entity/trailer/locate_to_yard/Input Parameters

Category	Name	Type	Required	Description
parameters	trailer_nbr	String	Yes	Trailer number to be moved.
parameters	company_id	Integer	No	Trailer’s company identifier.

Additional Notes

• Only a single trailer may be moved per request.
• The __in lookup is not supported for trailer_nbr.
• company_id also supports string lookup by code using double-underscore notation:
• company_id__code

Example Request Body

{
 "options": {
    "location_barcode":
      "YARDAJ0101"
 },
 "parameters": {
 "company_id__code": "QATSTPC",
 "trailer_nbr": "JPTRL280225-1"
 }
}

Response Codes

Status Code	Description
200 OK	Trailer location updated successfully.