Registers a new yard movement precheck

POST /api/yardmovement-precheck

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)

Query parameters

  • If true, a Gatepass Code will be generated when the movement is created

application/json

Body

A Pre-checkin or Pre-checkout of a movement, that can be retrieved to be used as a template for the final checkin or checkout movement

Responses

POST /api/yardmovement-precheck
curl \
 -X POST https://api-dev.gatego.io:443/api/yardmovement-precheck \
 -H "Content-Type: application/json" \
 -d '{"attachment_ids":[42],"attachment_picture_ids":[42],"bill_of_lading_photo_id":42,"bol_number":"string","chassis_number":"string","chassis_size":"string","comments":"string","destination":"string","direction":"IN","driver_id":42,"driver_license":"string","driver_license_expiration":"2024-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,"driver_safety_card_picture_id":42,"eta_timestamp":"2024-05-04T09:42:00+00:00","extra_trailers":[{"carrier_id":42,"client":"string","custom_fields":{"key":"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,"license_plate_photo_id":42,"load":"string","main_trailer":{"carrier_id":42,"client":"string","custom_fields":{"key":"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":"2024-05-04T09:42:00+00:00","no_seal":true,"other_trailer_carrier":"string","other_truck_carrier":"string","pager_number":"string","purpose":"string","rear_trailer_picture_id":42,"right_trailer_image_id":42,"safety_video_confirmation":true,"seal":"string","seal_picture_ids":[42],"shipment_id":"string","sku":"string","spare_tire_truck_photo_id":42,"status":"EMPTY","tanker_status":"string","trailer":"string","trailer_carrier_id":42,"trailer_client":"string","trailer_custom_fields":{"key":"string"},"trailer_id":42,"trailer_location":{"level":"string","row":"string","values":["string"],"zone":"string"},"trailer_priority":true,"trailer_type":"string","truck_carrier_id":42,"truck_carrier_info_photo_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","visitor_badge_number":"string","visitor_company":"string","visitor_email":"string","visitor_host":"string","visitor_host_account_id":42,"visitor_name":"string","visitor_person_photo_id":42,"visitor_phone_number":"string","visitor_type":"PERSON","wash_out_slip_photo_id":42,"yard_id":42}'
Request examples
# Headers

# Payload
{
  "attachment_ids": [
    42
  ],
  "attachment_picture_ids": [
    42
  ],
  "bill_of_lading_photo_id": 42,
  "bol_number": "string",
  "chassis_number": "string",
  "chassis_size": "string",
  "comments": "string",
  "destination": "string",
  "direction": "IN",
  "driver_id": 42,
  "driver_license": "string",
  "driver_license_expiration": "2024-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,
  "driver_safety_card_picture_id": 42,
  "eta_timestamp": "2024-05-04T09:42:00+00:00",
  "extra_trailers": [
    {
      "carrier_id": 42,
      "client": "string",
      "custom_fields": {
        "key": "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,
  "license_plate_photo_id": 42,
  "load": "string",
  "main_trailer": {
    "carrier_id": 42,
    "client": "string",
    "custom_fields": {
      "key": "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": "2024-05-04T09:42:00+00:00",
  "no_seal": true,
  "other_trailer_carrier": "string",
  "other_truck_carrier": "string",
  "pager_number": "string",
  "purpose": "string",
  "rear_trailer_picture_id": 42,
  "right_trailer_image_id": 42,
  "safety_video_confirmation": true,
  "seal": "string",
  "seal_picture_ids": [
    42
  ],
  "shipment_id": "string",
  "sku": "string",
  "spare_tire_truck_photo_id": 42,
  "status": "EMPTY",
  "tanker_status": "string",
  "trailer": "string",
  "trailer_carrier_id": 42,
  "trailer_client": "string",
  "trailer_custom_fields": {
    "key": "string"
  },
  "trailer_id": 42,
  "trailer_location": {
    "level": "string",
    "row": "string",
    "values": [
      "string"
    ],
    "zone": "string"
  },
  "trailer_priority": true,
  "trailer_type": "string",
  "truck_carrier_id": 42,
  "truck_carrier_info_photo_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",
  "visitor_badge_number": "string",
  "visitor_company": "string",
  "visitor_email": "string",
  "visitor_host": "string",
  "visitor_host_account_id": 42,
  "visitor_name": "string",
  "visitor_person_photo_id": 42,
  "visitor_phone_number": "string",
  "visitor_type": "PERSON",
  "wash_out_slip_photo_id": 42,
  "yard_id": 42
}
Response examples (201)
{"checked"=>true, "driver"=>{"id"=>42, "license"=>"string", "license_expiration"=>"2024-05-04T09:42:00+00:00", "license_picture_id"=>42, "name"=>"string", "notification_email"=>"string", "notification_phone"=>"string", "notification_preference_channel"=>"EMAIL", "photo_id"=>42, "safety_card_picture_id"=>42}, "gatepass_code"=>"string", "id"=>42, "yard_movement_id"=>42}