RitualsAddGiftCardToOrder

A specific implementation for AddProductToOrder for GiftCards. Adds a new order line for a digital GiftCard to specified order, where OrderID identifies the current order for the customer and Amount is the desired amount to create a GiftCard for.

Optionally supply a UpdateUrl pointing to the website you want the buyer of the GiftCard to land to see/manage the order.

Additionally, the Data property need to be supplied;

From and To are the names of the sender and recipient of this gift, respectively
Text is an additional text to be included on the GiftCard and presented to the recipient (optional)
Theme is an object describing the theme, style or 'ritual' desired for this GiftCard;
- ID is a string identifying this theme
- Name is it's name, for display
- Description and LongDescription to describe the theme
- BackgroundColor and ForegroundColor allow setting colors to the giftcard
- ImageUrl, ImageWidth and ImageHeight describe the image used

Hierarchy

RitualsAddGiftCardToOrder

Index

Properties

Amount

Amount: number

Optional CloudinaryImageID

CloudinaryImageID: undefined | string

Optional CloudinaryImageMimeType

CloudinaryImageMimeType: undefined | string

Optional CloudinaryVideoID

CloudinaryVideoID: undefined | string

Optional CloudinaryVideoMimeType

CloudinaryVideoMimeType: undefined | string

Data

Data: GiftCardData

OrderID

OrderID: number

Entity type: Order

Optional UpdateUrl

UpdateUrl: undefined | string