GET api/cart/coupon?cartid={cartid}&couponCode={couponCode}

Request Information

URI Parameters

Name	Description	Type	Additional information
cartid		integer	Required
couponCode		string	Required

Body Parameters

None.

Response Information

Resource Description

Rf_ShoppingCartModel

Name	Type	Additional information
Rf_ShoppingCartID	integer	None.
OfflineID	string	None.
MemberID	integer	None.
Created	date	None.
LastUpdated	date	None.
Purchased	date	None.
TotalPrice	decimal number	None.
TotalRetailPrice	decimal number	None.
PaymentBenefits	PaymentBenefitRet	None.
CartItems	Collection of Rf_ShoppingCartItem	None.
Coupon	CouponCheckInfo	None.
StateIds	string	None.
Success	boolean	None.
Message	string	None.
ReferredBy	integer	None.
CartConflicts	Collection of CartConflict	None.
PricingCampaignID	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Rf_ShoppingCartID": 1,
  "OfflineID": "sample string 2",
  "MemberID": 1,
  "Created": "2025-05-14T00:32:30.5631227+00:00",
  "LastUpdated": "2025-05-14T00:32:30.5631227+00:00",
  "Purchased": "2025-05-14T00:32:30.5631227+00:00",
  "TotalPrice": 1.0,
  "TotalRetailPrice": 1.0,
  "PaymentBenefits": {
    "Title": "sample string 1",
    "Description": "sample string 2",
    "Benefits": "sample string 3"
  },
  "CartItems": [
    {
      "Rf_ShoppingCartItemID": 1,
      "Rf_ShoppingCartID": 2,
      "ProductType": 1,
      "ProductType_ExtID": 1,
      "Description": "sample string 3",
      "Quantity": 1,
      "Created": "2025-05-14T00:32:30.5631227+00:00",
      "Price": 1.0,
      "RetailPrice": 1.0,
      "DiscountAmount": 1.0,
      "CouponMessage": "sample string 4",
      "TotalHours": 1.0,
      "OnDemandHours": 1.0,
      "LiveHours": 1.0,
      "Title": "sample string 5"
    },
    {
      "Rf_ShoppingCartItemID": 1,
      "Rf_ShoppingCartID": 2,
      "ProductType": 1,
      "ProductType_ExtID": 1,
      "Description": "sample string 3",
      "Quantity": 1,
      "Created": "2025-05-14T00:32:30.5631227+00:00",
      "Price": 1.0,
      "RetailPrice": 1.0,
      "DiscountAmount": 1.0,
      "CouponMessage": "sample string 4",
      "TotalHours": 1.0,
      "OnDemandHours": 1.0,
      "LiveHours": 1.0,
      "Title": "sample string 5"
    }
  ],
  "Coupon": {
    "CouponCode": "sample string 1",
    "IsValid": true,
    "TotalDiscount": 3.0,
    "Message": "sample string 4",
    "MessageColor": "sample string 5"
  },
  "StateIds": "sample string 3",
  "Success": true,
  "Message": "sample string 5",
  "ReferredBy": 6,
  "CartConflicts": [
    {
      "Conflict": true,
      "ConflictMessage": "sample string 2",
      "Actions": [
        {
          "ActionDescription": "sample string 1",
          "ActionUrl": "sample string 2",
          "ActionButtonTitle": "sample string 3",
          "ActionButtonType": "sample string 4"
        },
        {
          "ActionDescription": "sample string 1",
          "ActionUrl": "sample string 2",
          "ActionButtonTitle": "sample string 3",
          "ActionButtonType": "sample string 4"
        }
      ]
    },
    {
      "Conflict": true,
      "ConflictMessage": "sample string 2",
      "Actions": [
        {
          "ActionDescription": "sample string 1",
          "ActionUrl": "sample string 2",
          "ActionButtonTitle": "sample string 3",
          "ActionButtonType": "sample string 4"
        },
        {
          "ActionDescription": "sample string 1",
          "ActionUrl": "sample string 2",
          "ActionButtonTitle": "sample string 3",
          "ActionButtonType": "sample string 4"
        }
      ]
    }
  ],
  "PricingCampaignID": 7
}