OrderCouponDTO Object

Overview

The REST API makes use of the OrderCouponDTO object whenever working with orders that have one or more coupons.  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. 

OrderCouponDTO

The OrderCouponDTO object will contain all of the most common details of a single coupon for orders made in your Hotcakes Commerce store.

Members

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

Member Default Description
CouponCode (empty string) The coupon code for the current order coupon.
Id 0 The unique ID of the order coupon.
IsUsed False Defines whether or not the current order coupon has been used.
LastUpdatedUtc UtcNow The last updated date is used for auditing purposes to know when the order coupon was last updated.
OrderBvin (empty string) The unique ID or bvin of the order that this order coupon belongs to.
StoreId 0 This is the ID of the Hotcakes store. Typically, this is 1, except in multi-tenant environments.
UserId (empty string) Records the user account ID that is using the coupon.

 

Example of OrderCouponDTO

{
   "Coupons":[
         {
            "Id":1,
            "StoreId":1,
            "LastUpdatedUtc":"\/Date(1406677252647)\/",
            "OrderBvin":"ddea7421-501d-44ce-b94f-48e10b8baff5",
            "CouponCode":"SUMMER",
            "IsUsed":false,
            "UserId":"1"
         }
   ]
}
Have more questions? Submit a request

Need More Help?

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