Type Alias Shipment

Shipment: {
    _links?: {
        order?: {
            href?: string;
        };
        self?: {
            href?: string;
        };
    };
    carrier?: string | null;
    delivered_at?: string | null;
    delivery_status?: delivery_status;
    departure_address?: {
        country_code?: string;
        country_name?: string;
        state_code?: string;
    };
    estimated_delivery?: {
        calculated_at?: string;
        from_date?: string;
        to_date?: string;
    } | null;
    id?: number;
    is_reshipment?: boolean;
    order_external_id?: string | null;
    order_id?: number;
    service?: string | null;
    shipment_items?: ShipmentItem[];
    shipment_status?: shipment_status;
    shipped_at?: string | null;
    tracking_events?: TrackingEvent[];
    tracking_url?: string;
}

Type declaration

  • Optional_links?: {
        order?: {
            href?: string;
        };
        self?: {
            href?: string;
        };
    }
    • Optionalorder?: {
          href?: string;
      }
      • Optionalhref?: string
    • Optionalself?: {
          href?: string;
      }
      • Optionalhref?: string
  • Optionalcarrier?: string | null

    The carrier that will fulfill the shipment.

  • Optionaldelivered_at?: string | null
  • Optionaldelivery_status?: delivery_status
  • Optionaldeparture_address?: {
        country_code?: string;
        country_name?: string;
        state_code?: string;
    }
    • Optionalcountry_code?: string
    • Optionalcountry_name?: string
    • Optionalstate_code?: string
  • Optionalestimated_delivery?: {
        calculated_at?: string;
        from_date?: string;
        to_date?: string;
    } | null
  • Optionalid?: number
  • Optionalis_reshipment?: boolean

    If there is an issue with items in a shipment, a reshipment might be necessary. This property will be false if it is the original shipment and true if it is a reshipment

  • Optionalorder_external_id?: string | null
  • Optionalorder_id?: number
  • Optionalservice?: string | null

    The service being used to fulfill the shipment.

  • Optionalshipment_items?: ShipmentItem[]
  • Optionalshipment_status?: shipment_status
  • Optionalshipped_at?: string | null
  • Optionaltracking_events?: TrackingEvent[]
  • Optionaltracking_url?: string

Settings

Member Visibility