GET v3/account/pops/giftCardUsage?usageType={usageType}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
usageType

string

Required

Body Parameters

None.

Response Information

Resource Description

giftCardUseResponse
NameDescriptionTypeAdditional information
apiStatus

string

None.

isApproved

boolean

None.

data

Collection of giftCardUse

None.

Response Formats

application/json, text/json

Sample:
{
  "apiStatus": "sample string 1",
  "isApproved": true,
  "data": [
    {
      "customerName": "sample string 1",
      "campaignId": 2,
      "type": "sample string 3",
      "code": "sample string 4",
      "rangeId": 5,
      "expirationDate": "2022-10-07T12:36:46.8232921-06:00",
      "used": true,
      "usedDate": "2022-10-07T12:36:46.8232921-06:00",
      "usedPlace": "sample string 9"
    },
    {
      "customerName": "sample string 1",
      "campaignId": 2,
      "type": "sample string 3",
      "code": "sample string 4",
      "rangeId": 5,
      "expirationDate": "2022-10-07T12:36:46.8232921-06:00",
      "used": true,
      "usedDate": "2022-10-07T12:36:46.8232921-06:00",
      "usedPlace": "sample string 9"
    }
  ]
}

application/xml, text/xml

Sample:
<giftCardUseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blumev3.Models">
  <apiStatus>sample string 1</apiStatus>
  <data>
    <giftCardUse>
      <campaignId>2</campaignId>
      <code>sample string 4</code>
      <customerName>sample string 1</customerName>
      <expirationDate>2022-10-07T12:36:46.8232921-06:00</expirationDate>
      <rangeId>5</rangeId>
      <type>sample string 3</type>
      <used>true</used>
      <usedDate>2022-10-07T12:36:46.8232921-06:00</usedDate>
      <usedPlace>sample string 9</usedPlace>
    </giftCardUse>
    <giftCardUse>
      <campaignId>2</campaignId>
      <code>sample string 4</code>
      <customerName>sample string 1</customerName>
      <expirationDate>2022-10-07T12:36:46.8232921-06:00</expirationDate>
      <rangeId>5</rangeId>
      <type>sample string 3</type>
      <used>true</used>
      <usedDate>2022-10-07T12:36:46.8232921-06:00</usedDate>
      <usedPlace>sample string 9</usedPlace>
    </giftCardUse>
  </data>
  <isApproved>true</isApproved>
</giftCardUseResponse>