@shipengine/connect-carrier-api/src/models/tracking/track-event.ts

This is the typescript/javascript definitions for carrier api

import { LatLong } from './lat-long';
import { StandardizedStatusCodes } from './standardized-status-codes';
import { StandardizedStatusDetailCodes } from './standardized-status-detail-codes';

/** @description Basic structure for tracking events */
export class TrackEvent {
  /** @description When this tracking event occurred. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC. */
  event_datetime?: string;
  /** @description Most providers do not provide tracking events in UTC, and without time zone or geo information its hard to deduce. */
  event_datetime_local?: string;
  /** @description If the carrier returns both a generic and a specific event code, this field should contain the generic value while `carrier_detail_code` should contain the specific value. Otherwise, this field contains the carrier's specific event code. */
  event_code?: string;
  /** @description Optional field for the carrier's specific event code when `event_code` is populated with a generic event code. */
  carrier_detail_code?: string;
  /** @description A URL to an image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc. */
  proof_of_delivery_url?: string;
  /** @description Description of the package status at this event */
  description?: string;
  /** @description City or Locality for this event */
  city?: string;
  /** @description State or province */
  state?: string;
  /** @description Zip or postal code */
  postal_code?: string;
  /** @description Country for this event */
  country?: string;
  /** @description The name of the company this is being delivered to */
  company?: string;
  /** @description If the event had a signer associated, normally on delivery */
  signer?: string;
  /** @description Geographical location */
  geo?: LatLong;
  /** @description This represents the ShipEngine supported status codes for a shipment. UN - Unknown AC - Accepted IT - In Transit DE - Delivered EX - Exception AT - Delivery Attempted NY - Not Yet In System */
  status_code?: StandardizedStatusCodes;
  /** @description This represents the ShipEngine supported status detil codes for a shipment. */
  status_detail_code?: StandardizedStatusDetailCodes;
}