Update
PATCH
/api/yard/{yardId}/movement/{id}
Headers
-
Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)
Body
-
attachment_ids array[integer(int64)]
-
attachment_picture_ids array[integer(int64)]
-
chassis_number string
-
chassis_size string
-
comments string
-
damage string
-
damage_asset_type string
-
damage_attachment_ids array[integer(int64)]
-
damage_picture_ids array[integer(int64)]
-
damage_reference string
-
destination string
-
direction string Required
Values are
INorOUT. -
driver_id integer(int64)
-
driver_license string
-
driver_license_expiration string(date-time)
-
driver_license_picture_id integer(int64)
-
driver_name string
-
driver_notification_email string
-
driver_notification_phone string
-
Values are
EMAIL,SMS, orWHATSAPP. -
driver_photo_id integer(int64)
-
extra_trailers array[object]
-
inside_trailer_picture_id integer(int64)
-
left_trailer_image_id integer(int64)
-
load string
-
main_trailer object
-
movement_timestamp string(date-time)
-
no_seal boolean
-
other_trailer_carrier string
-
other_truck_carrier string
-
precheck_id integer(int64)
If the movement was created from a precheck, the id of the precheck should be sent in this field
-
purpose string
-
rear_trailer_picture_id integer(int64)
-
right_trailer_image_id integer(int64)
-
seal string
-
seal_picture_ids array[integer(int64)]
-
shipment_id string
-
sku string
-
spare_tire_truck_photo_id integer(int64)
-
status string
Values are
EMPTY,LOADED, orNO_TRAILER. -
trailer string
-
trailer_carrier_id integer(int64)
-
trailer_client string
-
trailer_id integer(int64)
-
trailer_location object
-
trailer_number_inference string
If the trailer number was scanned by a computer vision model, this field should contain the inferred trailer number. The inferred trailer number should be provided in all cases, no matter whether the recognition was successful or not
-
trailer_priority boolean
-
trailer_type string
-
truck_carrier_id integer(int64)
-
truck_fuel_type string
Values are
CNG,DIESEL,ELECTRIC, orHYDROGEN. -
truck_id integer(int64)
-
truck_image_id integer(int64)
-
truck_left_photo_id integer(int64)
-
truck_number string
-
truck_right_photo_id integer(int64)
-
truck_type string
Values are
BOX,PICKUP, orSEMI. -
vehicle_image_id integer(int64)
-
visit_type string
Values are
TRACTORorVEHICLE.
PATCH /api/yard/{yardId}/movement/{id}
curl \
-X PATCH https://api-dev.gatego.io:443/api/yard/{yardId}/movement/{id} \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"attachment_ids":[42],"attachment_picture_ids":[42],"chassis_number":"string","chassis_size":"string","comments":"string","damage":"string","damage_asset_type":"string","damage_attachment_ids":[42],"damage_picture_ids":[42],"damage_reference":"string","destination":"string","direction":"IN","driver_id":42,"driver_license":"string","driver_license_expiration":"2023-05-04T09:42:00+00:00","driver_license_picture_id":42,"driver_name":"string","driver_notification_email":"string","driver_notification_phone":"string","driver_notification_preference_channel":"EMAIL","driver_photo_id":42,"extra_trailers":[{"carrier_id":42,"client":"string","id":42,"inside_picture_id":42,"left_image_id":42,"no_seal":true,"number":"string","number_inference":"string","other_carrier":"string","priority":true,"rear_picture_id":42,"right_image_id":42,"seal":"string","seal_picture_ids":[42],"status":"EMPTY","type":"string"}],"inside_trailer_picture_id":42,"left_trailer_image_id":42,"load":"string","main_trailer":{"carrier_id":42,"client":"string","id":42,"inside_picture_id":42,"left_image_id":42,"no_seal":true,"number":"string","number_inference":"string","other_carrier":"string","priority":true,"rear_picture_id":42,"right_image_id":42,"seal":"string","seal_picture_ids":[42],"status":"EMPTY","type":"string"},"movement_timestamp":"2023-05-04T09:42:00+00:00","no_seal":true,"other_trailer_carrier":"string","other_truck_carrier":"string","precheck_id":42,"purpose":"string","rear_trailer_picture_id":42,"right_trailer_image_id":42,"seal":"string","seal_picture_ids":[42],"shipment_id":"string","sku":"string","spare_tire_truck_photo_id":42,"status":"EMPTY","trailer":"string","trailer_carrier_id":42,"trailer_client":"string","trailer_id":42,"trailer_location":{"level":"string","row":"string","values":["string"],"zone":"string"},"trailer_number_inference":"string","trailer_priority":true,"trailer_type":"string","truck_carrier_id":42,"truck_fuel_type":"CNG","truck_id":42,"truck_image_id":42,"truck_left_photo_id":42,"truck_number":"string","truck_right_photo_id":42,"truck_type":"BOX","vehicle_image_id":42,"visit_type":"TRACTOR"}'
Request example
# Headers
# Payload
{
"attachment_ids": [
42
],
"attachment_picture_ids": [
42
],
"chassis_number": "string",
"chassis_size": "string",
"comments": "string",
"damage": "string",
"damage_asset_type": "string",
"damage_attachment_ids": [
42
],
"damage_picture_ids": [
42
],
"damage_reference": "string",
"destination": "string",
"direction": "IN",
"driver_id": 42,
"driver_license": "string",
"driver_license_expiration": "2023-05-04T09:42:00+00:00",
"driver_license_picture_id": 42,
"driver_name": "string",
"driver_notification_email": "string",
"driver_notification_phone": "string",
"driver_notification_preference_channel": "EMAIL",
"driver_photo_id": 42,
"extra_trailers": [
{
"carrier_id": 42,
"client": "string",
"id": 42,
"inside_picture_id": 42,
"left_image_id": 42,
"no_seal": true,
"number": "string",
"number_inference": "string",
"other_carrier": "string",
"priority": true,
"rear_picture_id": 42,
"right_image_id": 42,
"seal": "string",
"seal_picture_ids": [
42
],
"status": "EMPTY",
"type": "string"
}
],
"inside_trailer_picture_id": 42,
"left_trailer_image_id": 42,
"load": "string",
"main_trailer": {
"carrier_id": 42,
"client": "string",
"id": 42,
"inside_picture_id": 42,
"left_image_id": 42,
"no_seal": true,
"number": "string",
"number_inference": "string",
"other_carrier": "string",
"priority": true,
"rear_picture_id": 42,
"right_image_id": 42,
"seal": "string",
"seal_picture_ids": [
42
],
"status": "EMPTY",
"type": "string"
},
"movement_timestamp": "2023-05-04T09:42:00+00:00",
"no_seal": true,
"other_trailer_carrier": "string",
"other_truck_carrier": "string",
"precheck_id": 42,
"purpose": "string",
"rear_trailer_picture_id": 42,
"right_trailer_image_id": 42,
"seal": "string",
"seal_picture_ids": [
42
],
"shipment_id": "string",
"sku": "string",
"spare_tire_truck_photo_id": 42,
"status": "EMPTY",
"trailer": "string",
"trailer_carrier_id": 42,
"trailer_client": "string",
"trailer_id": 42,
"trailer_location": {
"level": "string",
"row": "string",
"values": [
"string"
],
"zone": "string"
},
"trailer_number_inference": "string",
"trailer_priority": true,
"trailer_type": "string",
"truck_carrier_id": 42,
"truck_fuel_type": "CNG",
"truck_id": 42,
"truck_image_id": 42,
"truck_left_photo_id": 42,
"truck_number": "string",
"truck_right_photo_id": 42,
"truck_type": "BOX",
"vehicle_image_id": 42,
"visit_type": "TRACTOR"
}
Response examples (200)
{
"attachment_ids": [
42
],
"attachment_picture_ids": [
42
],
"chassis_number": "string",
"chassis_size": "string",
"comments": "string",
"created_at": "2023-05-04T09:42:00+00:00",
"created_by": "string",
"destination": "string",
"direction": "IN",
"driver_id": 42,
"driver_license": "string",
"driver_license_picture_id": 42,
"driver_name": "string",
"driver_notification_email": "string",
"driver_notification_phone": "string",
"driver_notification_preference_channel": "EMAIL",
"driver_photo_id": 42,
"extra_trailers": [
{
"carrier_id": 42,
"carrier_name": "string",
"client": "string",
"destination": "string",
"id": 42,
"inside_picture_id": 42,
"left_image_id": 42,
"load": "string",
"movement_id": 42,
"movement_trailer_number": "string",
"no_seal": true,
"number": "string",
"other_carrier": "string",
"priority": true,
"purpose": "string",
"rear_picture_id": 42,
"right_image_id": 42,
"seal": "string",
"seal_picture_ids": [
42
],
"shipment_id": "string",
"sku": "string",
"status": "EMPTY",
"status_desc": "string",
"tags": [
{
"color": "string",
"created_at": "2023-05-04T09:42:00+00:00",
"id": 42,
"last_modified_at": "2023-05-04T09:42:00+00:00",
"name": "string"
}
],
"trailer_location": {
"level": "string",
"row": "string",
"values": [
"string"
],
"zone": "string"
},
"trailer_out_movement_id": 42,
"trailer_stay_seconds": 42,
"type": "string"
}
],
"id": 42,
"inside_trailer_picture_id": 42,
"inspections": [
{
"attachments": [
{
"attachment_id": 42,
"name": "string"
}
],
"created_at": "2023-05-04T09:42:00+00:00",
"id": 42,
"inspection_content": {},
"inspection_type": "string",
"last_modified_at": "2023-05-04T09:42:00+00:00",
"trailer_id": 42,
"trailer_number": "string",
"truck_id": 42,
"truck_number": "string",
"yard_movement_id": 42
}
],
"last_modified_at": "2023-05-04T09:42:00+00:00",
"last_modified_by": "string",
"left_trailer_image_id": 42,
"load": "string",
"movement_driver_name": "string",
"movement_timestamp": "2023-05-04T09:42:00+00:00",
"movement_trailer_number": "string",
"movement_truck_number": "string",
"no_seal": true,
"other_trailer_carrier": "string",
"other_truck_carrier": "string",
"pin": 42,
"pin_valid_until": "2023-05-04T09:42:00+00:00",
"purpose": "string",
"rear_trailer_picture_id": 42,
"right_trailer_image_id": 42,
"seal": "string",
"seal_picture_ids": [
42
],
"shipment_id": "string",
"sku": "string",
"spare_tire_truck_photo_id": 42,
"status": "string",
"trailer": "string",
"trailer_carrier_id": 42,
"trailer_carrier_name": "string",
"trailer_client": "string",
"trailer_id": 42,
"trailer_inspection": {
"attachments": [
{
"attachment_id": 42,
"name": "string"
}
],
"created_at": "2023-05-04T09:42:00+00:00",
"id": 42,
"inspection_content": {},
"inspection_type": "string",
"last_modified_at": "2023-05-04T09:42:00+00:00",
"trailer_id": 42,
"trailer_number": "string",
"truck_id": 42,
"truck_number": "string",
"yard_movement_id": 42
},
"trailer_invalidated": true,
"trailer_location": {
"level": "string",
"row": "string",
"values": [
"string"
],
"zone": "string"
},
"trailer_number": "string",
"trailer_number_inference": "string",
"trailer_out_movement_id": 42,
"trailer_priority": true,
"trailer_stay_seconds": 42,
"trailer_tags": [
{
"associated_at": "2023-05-04T09:42:00+00:00",
"color": "string",
"created_at": "2023-05-04T09:42:00+00:00",
"id": 42,
"last_modified_at": "2023-05-04T09:42:00+00:00",
"name": "string"
}
],
"trailer_type": "string",
"truck_carrier_id": 42,
"truck_carrier_name": "string",
"truck_class": "CLASS_2B_3",
"truck_fuel_type": "CNG",
"truck_id": 42,
"truck_image_id": 42,
"truck_inspection": {
"attachments": [
{
"attachment_id": 42,
"name": "string"
}
],
"created_at": "2023-05-04T09:42:00+00:00",
"id": 42,
"inspection_content": {},
"inspection_type": "string",
"last_modified_at": "2023-05-04T09:42:00+00:00",
"trailer_id": 42,
"trailer_number": "string",
"truck_id": 42,
"truck_number": "string",
"yard_movement_id": 42
},
"truck_invalidated": true,
"truck_left_photo_id": 42,
"truck_number": "string",
"truck_out_movement_id": 42,
"truck_right_photo_id": 42,
"truck_stay_seconds": 42,
"truck_type": "BOX",
"vehicle_image_id": 42,
"visit_type": "string",
"yard_id": 42,
"yard_name": "string"
}