POST api/OmsGiftCard/GetGiftCardDetails

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
OrderId	integer	None.
SiteId	integer	None.
OrderItemId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderId": 1,
  "SiteId": 2,
  "OrderItemId": 3
}

application/xml, text/xml

Sample:

<GiftCardDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <OrderId>1</OrderId>
  <OrderItemId>3</OrderItemId>
  <SiteId>2</SiteId>
</GiftCardDetailsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GiftCardDetailsResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
GiftCardDetail	GiftCardDetailModel	None.
CorrelationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "GiftCardDetail": {
    "GiftCardNumber": "sample string 1",
    "GiftCardPinNumber": "sample string 2",
    "ToName": "sample string 3",
    "ToEmail": "sample string 4",
    "FromName": "sample string 5",
    "FromEmail": "sample string 6",
    "Message": "sample string 7",
    "GiftCardType": "sample string 8",
    "Balance": "sample string 9",
    "Transactions": [
      {
        "TransactionDate": "sample string 1",
        "TransactionDetail": "sample string 2",
        "TransactionAmount": "sample string 3"
      },
      {
        "TransactionDate": "sample string 1",
        "TransactionDetail": "sample string 2",
        "TransactionAmount": "sample string 3"
      }
    ],
    "OrderID": 10,
    "OrderItemID": 11,
    "ToNameOldValue": "sample string 12",
    "ToEmailOldValue": "sample string 13",
    "FromNameOldValue": "sample string 14",
    "FromEmailOldValue": "sample string 15",
    "MessageOldValue": "sample string 16",
    "GiftCardValue": "sample string 17",
    "IsReadonly": true
  },
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:

<GiftCardDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <CorrelationId>sample string 2</CorrelationId>
  <GiftCardDetail xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
    <d2p1:Balance>sample string 9</d2p1:Balance>
    <d2p1:FromEmail>sample string 6</d2p1:FromEmail>
    <d2p1:FromEmailOldValue>sample string 15</d2p1:FromEmailOldValue>
    <d2p1:FromName>sample string 5</d2p1:FromName>
    <d2p1:FromNameOldValue>sample string 14</d2p1:FromNameOldValue>
    <d2p1:GiftCardNumber>sample string 1</d2p1:GiftCardNumber>
    <d2p1:GiftCardPinNumber>sample string 2</d2p1:GiftCardPinNumber>
    <d2p1:GiftCardType>sample string 8</d2p1:GiftCardType>
    <d2p1:GiftCardValue>sample string 17</d2p1:GiftCardValue>
    <d2p1:IsReadonly>true</d2p1:IsReadonly>
    <d2p1:Message>sample string 7</d2p1:Message>
    <d2p1:MessageOldValue>sample string 16</d2p1:MessageOldValue>
    <d2p1:OrderID>10</d2p1:OrderID>
    <d2p1:OrderItemID>11</d2p1:OrderItemID>
    <d2p1:ToEmail>sample string 4</d2p1:ToEmail>
    <d2p1:ToEmailOldValue>sample string 13</d2p1:ToEmailOldValue>
    <d2p1:ToName>sample string 3</d2p1:ToName>
    <d2p1:ToNameOldValue>sample string 12</d2p1:ToNameOldValue>
    <d2p1:Transactions>
      <d2p1:GiftCardTransaction>
        <d2p1:TransactionAmount>sample string 3</d2p1:TransactionAmount>
        <d2p1:TransactionDate>sample string 1</d2p1:TransactionDate>
        <d2p1:TransactionDetail>sample string 2</d2p1:TransactionDetail>
      </d2p1:GiftCardTransaction>
      <d2p1:GiftCardTransaction>
        <d2p1:TransactionAmount>sample string 3</d2p1:TransactionAmount>
        <d2p1:TransactionDate>sample string 1</d2p1:TransactionDate>
        <d2p1:TransactionDetail>sample string 2</d2p1:TransactionDetail>
      </d2p1:GiftCardTransaction>
    </d2p1:Transactions>
  </GiftCardDetail>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</GiftCardDetailsResponse>