POST v4/store/order/giftcards

Request Information

URI Parameters

None.

Body Parameters

StoreOrderGiftCardRequest
NameDescriptionTypeAdditional information
customer

StoreCustomer

None.

address

StoreAddress

None.

order

StoreOrder

None.

transactionLog

StoreTransactionLog

None.

contactList

Collection of StoreOrderGiftCardContact

None.

Request Formats

application/json, text/json

Sample:
{
  "customer": {
    "fullName": "sample string 1",
    "documentId": "sample string 2",
    "email": "sample string 3",
    "phone": "sample string 4",
    "password": "sample string 5"
  },
  "address": {
    "country": "sample string 1",
    "state": "sample string 2",
    "city": "sample string 3",
    "locationDescription": "sample string 4",
    "zipCode": "sample string 5",
    "coordinates": "sample string 6"
  },
  "order": {
    "deliveryMethod": "sample string 1",
    "deliveryType": "sample string 2",
    "paymentMethod": "sample string 3",
    "createdBy": "sample string 4",
    "currency": "sample string 5",
    "subtotal": 6.0,
    "deliveryCost": 7.0,
    "discount": 8.0,
    "tax": 9.0,
    "total": 10.0,
    "customerMessage": "sample string 11",
    "couponName": "sample string 12",
    "items": [
      {
        "productId": 1,
        "description": "sample string 2",
        "quantity": 3,
        "unitPrice": 4.0,
        "total": 5.0,
        "isDiscountPrice": true,
        "imageUrl": "sample string 7"
      },
      {
        "productId": 1,
        "description": "sample string 2",
        "quantity": 3,
        "unitPrice": 4.0,
        "total": 5.0,
        "isDiscountPrice": true,
        "imageUrl": "sample string 7"
      }
    ]
  },
  "transactionLog": {
    "orderId": 1,
    "clientDevice": "sample string 2",
    "clientIp": "sample string 3",
    "clientLocation": "sample string 4",
    "lastFourDigits": "sample string 5",
    "paymentMethod": "sample string 6",
    "auhtCode": "sample string 7",
    "hash": "sample string 8",
    "responseCode": "sample string 9",
    "responseText": "sample string 10",
    "transactionId": "sample string 11"
  },
  "contactList": [
    {
      "name": "sample string 1",
      "email": "sample string 2"
    },
    {
      "name": "sample string 1",
      "email": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<StoreOrderGiftCardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blumev3.Models">
  <address>
    <city>sample string 3</city>
    <coordinates>sample string 6</coordinates>
    <country>sample string 1</country>
    <locationDescription>sample string 4</locationDescription>
    <state>sample string 2</state>
    <zipCode>sample string 5</zipCode>
  </address>
  <contactList>
    <StoreOrderGiftCardContact>
      <email>sample string 2</email>
      <name>sample string 1</name>
    </StoreOrderGiftCardContact>
    <StoreOrderGiftCardContact>
      <email>sample string 2</email>
      <name>sample string 1</name>
    </StoreOrderGiftCardContact>
  </contactList>
  <customer>
    <documentId>sample string 2</documentId>
    <email>sample string 3</email>
    <fullName>sample string 1</fullName>
    <password>sample string 5</password>
    <phone>sample string 4</phone>
  </customer>
  <order>
    <couponName>sample string 12</couponName>
    <createdBy>sample string 4</createdBy>
    <currency>sample string 5</currency>
    <customerMessage>sample string 11</customerMessage>
    <deliveryCost>7</deliveryCost>
    <deliveryMethod>sample string 1</deliveryMethod>
    <deliveryType>sample string 2</deliveryType>
    <discount>8</discount>
    <items>
      <StoreOrderItem>
        <description>sample string 2</description>
        <imageUrl>sample string 7</imageUrl>
        <isDiscountPrice>true</isDiscountPrice>
        <productId>1</productId>
        <quantity>3</quantity>
        <total>5</total>
        <unitPrice>4</unitPrice>
      </StoreOrderItem>
      <StoreOrderItem>
        <description>sample string 2</description>
        <imageUrl>sample string 7</imageUrl>
        <isDiscountPrice>true</isDiscountPrice>
        <productId>1</productId>
        <quantity>3</quantity>
        <total>5</total>
        <unitPrice>4</unitPrice>
      </StoreOrderItem>
    </items>
    <paymentMethod>sample string 3</paymentMethod>
    <subtotal>6</subtotal>
    <tax>9</tax>
    <total>10</total>
  </order>
  <transactionLog>
    <auhtCode>sample string 7</auhtCode>
    <clientDevice>sample string 2</clientDevice>
    <clientIp>sample string 3</clientIp>
    <clientLocation>sample string 4</clientLocation>
    <hash>sample string 8</hash>
    <lastFourDigits>sample string 5</lastFourDigits>
    <orderId>1</orderId>
    <paymentMethod>sample string 6</paymentMethod>
    <responseCode>sample string 9</responseCode>
    <responseText>sample string 10</responseText>
    <transactionId>sample string 11</transactionId>
  </transactionLog>
</StoreOrderGiftCardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

StoreFrontOrderResponse
NameDescriptionTypeAdditional information
apiStatus

string

None.

isApproved

boolean

None.

data

StoreFrontOrderDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "apiStatus": "sample string 1",
  "isApproved": true,
  "data": {
    "id": 1,
    "total": 2.0,
    "urlCode": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<StoreFrontOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blumev3.Models">
  <apiStatus>sample string 1</apiStatus>
  <data>
    <id>1</id>
    <total>2</total>
    <urlCode>sample string 3</urlCode>
  </data>
  <isApproved>true</isApproved>
</StoreFrontOrderResponse>