--- title: "List shipment events." method: GET path: "/api/v2/shipments/{shipment_id}/events" tags: ["Shipment Events"] --- # List shipment events. `GET /api/v2/shipments/{shipment_id}/events` List shipment events. ## Path parameters - `shipment_id` string, uuid, required — Shipment or Load UUID ## Query parameters - `offset` integer — The initial item number, starting at 0 (zero) - `limit` integer — The number of items per page - `type` string — A filter by the event type ## Response `200` Success - object - `data` union[] — An array of events - union - object - `details` object - `shipment` object - `id` string, uuid — The shipment identifier - `loadsmart_ref_number` string — Internal identifier - `bol_number` string — Bill of Lading number - `equipment_type` string — The type of truck used to move the load - `trailer_number` string — Carriers trailer number - `ref_number` string — Reference number - `carrier_pro` string — Carrier PRO Number is often used for by LTL carriers as a key identifier for their shipments. - `truck_license_plate` string — License Plate attached to a truck for official identification purposes. - `weight` string — Shipment's weight (string formatted decimal) - `must_arrive_by_date` string — Deadline to delivery load - `must_ship_by_date` string — Deadline to ship load - `container` object, nullable — Container related info - … - `stops` object[] — All shipment stops - … - `properties` object — JSON object where you can set custom properties - `stop` object — Event stop details - … - `shipper` object - `id` string, uuid — The shipper identified - `name` string — The shipper name - `event` object - `appointment` object — The date and time interval of the appointment and its confirmation flag - … - `event_date` string, date-time — The date and time of the event - `stop_index` integer — Indicate the stop number for this event, being 0-based for pickup. - `reason` 'carrier_dispatch_error' | 'carrier_keying_error' | 'closed_holiday' | 'consignee_closed' | 'consignee_related' | 'customer_requested_future_delivery' | 'customer_wanted_earlier_delivery' | 'driver_not_available' | 'insufficient_pickup_time' | 'load_shifted' | 'missed_pickup' | 'natural_disaster_related' | 'normal_status' | 'no_requested_arrival_date_provided_by_shipper' | 'other' | 'other_carrier_related' | 'past_cut_off_time' | 'refused_by_customer' | 'road_conditions' | 'shipment_overweight' | 'shipper_related' | 'suspended_at_customer_request' | 'tractor_conventional_not_available' | 'tractor_with_sleeper_car_not_available' | 'trailer_not_available' | 'trailer_not_usable_due_to_prior_product' | 'waiting_shipping_instruction' — The reason for changing the appointment - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` CheckDetailsShipperAppointmentDelivery — unresolved $ref - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` object - `shipment` ShipmentDetails — unresolved $ref - `shipper` ShipperDetails — unresolved $ref - `event` object - `event_date` string, date-time — The date and time of the event. - `stop_index` integer — Indicate the stop number for this event, being 0-based for pickup. - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` CheckInDetails — unresolved $ref - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` CheckOutDetails — unresolved $ref - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` CheckInDetails — unresolved $ref - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` CheckOutDetails — unresolved $ref - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` LateDetails — unresolved $ref - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` LateDetails — unresolved $ref - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` object - `carrier` object - `id` string, uuid - `name` string - `mc_number` string, nullable - `dot_number` string, nullable - `tractor_number` string, nullable - `trailer_number` string, nullable - `shipment` object - `loadsmart_ref_number` string — Internal identifier - `ref_number` string — Reference number - `shipper` ShipperDetails — unresolved $ref - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` object, nullable - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` LocationDetails — unresolved $ref - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` object - `shipment` ShipmentDetails — unresolved $ref - `shipper` ShipperDetails — unresolved $ref - `event` object - `sender_id` string, nullable - `receiver_id` string, nullable - `driver` object - … - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` object - `shipment` ShipmentDetails — unresolved $ref - `shipper` ShipperDetails — unresolved $ref - `event` object - `sender_id` string, nullable - `receiver_id` string, nullable - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` object - `reason` 'shipper' | 'carrier' | 'loadsmart' | 'other' - `details` string - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` object - `shipment` ShipmentDetails — unresolved $ref - `shipper` ShipperDetails — unresolved $ref - `event` ShipmentIncident — unresolved $ref - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` object - `event` object - `invoice_number` string — The invoice identifier number - `weight` integer — The shipment weight - `lading_quantity` integer — The amount of lading in the shipment - `invoice_date` string, date-time — The date and time of the invoice - `pu_appointment` string, date-time — The pickup appointment date and time - `pu_checkin` string, date-time — The check in at pickup date and time - `pu_checkout` string, date-time — The check out from pickup date and time - `del_appointment` string, date-time — The delivery appointment date and time - `del_checkin` string, date-time — The check in at delivery date and time - `del_checkout` string, date-time — The check out from delivery date and time - `total_invoice_amount` number — The total amount of the invoice - `bill_to` object — Address information for where to bill the shipment - … - `lines` object[] — A list of all the invoice items - … - `shipment` object - `bol_number` string — Bill of Lading number - `commodity` string — The shipment commodity - `id` string, uuid — The shipment identifier - `loadsmart_ref_number` string — Internal identifier - `miles` unknown - `purchase_order_number` string — Purchase order number - `purchase_order_numbers` string[] — A list of all shipment's purchase order numbers - `ref_number` string — Reference number - `stops` object[] — A list of all shipment stops - … - `tractor_number` string — Tractor number - `trailer_number` string — Trailer number - `properties` object — Shipment misc properties - `bill_to` object — Address information for where to bill the shipment - … - `contracted` boolean — True whether the shipment was booked through a contract with the Shipper - `shipper` ShipperDetails — unresolved $ref - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` object - `shipment` ShipmentDetails — unresolved $ref - `event` object - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - object - `details` object - `shipment` ShipmentDetailsWithStops — unresolved $ref - `event` object - `shipment_id` string, uuid — The shipment identifier - `created_at` string, date-time — The date and time of the event creation - `type` string — Event type - `previous` string, nullable — The url for the previous page - `next` string, nullable — The url for the next page - `count` integer — The total of events for the shipment ## Other responses - `403` — Permission denied - `404` — Shipment not found --- [API](https://skmtc.dev/loadsmart/apis/loadsmart-api.md) · [All operations](https://skmtc.dev/loadsmart/apis/loadsmart-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/loadsmart/loadsmart-api/revisions/6021c5806fe9/schema)