Application Load

ICustomerTicketRefund

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

ICustomerTicketRefund

Read-only return shipment, tracking and optional related order.

src/lib/interfaces/orionplace/tickets/ICustomerTicketApi.ts
TypeScript
export interface ICustomerTicketRefund {
  // Return ID. One order has one return, so every conversation about a return
  // of that order carries the same ID.
  id: number;
  // State of the return shipment, as `EOrderRefundShipmentStatus`, with the
  // backend label.
  shipment_status: {
    // Value of int.
    int: EOrderRefundShipmentStatus;
    // Value of text.
    text: string;
  };
  // Carrier, tracking number and carrier state of the return shipment, or
  // `null`. `status` is carrier text, not an order-state code.
  track: {
    // Return ID. One order has one return, so every conversation about a return
    // of that order carries the same ID.
    id: number;
    // Carrier, tracking number and carrier state of the return shipment, or
    // `null`. `status` is carrier text, not an order-state code.
    track: string;
    // Value of internal_track.
    internal_track: string;
    // Value of status.
    status: string;
    // Value of carrier_name.
    carrier_name: Record<string, {
      // Optional value of carrier_name; it may be omitted.
      carrier_name?: string;
    }>;
    // Value of carrier_logo.
    carrier_logo: string | null;
  } | null;
  // The order the return belongs to, returned only for a conversation read by
  // its own ID. Its items and options carry the return counts of this return;
  // their own conversations are left out.
  order?: IOrder | null;
}