Type alias RateShopper

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: {
          percentage?: number;
          price?: SE.Money;
      };
      service: RateShopperService;
  }

  Service Preference of the RateShopper

  • priceTolerance: {
        percentage?: number;
        price?: SE.Money;
    }

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

    • Optional percentage?: number

    • Optional price?: SE.Money

  • 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