Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Redemption

Hierarchy

  • Redemption

Index

Properties

Optional customer

customer: SimpleCustomer

Optional customer_id

customer_id: string

Optional date

date: string

Optional failure_code

failure_code: string

Optional failure_message

failure_message: string

Optional gift

gift: { amount: number }

Type declaration

  • amount: number

id

id: string

Optional loyalty_card

loyalty_card: { points: number }

Type declaration

  • points: number

Optional metadata

metadata: Record<string, any>

object

object: "redemption"

Optional order

order: Omit<OrdersCreateResponse, "object"> & { referrer?: string; related_object_id: string; related_object_type: "redemption" }

Optional related_object_type

related_object_type: "string"

result

result: "SUCCESS" | "FAILURE"

Optional tracking_id

tracking_id: string

Optional voucher

voucher: { campaign?: string; campaign_id?: string; code: string; id: string; object: "voucher" }

Type declaration

  • Optional campaign?: string
  • Optional campaign_id?: string
  • code: string
  • id: string
  • object: "voucher"