Type aliases
ApplicableToEffect
ApplicableToEffect: "APPLY_TO_EVERY" | "APPLY_TO_CHEAPEST" | "APPLY_TO_MOST_EXPENSIVE"
CampaignsAddCertainVoucherParams
Campaigns
AddCertainVoucherParams: Pick<Partial<VouchersImport>, "category" | "redemption" | "metadata" | "additional_info">
CampaignsAddCertainVoucherResponse
CampaignsAddVoucherBody
Campaigns
AddVoucherBody: Pick<Partial<VouchersImport>, "code_config" | "category" | "redemption" | "metadata" | "additional_info">
CampaignsAddVoucherResponse
Campaigns
AddVoucherResponse: Pick<VouchersResponse, "code" | "object" | "campaign" | "category" | "created_at" | "type" | "discount" | "gift" | "start_date" | "expiration_date" | "publish" | "redemption" | "active" | "additional_info" | "metadata" | "assets">
CampaignsCreateCampaign
Campaigns
CreateCampaign: Omit<CampaignResponse, "id" | "protected" | "vouchers_generation_status" | "validation_rules_assignments" | "object" | "created_at" | "active"> & { active?: boolean }
CampaignsCreateCampaignResponse
CampaignsGetCampaignResponse
CampaignsImportVouchers
Campaigns
ImportVouchers: Pick<VouchersImport, "code" | "redemption" | "metadata" | "additional_info" | "active">
CampaignsUpdateCampaign
Campaigns
UpdateCampaign: Pick<CampaignResponse, "start_date" | "expiration_date" | "type" | "description" | "metadata">
CampaignsUpdateCampaignResponse
CampaignsVouchersImportResponse
CampaignsVouchersImportResponse: { async_action_id: string }
ClientSideConsentsListResponse
ClientSideCustomersCreateParams
ClientSideCustomersCreateResponse
ClientSideCustomersUpdateConsentsBody
ClientSideListVouchersParams
ClientSidePublishPreparedPayload
ClientSidePublishResponse
ClientSideRedeemOrder
Client
SideRedeemOrder: Partial<Pick<OrdersCreateResponse, "id" | "source_id" | "metadata" | "amount">> & { items?: ClientSideItem[] }
ClientSideRedemptionsRedeemStackableParams
ClientSideRedemptionsRedeemStackableResponse
ClientSideValidationValidateStackableResponse
ClientSideValidationsValidateStackableParams
ClientSideVoucherListing
Client
SideVoucherListing: Pick<VouchersResponse, "active" | "code" | "metadata" | "assets" | "object" | "expiration_date" | "start_date" | "created_at">
CustomerUnconfirmed
Customer
Unconfirmed: Pick<CustomerObject, "summary" | "email" | "loyalty"> & { object: "unconfirmed_customer" }
CustomersUpdateConsentsBody
CustomersUpdateConsentsBody: Record<string, boolean>
CustomersUpdateInBulkRequestBody
CustomersUpdateInBulkRequestBody: (CustomerBase & CustomerAddress & { source_id: string | null })[]
DiscountAmountVouchersEffectTypes
DiscountAmountVouchersEffectTypes: "APPLY_TO_ORDER" | "APPLY_TO_ITEMS" | "APPLY_TO_ITEMS_PROPORTIONALLY" | "APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY"
DiscountFixedVouchersEffectTypes
DiscountFixedVouchersEffectTypes: "APPLY_TO_ORDER" | "APPLY_TO_ITEMS"
DiscountPercentVouchersEffectTypes
DiscountPercentVouchersEffectTypes: "APPLY_TO_ORDER" | "APPLY_TO_ITEMS"
DiscountUnitVouchersEffectTypes
DiscountUnitVouchersEffectTypes: "ADD_MISSING_ITEMS" | "ADD_NEW_ITEMS" | "ADD_MANY_ITEMS"
DiscountVouchersEffectTypes
DiscountVouchersEffectTypes: "ADD_MISSING_ITEMS" | "ADD_NEW_ITEMS" | "ADD_MANY_ITEMS" | "APPLY_TO_ORDER" | "APPLY_TO_ITEMS" | "APPLY_TO_ITEMS_PROPORTIONALLY" | "APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY"
DiscountVouchersTypes
DiscountVouchersTypes: "AMOUNT" | "PERCENT" | "UNIT" | "FIXED"
EarningRule
Earning
Rule: EarningRuleBase & { active: boolean; updated_at: string | null; validation_rule_id: string | null }
EarningRuleEvent
EarningRuleEvent: "order.paid" | "customer.segment.entered" | "custom_event" | "customer.loyalty.tier.upgraded" | "customer.loyalty.tier.downgraded" | "customer.loyalty.tier.prolonged" | "customer.loyalty.tier.joined" | "customer.loyalty.tier.left"
EarningRuleProportionalOrder
EarningRuleProportionalOrderItems
ExportCustomerFields
ExportCustomerFields: "name" | "id" | "description" | "email" | "source_id" | "created_at" | "address_city" | "address_state" | "address_line_1" | "address_line_2" | "address_country" | "address_postal_code" | "redemptions_total_redeemed" | "redemptions_total_failed" | "redemptions_total_succeeded" | "redemptions_total_rolled_back" | "redemptions_total_rollback_failed" | "redemptions_total_rollback_succeeded" | "orders_total_amount" | "orders_total_count" | "orders_average_amount" | "orders_last_order_amount" | "orders_last_order_date" | "loyalty_points" | "loyalty_referred_customers" | "updated_at" | "phone" | "birthday" | "metadata" | "birthdate"
ExportCustomerOrder
Export
CustomerOrder: ExportCustomerFields | "-name" | "-id" | "-description" | "-email" | "-source_id" | "-created_at" | "-address_city" | "-address_state" | "-address_line_1" | "-address_line_2" | "-address_country" | "-address_postal_code" | "-redemptions_total_redeemed" | "-redemptions_total_failed" | "-redemptions_total_succeeded" | "-redemptions_total_rolled_back" | "-redemptions_total_rollback_failed" | "-redemptions_total_rollback_succeeded" | "-orders_total_amount" | "-orders_total_count" | "-orders_average_amount" | "-orders_last_order_amount" | "-orders_last_order_date" | "-loyalty_points" | "-loyalty_referred_customers" | "-updated_at" | "-phone" | "-birthday" | "-metadata" | "-birthdate"
ExportOrderFields
ExportOrderFields: "id" | "source_id" | "created_at" | "updated_at" | "status" | "amount" | "discount_amount" | "items_discount_amount" | "total_discount_amount" | "total_amount" | "customer_id" | "referrer_id" | "metadata"
ExportOrderOrder
Export
OrderOrder: ExportOrderFields | "-id" | "-source_id" | "-created_at" | "-updated_at" | "-status" | "-amount" | "-discount_amount" | "-items_discount_amount" | "-total_discount_amount" | "-total_amount" | "-customer_id" | "-referrer_id" | "-metadata"
ExportPointsExpirationFields
ExportPointsExpirationFields: "id" | "campaign_id" | "voucher_id" | "points" | "status" | "expires_at"
ExportPointsExpirationFilters
ExportPointsExpirationOrder
ExportPublicationFields
ExportPublicationFields: "voucher_code" | "customer_id" | "customer_source_id" | "date" | "channel" | "campaign" | "is_winner" | "metadata"
ExportPublicationOrder
Export
PublicationOrder: ExportPublicationFields | "-voucher_code" | "-customer_id" | "-customer_source_id" | "-date" | "-channel" | "-campaign" | "-is_winner" | "-metadata"
ExportRedemptionFields
ExportRedemptionFields: "id" | "object" | "date" | "voucher_code" | "campaign" | "promotion_tier_id" | "customer_id" | "customer_source_id" | "customer_name" | "tracking_id" | "order_amount" | "gift_amount" | "loyalty_points" | "result" | "failure_code" | "failure_message" | "metadata"
ExportRedemptionOrder
Export
RedemptionOrder: ExportRedemptionFields | "-id" | "-object" | "-date" | "-voucher_code" | "-campaign" | "-promotion_tier_id" | "-customer_id" | "-customer_source_id" | "-customer_name" | "-tracking_id" | "-order_amount" | "-gift_amount" | "-loyalty_points" | "-result" | "-failure_code" | "-failure_message" | "-metadata"
ExportVoucherFields
ExportVoucherFields: "code" | "voucher_type" | "value" | "discount_type" | "campaign" | "category" | "start_date" | "expiration_date" | "gift_balance" | "loyalty_balance" | "redemption_quantity" | "redemption_count" | "active" | "qr_code" | "bar_code" | "metadata" | "id" | "is_referral_code" | "created_at" | "updated_at" | "validity_timeframe_interval" | "validity_timeframe_duration" | "validity_day_of_week" | "discount_amount_limit" | "campaign_id" | "additional_info" | "customer_id" | "discount_unit_type" | "discount_unit_effect" | "customer_source_id"
ExportVoucherOrder
Export
VoucherOrder: ExportVoucherFields | "-code" | "-voucher_type" | "-value" | "-discount_type" | "-campaign" | "-category" | "-start_date" | "-expiration_date" | "-gift_balance" | "-loyalty_balance" | "-redemption_quantity" | "-redemption_count" | "-active" | "-qr_code" | "-bar_code" | "-metadata" | "-id" | "-is_referral_code" | "-created_at" | "-updated_at" | "-validity_timeframe_interval" | "-validity_timeframe_duration" | "-validity_day_of_week" | "-discount_amount_limit" | "-campaign_id" | "-additional_info" | "-customer_id" | "-discount_unit_type" | "-discount_unit_effect" | "-customer_source_id"
ExportVoucherTransactionsFields
ExportVoucherTransactionsFields: "id" | "campaign_id" | "voucher_id" | "type" | "source_id" | "reason" | "source" | "balance" | "amount" | "related_transaction_id" | "created_at" | "details"
ExportVoucherTransactionsFilters
ExportVoucherTransactionsOrder
Export
VoucherTransactionsOrder: ExportVoucherTransactionsFields | "-id" | "-campaign_id" | "-voucher_id" | "-type" | "-source_id" | "-reason" | "-source" | "-balance" | "-amount" | "-related_transaction_id" | "-created_at" | "-details"
FiltersCondition
FiltersCondition: "$in" | "$not_in" | "$is" | "$is_days_ago" | "$is_days_in_future" | "$is_not" | "$has_value" | "$is_unknown" | "$contains" | "$not_contain" | "$starts_with" | "$ends_with" | "$more_than" | "$less_than" | "$more_than_ago" | "$less_than_ago" | "$more_than_future" | "$less_than_future" | "$more_than_equal" | "$less_than_equal" | "$after" | "$before" | "$count" | "$count_less" | "$count_more"
GiftCardTransactionDetails
Junction
Junction: "and" | "AND" | "or" | "OR"
LoyaltiesCreateEarningRuleResponse
LoyaltiesCreateMemberResponse
LoyaltiesCreateTiersRequestBody
Loyalties
CreateTiersRequestBody: (LoyaltyTierBase & { metadata?: Record<string, unknown> })[]
LoyaltiesCreateTiersResponseBody
LoyaltiesDisableEarningRulesResponseBody
Loyalties
DisableEarningRulesResponseBody: EarningRuleBase & { active: false; updated_at: string | null }
LoyaltiesEnableEarningRulesResponseBody
Loyalties
EnableEarningRulesResponseBody: EarningRuleBase & { active: true; updated_at: string | null }
LoyaltiesExportCardTransactionsRequestBody
LoyaltiesExportCardTransactionsResponseBody
LoyaltiesGetCampaignResponse
LoyaltiesGetEarningRuleResponseBody
LoyaltiesGetMemberResponse
LoyaltiesGetRewardAssignmentResponseBody
LoyaltiesGetRewardDetailsResponseBody
Loyalties
GetRewardDetailsResponseBody: Reward
LoyaltiesGetTierResponseBody
LoyaltiesListLoyaltyTierEarningRulesResponseBody
Loyalties
ListLoyaltyTierEarningRulesResponseBody: { data: EarningRule[]; data_ref: "data"; object: "list"; total: number }
Type declaration
-
-
data_ref: "data"
-
object: "list"
-
total: number
LoyaltiesTransferPointsRequestBody
LoyaltiesTransferPointsResponseBody
LoyaltiesTransferPointsResponseBody: { active: boolean; additional_info: string | null; campaign: string; campaign_id: string; categories: Category[]; category: string | null; category_id: string | null; code: string; created_at: string; expiration_date: string | null; holder_id?: string; id: string; is_referral_code: boolean; loyalty_card: { balance: number; next_expiration_date?: string; next_expiration_points?: number; points: number }; metadata: Record<string, unknown>; publish?: { count?: number; entries?: string[]; object: "list"; url?: string }; redemption?: { object?: "list"; quantity: number | null; redeemed_points?: number; redeemed_quantity?: number; redemption_entries?: string[]; url?: string }; start_date: string | null; type: "LOYALTY_CARD"; updated_at?: string; validity_day_of_week: number[] | null; validity_timeframe: { duration?: string; interval?: string } | null }
Type declaration
-
active: boolean
-
additional_info: string | null
-
campaign: string
-
campaign_id: string
-
categories: Category[]
-
category: string | null
-
category_id: string | null
-
code: string
-
created_at: string
-
expiration_date: string | null
-
Optional holder_id?: string
-
id: string
-
is_referral_code: boolean
-
loyalty_card: { balance: number; next_expiration_date?: string; next_expiration_points?: number; points: number }
-
balance: number
-
Optional next_expiration_date?: string
-
Optional next_expiration_points?: number
-
points: number
-
metadata: Record<string, unknown>
-
Optional publish?: { count?: number; entries?: string[]; object: "list"; url?: string }
-
Optional count?: number
-
Optional entries?: string[]
-
object: "list"
-
Optional url?: string
-
Optional redemption?: { object?: "list"; quantity: number | null; redeemed_points?: number; redeemed_quantity?: number; redemption_entries?: string[]; url?: string }
-
Optional object?: "list"
-
quantity: number | null
-
Optional redeemed_points?: number
-
Optional redeemed_quantity?: number
-
Optional redemption_entries?: string[]
-
Optional url?: string
-
start_date: string | null
-
type: "LOYALTY_CARD"
-
Optional updated_at?: string
-
validity_day_of_week: number[] | null
-
validity_timeframe: { duration?: string; interval?: string } | null
LoyaltiesUpdateCampaignResponse
LoyaltiesUpdateEarningRuleResponse
LoyaltiesUpdateRewardAssignmentResponse
LoyaltyCardTransactionsFields
LoyaltyCardTransactionsFields: "id" | "campaign_id" | "voucher_id" | "type" | "source_id" | "reason" | "source" | "balance" | "amount" | "related_transaction_id" | "created_at" | "details"
LoyaltyCardTransactionsType
LoyaltyCardTransactionsType: "POINTS_ACCRUAL" | "POINTS_CANCELLATION" | "POINTS_REDEMPTION" | "POINTS_REFUND" | "POINTS_ADDITION" | "POINTS_REMOVAL" | "POINTS_EXPIRATION" | "POINTS_TRANSFER_IN" | "POINTS_TRANSFER_OUT"
LoyaltyTier
Loyalty
Tier: LoyaltyTierBase & { campaign_id: string; config: { points: { from?: number; to?: number } }; created_at: string; expiration?: { campaign_id: string; created_at: string; customer_id: string; expiration_date?: string; start_date?: string; tier_id: string; updated_at?: string }; id: string; metadata: Record<string, unknown> | null; object: "loyalty_tier"; updated_at?: string | null }
LoyaltyTierRewardItemParameters
PointsExpirationTypes
PointsExpirationTypes: "PROGRAM_RULES" | "CUSTOM_DATE" | "NON_EXPIRING"
ProductsBulkUpdateMetadataResponse
ProductsBulkUpdateMetadataResponse: { async_action_id: string }
ProductsBulkUpdateResponse
ProductsBulkUpdateResponse: { async_action_id: string }
ProductsUpdate
ProductsUpdate: { attributes?: string[]; id?: string; image_url?: string; metadata?: Record<string, any>; name?: string; price?: number; source_id?: string }
Type declaration
-
Optional attributes?: string[]
-
Optional id?: string
-
Optional image_url?: string
-
Optional metadata?: Record<string, any>
-
Optional name?: string
-
Optional price?: number
-
Optional source_id?: string
ProductsUpdateSkuResponse
PromotionTierRedeemDetails
Promotion
TierRedeemDetails: PromotionTier & { summary: { orders: { total_amount: number; total_discount_amount: number }; redemptions: { total_redeemed: number } } }
PromotionTiersCreateResponse
PromotionTiersListResponse
PromotionTiersUpdateParams
PromotionTiersUpdateResponse
RedemptionsRedeemStackableOrderResponse
Redemptions
RedeemStackableOrderResponse: OrdersCreateResponse & { redemptions?: Record<string, { date: string; related_object_id: string; related_object_type: "redemption"; rollback_date?: string; rollback_id?: string; rollback_stacked?: string[]; stacked: string[] }> }
RedemptionsRedeemStackableRedemptionResult
Reward
Reward
: { attributes
?: { description
?: string; image_url
?: string }; created_at
: string; id
: string; name
?: string; object
: "reward"; redeemed
?: string; stock
?: string; updated_at
?: string } & RewardType
RewardsCreateAssignmentRequestBody
RewardsCreateAssignmentResponse
RewardsCreateAssignmentResponseBody
RewardsGetAssignmentResponseBody
RewardsType
RewardsType: RewardsTypeCampaign | RewardsTypeCoin | RewardsTypeMaterial
RewardsTypeResponse
RewardsTypeResponse: Required<RewardsTypeCampaignResponse> | Required<RewardsTypeCoin> | Required<RewardsTypeMaterial>
RewardsUpdateAssignmentResponse
RewardsUpdateAssignmentResponseBody
SimpleRollback
Simple
Rollback: Pick<RedemptionsRollbackResponse, "id" | "object" | "date" | "customer_id" | "tracking_id" | "redemption" | "result" | "customer"> & { gift?: { amount: number }; loyalty_card?: { points: number }; related_object_type: "voucher"; voucher: { campaign?: string; campaign_id?: string; code: string; id: string; object: "voucher" } }
StackableRedeemableObject
StackableRedeemableObject: "promotion_stack" | "promotion_tier" | "voucher"
StackableRedeemableResponseStatus
StackableRedeemableResponseStatus: "APPLICABLE" | "INAPPLICABLE" | "SKIPPED"
ValidationRulesGetResponse
ValidationRulesUpdateResponse
ValidationSessionTTLUnit
ValidationSessionTTLUnit: "DAYS" | "HOURS" | "MICROSECONDS" | "MILLISECONDS" | "MINUTES" | "NANOSECONDS" | "SECONDS"
ValidationSessionType
ValidationSessionType: "LOCK"
ValidationsValidateContext
VoucherTransactionsExportFields
VoucherTransactionsExportFields: "id" | "campaign_id" | "voucher_id" | "type" | "source_id" | "reason" | "source" | "balance" | "amount" | "related_transaction_id" | "created_at" | "details"
VoucherType
VoucherType: "GIFT_VOUCHER" | "DISCOUNT_VOUCHER" | "LOYALTY_CARD" | "LUCKY_DRAW"
VouchersBulkUpdateMetadataResponse
VouchersBulkUpdateMetadataResponse: { async_action_id: string }
VouchersBulkUpdateResponse
VouchersBulkUpdateResponse: { async_action_id: string }
VouchersImportResponse
VouchersImportResponse: { async_action_id: string }