Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GiftCard

Hierarchy

Index

Properties

Properties

Optional Readonly child

child?: Core.Graph

curie

curie: "fx:gift_card"

links

links: { fx:attributes: Backend.Rels.Attributes; fx:generate_codes: GenerateCodes; fx:gift_card_codes: GiftCardCodes; fx:gift_card_item_categories: GiftCardItemCategories; fx:store: Backend.Rels.Store; self: GiftCard }

Type declaration

props

props: { currency_code: string; date_created: null | string; date_modified: null | string; expires_after: null | string; name: string; product_code_restrictions: null | string; provisioning_config: null | { allow_autoprovisioning: boolean; initial_balance_max: number; initial_balance_min: number }; sku: null | string }

Type declaration

  • currency_code: string

    Currency code for this gift card. Note that gift cards are only usable if the cart's currency matches. Optional. The 3 character ISO code for the currency.

  • date_created: null | string

    The date this resource was created. ISO date. Read only.

  • date_modified: null | string

    The date this resource was last modified. ISO date. Read only.

  • expires_after: null | string

    This determines when the gift card will expire. The format is a number followed by a date type such as d (day), w (week), m (month), or y (year). You can also use .5m for twice a month, as with subscription frequency settings. Check with your local laws to ensure expiring gift cards is legal, according to your use case. The actual expiration date will be set on the gift_card_code resources when they are created, according to this setting. Optional. If present, the format must be valid, such as 1m, 3w, 45d, etc.

  • name: string

    The name of this gift card. This will be displayed to the customer, such as "Gift Card" or "Store Credit". Required. 50 characters or less.

  • product_code_restrictions: null | string

    If you want to limit which products can use this gift card, you can enter a comma separated listed of product codes or partial product codes using * as a wild card at the beginning or end of the value. So abc123, fun_*, *-small would match abc123, fun_ and fun_times, and example-small. It wouldn't match abc12, abc1234, fun, or good-smalls. Optional. 5000 characters or less.

  • provisioning_config: null | { allow_autoprovisioning: boolean; initial_balance_max: number; initial_balance_min: number }

    Used for provisioning the gift card.

  • sku: null | string

    SKU used to add the gift card to the cart in order to buy it. Optional. 200 characters or less.

zooms

zooms: { gift_card_codes?: GiftCardCodes; gift_card_item_categories?: GiftCardItemCategories }

Type declaration

Generated using TypeDoc