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

• date_start string(date-time) Required

  date_start

• offset integer(int64)
• pageNumber integer(int32)
• pageSize integer(int32)
• paged boolean
• sort.sorted boolean
• sort.unsorted boolean
• unpaged boolean
• date_end string(date-time)

  date_end

• yard_id integer(int64)

  yard_id

• carrier_id integer(int64)

  A carrier id to filter, or a list of carrier ids separated by commas

• status string

  A status to filter, or a list of status separated by commas. eg.: LOADED,EMPTY

  Values are EMPTY, LOADED, or NO_TRAILER.

• 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)

• visit_type string

  visit_type

  Values are TRACTOR or VEHICLE.

• filter string

  filter

Responses

• 200 */*

  OK

  Hide response attributes Show response attributes object

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

    • age_days integer(int64)
    • 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
    • comments string
    • created_at string(date-time)
    • created_by string
    • custom_fields object
      Hide custom_fields attributes Show custom_fields attributes object

      • Additional properties
      • key string
    • damage string
    • damage_asset_type string
    • damage_attachment_ids array[integer(int64)]
    • damage_id integer(int64)
    • damage_picture_ids array[integer(int64)]
    • damage_reference string
    • damage_status string
    • destination string
    • direction string

      Values are IN or OUT.

    • driver_id integer(int64)
    • driver_license string
    • driver_license_expiration string(date-time)
    • driver_license_picture_id integer(int64)
    • driver_name string
    • driver_photo_id integer(int64)
    • driver_safety_card_picture_id integer(int64)
    • 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
    • id integer(int64)
    • 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_timestamp string(date-time)
    • no_seal boolean
    • other_trailer_carrier string
    • other_truck_carrier string
    • pager_number string
    • 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_id integer(int64)
    • trailer_invalidated boolean
    • 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_out_movement_id integer(int64)
    • trailer_priority boolean
    • trailer_stay_seconds integer(int64)
    • trailer_tags array[object]
      Hide trailer_tags attributes Show trailer_tags attributes object

      • 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_class string

      Values are CLASS_2B_3, CLASS_4_7, or CLASS_8.

    • truck_fuel_type string

      Values are CNG, DIESEL, ELECTRIC, or HYDROGEN.

    • truck_id integer(int64)
    • truck_image_id integer(int64)
    • truck_invalidated boolean
    • truck_left_photo_id integer(int64)
    • truck_number string
    • truck_out_movement_id integer(int64)
    • truck_right_photo_id integer(int64)
    • truck_stay_seconds 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_address string
    • yard_id integer(int64)
    • yard_name string
    • yard_place_id string
  • empty boolean
  • first boolean
  • last boolean
  • number integer(int32)
  • number_of_elements integer(int32)
  • pageable object
    Hide pageable attributes Show pageable attributes object

    • offset integer(int64)
    • page_number integer(int32)
    • page_size integer(int32)
    • paged boolean
    • sort object
      Hide sort attributes Show sort attributes object

      • empty boolean
      • sorted boolean
      • unsorted boolean
    • unpaged boolean
  • size integer(int32)
  • sort object
    Hide sort attributes Show sort attributes object

    • empty boolean
    • sorted boolean
    • unsorted boolean
  • total_elements integer(int64)
  • total_pages integer(int32)
• 401

  Unauthorized

• 403

  Forbidden

• 404

  Not Found