OrderTransactionGiftCardDataDTO Object

Overview

The REST API occasionally makes use of the OrderTransactionGiftCardDataDTO object whenever a gift card is used with a transaction.  This article will help you to know the various members of this object.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript

Getting Started

There are no tasks needed to get started with understanding this object. 

OrderTransactionGiftCardDataDTO

The OrderTransactionGiftCardDataDTO object will contain all of the details of a gift card used in a transaction for your Hotcakes Commerce store.

Members

The following table gives you details on the various members of the OrderTransactionGiftCardDataDTO object.  The descriptions are based upon default functionality and the default Viewset included with Hotcakes.

Member Default Description
Amount 0 The amount that the gift card was purchased for.
CardNumber (empty string) The assigned gift card number for this card.
ExpirationDate UtcNow The date that the gift card will expire.
LineItemId 0 The unique ID of the line item in the order for this gift card.
RecipientEmail (empty string) The email address of the gift card recipient.
RecipientName (empty string) The full name of the gift card recipient.
SecurityCode (empty string) A code used to validate the gift card.

 

Example of OrderTransactionGiftCardDataDTO

{
   "GiftCard":{
      "LineItemId":1,
      "CardNumber":"GC123456",
      "SecurityCode":"",
      "Amount":100,
      "RecipientName":"John Dough",
      "RecipientEmail":"info@hotcakescommerce.com",
      "ExpirationDate":"\/Date(1406671991878)\/"
   }
}
Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.