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>
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"
LoyaltiesCreateEarningRuleResponse
LoyaltiesCreateMemberResponse
LoyaltiesGetCampaignResponse
LoyaltiesGetMemberResponse
LoyaltiesUpdateCampaignResponse
LoyaltiesUpdateEarningRuleResponse
LoyaltiesUpdateRewardAssignmentResponse
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
RewardsCreateAssignmentResponse
RewardsType
RewardsType: RewardsTypeCampaign | RewardsTypeCoin | RewardsTypeMaterial
RewardsTypeResponse
RewardsTypeResponse: Required<RewardsTypeCampaignResponse> | Required<RewardsTypeCoin> | Required<RewardsTypeMaterial>
RewardsUpdateAssignmentResponse
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
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 }