Headers

• X-Gatego-oid

  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

• Optional yard identifier to filter prechecks to a given yard. If not present all prechecks in the organization would be returned. Please note that Guards will only be able to see Prechecks in their own Yard even if the property is not present integer(int64)

  yard_id

• carrier_id integer(int64)

  An optional list of carrier ids separated by commas to filter results. The results for Carrier Admin will be filtered anyway by their visible carriers.

• show_other_carriers boolean

  When this parameter is present and true, then the Other Carriers will be returned as long as the caller account is allowed to see other carriers (field canViewOtherCarriers=true). When this parameter is present and false, then the Other Carriers will not be returned, regardless user permissions. Finally when this parameter is not present, then the Other Carriers will be returned by default if and only if the user is allowed to see Other Carriers (and won't be returned if the user is not allowed to see them)

• truck_number string

  Optional truck number to filter prechecks to a given truck number (exact match)

• trailer_number string

  Optional trailer number to filter prechecks to a given trailer number (exact match)

• checked boolean

  If set to true, then only checked prechecks (by default only prechecks that are actually not used in a checkin or checkout are returned)

• yard_movement_id integer(int64)

  Optional yard movement identifier to return the precheck used to create the given yard movement. It will automatically set checked=true

• date_start string(date-time)

  Optional start date to filter prechecks

• date_end string(date-time)

  Optional end date to filter prechecks

Responses

• 200 */*

  OK

  Hide response attributes Show response attributes object

  • attachment_ids array[integer(int64)]
  • attachment_picture_ids array[integer(int64)]
  • bill_of_lading_photo_id integer(int64)
  • bol_number string
  • chassis_number string
  • chassis_size string
  • checked boolean

    True if this precheck was used to componse a final checkin or checkout

  • comments string
  • created_at string(date-time)
  • created_by string
  • destination string
  • direction string

    Values are IN or OUT.

  • driver object

    The driver associated to this precheck

    Hide driver attributes Show driver attributes object

    • id integer(int64)
    • license string
    • license_expiration string(date-time)
    • license_picture_id integer(int64)
    • name string
    • notification_email string
    • notification_phone string
    • notification_preference_channel string

      Values are EMAIL, SMS, or WHATSAPP.

    • photo_id integer(int64)
    • safety_card_picture_id integer(int64)
  • driver_id integer(int64)
  • driver_license string
  • driver_license_picture_id integer(int64)
  • driver_name string
  • driver_notification_email string
  • driver_notification_phone string
  • driver_notification_preference_channel string

    Values are EMAIL, SMS, or WHATSAPP.

  • driver_photo_id integer(int64)
  • driver_safety_card_picture_id integer(int64)
  • eta_timestamp string(date-time)

    Expected time of arrival of the truck/trailer defined in this Precheck

  • extra_trailers array[object]
    Hide extra_trailers attributes Show extra_trailers attributes object

    • carrier_id integer(int64)
    • carrier_name string
    • client string
    • destination string
    • id integer(int64)
    • inside_picture_id integer(int64)
    • left_image_id integer(int64)
    • load string
    • movement_id integer(int64)
    • movement_trailer_number string
    • no_seal boolean
    • number string
    • other_carrier string
    • priority boolean
    • purpose string
    • rear_picture_id integer(int64)
    • right_image_id integer(int64)
    • seal string
    • seal_picture_ids array[integer(int64)]
    • shipment_id string
    • sku string
    • status string

      Values are EMPTY, LOADED, or NO_TRAILER.

    • status_desc string
    • tags array[object]
      Hide tags attributes Show tags attributes object

      • color string
      • created_at string(date-time)
      • id integer(int64)
      • last_modified_at string(date-time)
      • name string
    • trailer_location object
      Hide trailer_location attributes Show trailer_location attributes object

      • level string
      • row string
      • values array[string]
      • zone string
    • trailer_out_movement_id integer(int64)
    • trailer_stay_seconds integer(int64)
    • type string
  • gatepass_code string

    The gatepass code generated for this precheck, if any

  • id integer(int64)

    The precheck identifier

  • inside_trailer_picture_id integer(int64)
  • inspections array[object]
    Hide inspections attributes Show inspections attributes object

    • attachments array[object]

      Inspection attachments

      Hide attachments attributes Show attachments attributes object

      • attachment_id integer(int64) Required

        Reference to the identifier of an existing attachment.

      • name string

        Optional name to give it a tag or meaning to the attachment, which also allows to retrieve the attachment by name

    • created_at string(date-time)
    • id integer(int64)
    • inspection_content object
    • inspection_type string
    • last_modified_at string(date-time)
    • trailer_id integer(int64)
    • trailer_number string
    • truck_id integer(int64)
    • truck_number string
    • yard_movement_id integer(int64)
  • last_modified_at string(date-time)
  • last_modified_by string
  • left_trailer_image_id integer(int64)
  • license_plate_photo_id integer(int64)
  • load string
  • movement_driver_name string
  • movement_driver_photo_id integer(int64)
  • movement_trailer_number string
  • movement_truck_number string
  • no_seal boolean
  • other_trailer_carrier string
  • other_truck_carrier string
  • pager_number string
  • pin integer(int64)
  • pin_valid_until string(date-time)
  • purpose string
  • rear_trailer_picture_id integer(int64)
  • right_trailer_image_id integer(int64)
  • safety_video_confirmation boolean
  • seal string
  • seal_picture_ids array[integer(int64)]
  • shipment_id string
  • sku string
  • spare_tire_truck_photo_id integer(int64)
  • status string
  • tanker_status string
  • trailer string
  • trailer_carrier_id integer(int64)
  • trailer_carrier_name string
  • trailer_client string
  • trailer_custom_fields object
    Hide trailer_custom_fields attributes Show trailer_custom_fields attributes object

    • Additional properties
    • key string
  • trailer_id integer(int64)
  • trailer_inspection object
    Hide trailer_inspection attributes Show trailer_inspection attributes object

    • attachments array[object]

      Inspection attachments

      Hide attachments attributes Show attachments attributes object

      • attachment_id integer(int64) Required

        Reference to the identifier of an existing attachment.

      • name string

        Optional name to give it a tag or meaning to the attachment, which also allows to retrieve the attachment by name

    • created_at string(date-time)
    • id integer(int64)
    • inspection_content object
    • inspection_type string
    • last_modified_at string(date-time)
    • trailer_id integer(int64)
    • trailer_number string
    • truck_id integer(int64)
    • truck_number string
    • yard_movement_id integer(int64)
  • trailer_location object
    Hide trailer_location attributes Show trailer_location attributes object

    • level string
    • row string
    • values array[string]
    • zone string
  • trailer_number string
  • trailer_number_inference string
  • trailer_priority boolean
  • trailer_tags array[object]
    Hide trailer_tags attributes Show trailer_tags attributes object

    • associated_at string(date-time)
    • color string
    • created_at string(date-time)
    • id integer(int64)
    • last_modified_at string(date-time)
    • name string
  • trailer_type string
  • truck_carrier_id integer(int64)
  • truck_carrier_info_photo_id integer(int64)
  • truck_carrier_name string
  • truck_fuel_type string

    Values are CNG, DIESEL, ELECTRIC, or HYDROGEN.

  • truck_id integer(int64)
  • truck_image_id integer(int64)
  • truck_inspection object
    Hide truck_inspection attributes Show truck_inspection attributes object

    • attachments array[object]

      Inspection attachments

      Hide attachments attributes Show attachments attributes object

      • attachment_id integer(int64) Required

        Reference to the identifier of an existing attachment.

      • name string

        Optional name to give it a tag or meaning to the attachment, which also allows to retrieve the attachment by name

    • created_at string(date-time)
    • id integer(int64)
    • inspection_content object
    • inspection_type string
    • last_modified_at string(date-time)
    • trailer_id integer(int64)
    • trailer_number string
    • truck_id integer(int64)
    • truck_number string
    • yard_movement_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, or SEMI.

  • vehicle_image_id integer(int64)
  • visit_type string
  • visitor_badge_number string
  • visitor_company string
  • visitor_email string
  • visitor_host string
  • visitor_host_account_id integer(int64)
  • visitor_name string
  • visitor_person_photo_id integer(int64)
  • visitor_phone_number string
  • visitor_type string

    Values are PERSON or VEHICLE.

  • wash_out_slip_photo_id integer(int64)
  • yard_id integer(int64)
  • yard_movement_id integer(int64)

    The yardmovement identifier of the checkin or checkout created from this Precheck

  • yard_name string
• 401

  Unauthorized

• 403

  Forbidden

• 404

  Not Found