Skip to content

Files

21 lines (17 loc) · 2.3 KB

PurchaseGiftCardRequest.md

File metadata and controls

21 lines (17 loc) · 2.3 KB

PurchaseGiftCardRequest

Properties

Name Type Description Notes
test bool When `true`, allows you to test the request without affecting the database.<br /> When `false`, the request is carried out and the database is affected. [optional]
location_id int The ID of the location where the gift card is being sold.
layout_id int The ID of the layout used for the gift card’s image. [optional]
purchaser_client_id string The RSSID of the client who is purchasing the gift card.
gift_card_id int The product ID of the gift card being purchased.
send_email_receipt bool When `true`, indicates that a purchase receipt email should be sent to the purchasing client, if all settings are correctly configured.<br /> When `false`, no email is sent to the purchaser. [optional]
recipient_email string The email address to send the gift card image to. This parameter is required if the `LayoutId` is not 0.<br /> Maximum length: 100 [optional]
recipient_name string The name of the person who is to receive the gift card. This parameter is required if the `LayoutId` is not 0.<br /> Maximum length: 20 [optional]
title string The text to use as the title of the gift card, for example: Happy Birthday, Maria! This parameter is required if the `LayoutId` is not 0.<br /> Maximum length: 20 [optional]
gift_message string A personal message to include in the gift card.<br /> Maximum length: 300 [optional]
delivery_date \DateTime The date that the gift card’s image is to be delivered to the recipient. This parameter cannot be set to a date in the past. This parameter is required if the `LayoutId` is not 0. Default: today Minimum: today [optional]
payment_info \Swagger\Client\Model\CheckoutPaymentInfo Contains information about the payment. [optional]

[Back to Model list] [Back to API list] [Back to README]