/*
 * This code was auto generated by AfterShip SDK Generator.
 * Do not edit the class manually.
 */
import { TrackingCourierEstimatedDeliveryDate } from "./TrackingCourierEstimatedDeliveryDate";
import { TrackingFirstEstimatedDelivery } from "./TrackingFirstEstimatedDelivery";
import { TrackingCarbonEmissions } from "./TrackingCarbonEmissions";
import { TrackingFirstMile } from "./TrackingFirstMile";
import { Tag } from "./Tag";
import { TrackingOrderPromisedDeliveryDate } from "./TrackingOrderPromisedDeliveryDate";
import { TrackingAftershipEstimatedDeliveryDate } from "./TrackingAftershipEstimatedDeliveryDate";
import { TrackingLastMile } from "./TrackingLastMile";
import { TrackingProofOfDelivery } from "./TrackingProofOfDelivery";
import { TrackingReturnShipment } from "./TrackingReturnShipment";
import { TrackingShipmentDimensions } from "./TrackingShipmentDimensions";
import { TrackingCustomEstimatedDeliveryDate } from "./TrackingCustomEstimatedDeliveryDate";
import { TrackingSignatureRequirement } from "./TrackingSignatureRequirement";
import { TrackingCustomers } from "./TrackingCustomers";
import { TrackingShipmentDirection } from "./TrackingShipmentDirection";
import { TrackingShipmentWeight } from "./TrackingShipmentWeight";
import { Checkpoint } from "./Checkpoint";
import { TrackingLatestEstimatedDelivery } from "./TrackingLatestEstimatedDelivery";
import { TrackingMultiPieceInfo } from "./TrackingMultiPieceInfo";
import { TrackingForwardShipment } from "./TrackingForwardShipment";

/**
 * Object describes the tracking information.<div style="visibility:hidden; height: 0"></div>
 */
export interface Tracking {
  /**
   * A  system-generated tracking ID by default, which can be customized by the user when creating a tracking.
   */
  id?: string;
  /**
   * The length of the tracking ID has been increased from 24 characters to 32 characters. We will use the legacy_id field to store the original 24-character tracking ID to maintain compatibility with existing data. Therefore, all tracking endpoints will continue to work with the legacy_id field as before.
   */
  legacy_id?: string;
  /**
   * The date and time the shipment was imported or added to AfterShip. It uses the format `YYYY-MM-DDTHH:mm:ssZ` for the timezone GMT +0.
   */
  created_at?: string;
  /**
   * The date and time the shipment was updated. It uses the format `YYYY-MM-DDTHH:mm:ssZ` for the timezone GMT +0.
   */
  updated_at?: string;
  /**
   * Tracking number.
   */
  tracking_number?: string;
  /**
   * Unique courier code. When importing a shipment with no courier slug and the tracking number can’t be recognized, the courier will be marked as `unrecognized`. Get courier codes .
   */
  slug?: string;
  /**
   * Whether or not AfterShip will continue tracking the shipment. Value is false when no further updates for a few days since last update.
   */
  active?: boolean;
  /**
   * Custom fields that accept an object with string field. In order to protect the privacy of your customers, do not include any  in custom fields.
   */
  custom_fields?: { [key: string]: any } | null;
  /**
   * Total transit time in days.- For delivered shipments: Transit time (in days) = Delivered date - Pick-up date- For undelivered shipments: Transit time (in days) = Current date - Pick-up dateValue as `null` for the shipment without pick-up date.
   */
  transit_time?: number | null;
  /**
   * The  for the origin country/region. E.g. USA for the United States.
   */
  origin_country_region?: string | null;
  /**
   * The state of the sender’s address.
   */
  origin_state?: string | null;
  /**
   * The city of the sender’s address.
   */
  origin_city?: string | null;
  /**
   * The postal code of the sender’s address.
   */
  origin_postal_code?: string | null;
  /**
   * The sender address that the shipment is shipping from.
   */
  origin_raw_location?: string | null;
  /**
   * The  for the destination country/region. E.g. USA for the United States.
   */
  destination_country_region?: string | null;
  /**
   * The state of the recipient’s address.
   */
  destination_state?: string | null;
  /**
   * The city of the recipient’s address.
   */
  destination_city?: string | null;
  /**
   * The postal code of the recipient’s address.
   */
  destination_postal_code?: string | null;
  /**
   * The shipping address that the shipment is shipping to.
   */
  destination_raw_location?: string | null;
  /**
   * Destination country/region of the tracking detected from the courier. ISO Alpha-3 (three letters). Value will be `null` if the courier doesn't provide the destination country.
   */
  courier_destination_country_region?: string | null;
  /**
   * The field contains the estimated delivery date provided by the carrier.
   */
  courier_estimated_delivery_date?: TrackingCourierEstimatedDeliveryDate | null;
  /**
   * Text field for the note.
   */
  note?: string | null;
  /**
   * A globally-unique identifier for the order.
   */
  order_id?: string | null;
  /**
   * The URL for the order in your system or store.
   */
  order_id_path?: string | null;
  /**
   * The date and time the order was created in your system or store. It uses the format: `YYYY-MM-DDTHH:mm:ssZ` based on whichever timezone you provide.
   */
  order_date?: string | null;
  /**
   * Number of packages under the tracking.
   */
  shipment_package_count?: number | null;
  /**
   * The date and time the shipment was picked up by the carrier. It uses the timezone where the pickup occured. The format may differ depending on how the carrier provides it:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ
   */
  shipment_pickup_date?: string | null;
  /**
   * The date and time the shipment was delivered. It uses the shipment recipient’s timezone. The format may differ depending on how the carrier provides it:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ
   */
  shipment_delivery_date?: string | null;
  /**
   * The carrier service type for the shipment.
   */
  shipment_type?: string | null;
  /**
   * The shipment_weight field represents the total weight of the shipment. In scenarios where the carrier does not provide this information, you can provide the weight to AfterShip. We will prioritize the data provided by the carrier, if available. The shipment weight will be included in the Response and accessed through the GET API, Webhook, and CSV export. It will also be displayed on the AfterShip Tracking admin. Additionally, it plays a significant role in error-free shipment handling and carbon emission calculations, ensuring accurate and informed decision-making
   */
  shipment_weight?: TrackingShipmentWeight | null;
  /**
   * Physical dimensions of the package (length, width and height).
   */
  shipment_dimensions?: TrackingShipmentDimensions | null;
  /**
   * Signed by information for delivered shipment.
   */
  signed_by?: string | null;
  /**
   * Source of how this tracking is added.
   */
  source?: string;
  /**
   * Current status of tracking. (
   */
  tag?: Tag;
  /**
   * Current subtag of tracking. (
   */
  subtag?: string;
  /**
   * Normalized tracking message. (
   */
  subtag_message?: string;
  /**
   * By default this field shows the `tracking_number`, but you can customize it as you wish with any info (e.g. the order number).
   */
  title?: string;
  /**
   * Number of attempts AfterShip tracks at courier's system.
   */
  tracked_count?: number;
  /**
   * The recipient’s language. If you set up AfterShip notifications in different languages, we use this to send the recipient tracking updates in their preferred language.
   */
  language?: string | null;
  /**
   * Deprecated
   */
  unique_token?: string;
  /**
   * Array of checkpoint object describes the checkpoint information.
   */
  checkpoints?: Checkpoint[];
  /**
   * Phone number(s) subscribed to receive sms notifications.
   */
  subscribed_smses?: string[];
  /**
   * Email address(es) subscribed to receive email notifications.
   */
  subscribed_emails?: string[];
  /**
   * Whether or not the shipment is returned to sender. Value is `true` when any of its checkpoints has subtag `Exception_010` (returning to sender) or `Exception_011` (returned to sender). Otherwise value is `false`.
   */
  return_to_sender?: boolean;
  /**
   * The promised delivery date of the order in shipment recipient’s timezone.
   */
  order_promised_delivery_date?: TrackingOrderPromisedDeliveryDate | null;
  /**
   * Shipment delivery type- pickup_at_store- pickup_at_courier- door_to_door
   */
  delivery_type?: string | null;
  /**
   * Shipment pickup location for receiver
   */
  pickup_location?: string | null;
  /**
   * Shipment pickup note for receiver
   */
  pickup_note?: string | null;
  /**
   * Official tracking URL of the courier (if any). The language parameter of this link relies on the destination country/region and the language associated with the shipment, if the data regarding the destination country/region and language of the shipment is not available, AfterShip will set the language parameter of the link to "US" by default.
   */
  courier_tracking_link?: string | null;
  /**
   * The date and time of the carrier’s first attempt to deliver the package to the recipient.  It uses the shipment recipient’s timezone. The format may differ depending on how the carrier provides it:- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ
   */
  first_attempted_at?: string | null;
  /**
   * Delivery instructions (delivery date or address) can be modified by visiting the link if supported by a carrier. The language parameter of this link relies on the destination country/region and the language associated with the shipment, if the data regarding the destination country/region and language of the shipment is not available, AfterShip will set the language parameter of the link to "US" by default.
   */
  courier_redirect_link?: string | null;
  /**
   * Additional field required by some carriers to retrieve the tracking info. The shipper’s carrier account number. Refer to our article on  for more details.
   */
  tracking_account_number?: string | null;
  /**
   * Additional field required by some carriers to retrieve the tracking info. A type of tracking credential required by some carriers. Refer to our article on  for more details.
   */
  tracking_key?: string | null;
  /**
   * The date and time when the shipment is shipped by the merchant and ready for pickup by the carrier. The field supports the following formats:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZThe field serves two key purposes:- Calculate processing time metrics in the Order-to-delivery Analytics dashboard. To ensure accurate analytics, it's recommended to include timezone information when configuring this value- Required by certain carriers to retrieve tracking information as an additional tracking field.
   */
  tracking_ship_date?: string | null;
  /**
   * Whether the tracking is delivered on time or not.
   */
  on_time_status?: string | null;
  /**
   * The difference days of the on time.
   */
  on_time_difference?: number | null;
  /**
   * The tags of the order.
   */
  order_tags?: string[];
  /**
   * The estimated delivery date of the shipment provided by AfterShip’s AI and shown to the recipients. It uses the format `YYYY-MM-DD` based on the shipment recipient’s timezone.
   */
  aftership_estimated_delivery_date?: TrackingAftershipEstimatedDeliveryDate | null;
  /**
   * Estimated delivery time of the shipment based on your . It uses the format `YYYY-MM-DD` based on the shipment recipient’s timezone.
   */
  custom_estimated_delivery_date?: TrackingCustomEstimatedDeliveryDate | null;
  /**
   * A unique, human-readable identifier for the order.
   */
  order_number?: string | null;
  /**
   * The shipment’s original estimated delivery date. It could be provided by the carrier, AfterShip AI, or based on your custom settings. The format of carrier EDDs may differ depending on how the carrier provides it:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ AfterShip AI and custom EDDs always use the format `YYYY-MM-DD`. All EDDs use the shipment recipient’s timezone.
   */
  first_estimated_delivery?: TrackingFirstEstimatedDelivery | null;
  /**
   * The most recently calculated estimated delivery date. It could be provided by the carrier, AfterShip AI, or based on your custom settings. The format of carrier EDDs may differ depending on how the carrier provides it:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ AfterShip AI and custom EDDs always use the format `YYYY-MM-DD`. All EDDs use the shipment recipient’s timezone.
   */
  latest_estimated_delivery?: TrackingLatestEstimatedDelivery | null;
  /**
   * Used to add tags to your shipments to help categorize and filter them easily.
   */
  shipment_tags?: string[];
  /**
   * If you have multiple accounts connected for a single carrier on AfterShip, we have introduced the courier_connection_id field to allow you to specify the carrier account associated with each shipment. By providing this information, you enable us to accurately track and monitor your shipments based on the correct carrier account.(</br>In the event that you do not specify the courier_connection_id, we will handle your shipment using the connection that was created earliest among your connected accounts.
   */
  courier_connection_id?: string | null;
  /**
   * The model contains the total amount of carbon emissions generated by the shipment. - AfterShip will provide this data only when it is available, and its availability is contingent upon the location and weight information that AfterShip can obtain.- The values will be accessible solely for shipments that have been successfully delivered. However, in the event of a shipping update after the delivery status has been achieved, the value may change.- It’s a paid service and only for Tracking Enterprise users, please contact your customer success manager if you want to know more.
   */
  carbon_emissions?: TrackingCarbonEmissions | null;
  /**
   * The location_id refers to the place where you fulfilled the items.  - If you provide a location_id, the system will automatically use it as the tracking's origin address. However, passing both location_id and any origin address information simultaneously is not allowed.- Please make sure you add your locations .
   */
  location_id?: string | null;
  /**
   * The shipping_method string refers to the chosen method for delivering the package. Merchants typically offer various shipping methods to consumers during the checkout process, such as, Local Delivery, Free Express Worldwide Shipping, etc.
   */
  shipping_method?: string | null;
  /**
   * By dynamically tracking failed delivery attempts during shipment, this field allows you to pinpoint carriers accountable for the most failures. Analyzing the root cause of these failures enables you to improve carriers' delivery standard operating procedures (SOP), leading to an overall enhancement in delivery service quality.
   */
  failed_delivery_attempts?: number | null;
  /**
   * The signature_requirement field serves the purpose of validating the service option type, specifically proof of delivery. By collecting the recipient's signature upon delivery, it ensures the package reaches the intended recipient and prevents disputes related to non-delivery or lost packages.</br>
   */
  signature_requirement?: TrackingSignatureRequirement;
  /**
   * The delivery location type represents the secure area where the carrier leaves the package, such as a safe place, locker, mailbox, front porch, etc. This information helps ensure the shipment reaches the intended recipient efficiently, minimizing the risk of theft or damage.
   */
  delivery_location_type?: string | null;
  /**
   * The tracking URL directs your customers to the shipment tracking page which can display either the default or a customized page based on segmentation rules.- The universal URL is used by default, but you can opt for a custom domain if you have one. Learn how to set up a custom domain .The field is not automatically enabled in API & Webhook. Please contact support if you’d like to enable it.
   */
  aftership_tracking_url?: string | null;
  /**
   * The order URL directs your customers to the order tracking page, which includes all shipments. It can display either the default or a customized page based on segmentation rules.- The universal URL is used by default, but you can opt for a custom domain if you have one. Learn how to set up a custom domain .The field is not automatically enabled in API & Webhook. Please contact support if you’d like to enable it.
   */
  aftership_tracking_order_url?: string | null;
  /**
   * The field contains information about the first leg of the shipping starting from the carrier picking up the shipment from the shipper to the point where they hand it over to the last-mile carrier. Once AfterShip detects the shipment is multi-leg, we will populate the first-mile information under this object.
   */
  first_mile?: TrackingFirstMile | null;
  /**
   * This field contains information about the last leg of the shipment, starting from the carrier who hands it over to the last-mile carrier, all the way to delivery. Once AfterShip detects that the shipment involves multiple legs and identifies the last-mile carrier, we will populate the last-mile carrier information in this object. Alternatively, the user can provide this information in this field to specify the last-mile carrier, which is helpful if AfterShip is unable to detect it automatically.
   */
  last_mile?: TrackingLastMile | null;
  /**
   * The field contains the customer information associated with the tracking. A maximum of three customer objects are allowed.
   */
  customers?: TrackingCustomers[];
  /**
   * An array of proof of delivery (POD) records, such as a signature or photo captured upon successful delivery.This field returns a value only after the feature is enabled. Please contact your customer success manager if you'd like to know more.
   */
  proof_of_delivery?: TrackingProofOfDelivery[] | null;
  /**
   * Multi-piece shipment refers to a scenario where a single shipment order is fulfilled by multiple physical packages. Each piece has its own carrier-assigned tracking number, but all pieces belong to the same shipment. This commonly occurs when an order is too large to fit in one box, or when items are packed separately for handling reasons.This field contains multi-piece shipment metadata describing a group of packages that belong to the same shipment.This field returns a value only when your subscription plan includes a multi-piece feature. To enable, go to .
   */
  multi_piece_info?: TrackingMultiPieceInfo | null;
  /**
   * Indicates the business direction of the shipment in the e-commerce fulfillment lifecycle.Possible values:- `forward`: A forward (outbound-to-customer) shipment created for order fulfillment.- `return`: A return (customer-to-merchant) shipment created for after-sales return or exchange.This field is populated in either of the following cases:1. You explicitly provided it when creating the tracking.2. AfterShip automatically detected a linked forward or return shipment.It also determines which related shipment object (`forward_shipment` or `return_shipment`) may appear in the response.
   */
  shipment_direction?: TrackingShipmentDirection;
  /**
   * The associated return shipment linked to the current outbound shipment.This field is only present when `shipment_direction = "forward"` and AfterShip has detected a linked return shipment.
   */
  return_shipment?: TrackingReturnShipment | null;
  /**
   * The original outbound shipment linked to this return. Use this to trace a return back to its source delivery.This field is only present when `shipment_direction = "return"` and AfterShip has detected a linked forward shipment.
   */
  forward_shipment?: TrackingForwardShipment | null;
}