Type alias RateShopper

RateShopper: {
    createdAt: string;
    isActive: boolean;
    name: string;
    rateShopperId: string;
    servicePreference?: {
        priceTolerance: {
            amount?: number;
            percentage?: number;
        };
        service: RateShopperService;
    };
    services: RateShopperService[];
    transitTime?: {
        maxDays?: number;
        maxDaysInternational?: number;
        userDeliverByDate: boolean;
    };
    updatedAt: string;
}

Type declaration

  • createdAt: string

    Created at timestamps

  • isActive: boolean

    Boolean that indicates if the Rate Shopper is active or not

  • name: string

    User given name for the Rate Shopper

  • rateShopperId: string

    ID of the Rate Shopper

  • Optional servicePreference?: {
        priceTolerance: {
            amount?: number;
            percentage?: number;
        };
        service: RateShopperService;
    }

    Service Preference of the RateShopper

    • priceTolerance: {
          amount?: number;
          percentage?: number;
      }

      Price tolerance, could be percentage or price (amount) but not both at the same time

      • Optional amount?: number
      • Optional percentage?: number
    • service: RateShopperService

      Service linked to this Service Preference

  • services: RateShopperService[]

    List of services attached to this Rate Shopper

  • Optional transitTime?: {
        maxDays?: number;
        maxDaysInternational?: number;
        userDeliverByDate: boolean;
    }

    Transit time (days) of the Rate Shopper mechanism

    • Optional maxDays?: number
    • Optional maxDaysInternational?: number
    • userDeliverByDate: boolean
  • updatedAt: string

    Updated at timestamps

Settings

Member Visibility

Theme

Generated using TypeDoc