Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GiftCardCode

Hierarchy

Index

Properties

Properties

Optional Readonly child

child?: Core.Graph

curie

curie: "fx:gift_card_code"

links

links: { fx:customer: Customer; fx:gift_card: GiftCard; fx:gift_card_code_logs: GiftCardCodeLogs; fx:provisioned_by_transaction_detail_id: Backend.Rels.Transaction; fx:store: Backend.Rels.Store; self: GiftCardCode }

Type declaration

  • fx:customer: Customer

    Customer this gift card belongs to.

  • fx:gift_card: GiftCard

    Gift card this code corresponds to.

  • fx:gift_card_code_logs: GiftCardCodeLogs

    Transactions using this gift card code.

  • fx:provisioned_by_transaction_detail_id: Backend.Rels.Transaction

    Transaction that resulted in the creation of this gift card code, if applicable.

  • fx:store: Backend.Rels.Store

    Store this gift card code belongs to.

  • self: GiftCardCode

    This resource.

props

props: { code: string; current_balance: number; customer_id?: string | number; date_created: null | string; date_modified: null | string; end_date: null | string }

Type declaration

  • code: string

    The string value of this gift card code which your customer will add to their cart to use this gift card. Required. 50 characters or less.

  • current_balance: number

    Current balance on the gift card. Decimal. Required.

  • Optional customer_id?: string | number

    PATCH-only: use this field to link this gift card code to a customer.

  • date_created: null | string

    The date this resource was created. Readonly.

  • date_modified: null | string

    The date this resource was last modified. Readonly.

  • end_date: null | string

    The date when this gift card code will expire. ISO date. Optional.

Optional Readonly zooms

zooms?: Readonly<Record<string, undefined | Core.Graph>>

Generated using TypeDoc