POST v4/store/useGiftCard

Request Information

URI Parameters

None.

Body Parameters

StorePopsGiftCardData
NameDescriptionTypeAdditional information
id

integer

None.

code

string

None.

createdDate

date

None.

expirationDate

date

None.

itemDescription

string

None.

imageUrl

string

None.

recipientName

string

None.

recipientEmail

string

None.

used

boolean

None.

usedDate

date

None.

usedPlace

string

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "code": "sample string 2",
  "createdDate": "2022-10-07T13:31:42.5917066-06:00",
  "expirationDate": "2022-10-07T13:31:42.5917066-06:00",
  "itemDescription": "sample string 5",
  "imageUrl": "sample string 6",
  "recipientName": "sample string 7",
  "recipientEmail": "sample string 8",
  "used": true,
  "usedDate": "2022-10-07T13:31:42.5917066-06:00",
  "usedPlace": "sample string 10"
}

application/xml, text/xml

Sample:
<StorePopsGiftCardData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blumev3.Models">
  <code>sample string 2</code>
  <createdDate>2022-10-07T13:31:42.5917066-06:00</createdDate>
  <expirationDate>2022-10-07T13:31:42.5917066-06:00</expirationDate>
  <id>1</id>
  <imageUrl>sample string 6</imageUrl>
  <itemDescription>sample string 5</itemDescription>
  <recipientEmail>sample string 8</recipientEmail>
  <recipientName>sample string 7</recipientName>
  <used>true</used>
  <usedDate>2022-10-07T13:31:42.5917066-06:00</usedDate>
  <usedPlace>sample string 10</usedPlace>
</StorePopsGiftCardData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

StorePopsGiftCardResponse
NameDescriptionTypeAdditional information
apiStatus

string

None.

isApproved

boolean

None.

data

StorePopsGiftCardData

None.

Response Formats

application/json, text/json

Sample:
{
  "apiStatus": "sample string 1",
  "isApproved": true,
  "data": {
    "id": 1,
    "code": "sample string 2",
    "createdDate": "2022-10-07T13:31:42.5917066-06:00",
    "expirationDate": "2022-10-07T13:31:42.5917066-06:00",
    "itemDescription": "sample string 5",
    "imageUrl": "sample string 6",
    "recipientName": "sample string 7",
    "recipientEmail": "sample string 8",
    "used": true,
    "usedDate": "2022-10-07T13:31:42.5917066-06:00",
    "usedPlace": "sample string 10"
  }
}

application/xml, text/xml

Sample:
<StorePopsGiftCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blumev3.Models">
  <apiStatus>sample string 1</apiStatus>
  <data>
    <code>sample string 2</code>
    <createdDate>2022-10-07T13:31:42.5917066-06:00</createdDate>
    <expirationDate>2022-10-07T13:31:42.5917066-06:00</expirationDate>
    <id>1</id>
    <imageUrl>sample string 6</imageUrl>
    <itemDescription>sample string 5</itemDescription>
    <recipientEmail>sample string 8</recipientEmail>
    <recipientName>sample string 7</recipientName>
    <used>true</used>
    <usedDate>2022-10-07T13:31:42.5917066-06:00</usedDate>
    <usedPlace>sample string 10</usedPlace>
  </data>
  <isApproved>true</isApproved>
</StorePopsGiftCardResponse>