POST api/vouchers/applyVoucher

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
MemberOrderID		integer	None.
VoucherCode		string	None.

Request Formats

application/json, text/json

Sample:

{
  "MemberOrderID": 1,
  "VoucherCode": "sample string 1"
}

application/xml, text/xml

Sample:

<ApplyVoucherDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Opimian.Wimps.DTO.CmsDTOs">
  <MemberOrderID>1</MemberOrderID>
  <VoucherCode>sample string 1</VoucherCode>
</ApplyVoucherDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ApplyVoucherDTO'.

Response Information

Resource Description

CmsOrders

Name	Type	Additional information
ID	integer	None.
MemberID	integer	None.
OrderNumber	integer	None.
OrderDate	date	None.
OrderStatusID	integer	None.
CreditCardNumber	string	None.
CreditCardExpirationMonth	integer	None.
CreditCardExpirationYear	integer	None.
Total	decimal number	None.
Credit	decimal number	None.
SubTotal	decimal number	None.
OrderConfirmationID	integer	None.
LotOrderItems	Collection of CmsOrdersLots	None.
EventOrderItems	Collection of CmsOrdersEvents	None.
ProductOrderItems	Collection of CmsOrdersProducts	None.
VoucherOrderItems	Collection of CmsOrdersVouchers	None.
AppliedPromocodeItems	Collection of CmsApplliedPromocodeOrderItem	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "MemberID": 1,
  "OrderNumber": 1,
  "OrderDate": "2025-08-02T15:05:50.0456703Z",
  "OrderStatusID": 1,
  "CreditCardNumber": "sample string 1",
  "CreditCardExpirationMonth": 1,
  "CreditCardExpirationYear": 1,
  "Total": 1.0,
  "Credit": 1.0,
  "SubTotal": 1.0,
  "OrderConfirmationID": 1,
  "LotOrderItems": [
    {
      "ID": 1,
      "LotID": 1,
      "NoOffering": "sample string 1",
      "NoLot": 1,
      "LotName": "sample string 2",
      "WineCountry": "sample string 3",
      "WineCountryID": 1,
      "WineRegion": "sample string 4",
      "WineRegionID": 1,
      "WineYear": 1,
      "Maturity": 1,
      "Drinkability": 1,
      "DrinkingWindow": "sample string 5",
      "Quantity": 1,
      "BottlePrice": 1.0,
      "CasePrice": 1.0
    },
    {
      "ID": 1,
      "LotID": 1,
      "NoOffering": "sample string 1",
      "NoLot": 1,
      "LotName": "sample string 2",
      "WineCountry": "sample string 3",
      "WineCountryID": 1,
      "WineRegion": "sample string 4",
      "WineRegionID": 1,
      "WineYear": 1,
      "Maturity": 1,
      "Drinkability": 1,
      "DrinkingWindow": "sample string 5",
      "Quantity": 1,
      "BottlePrice": 1.0,
      "CasePrice": 1.0
    }
  ],
  "EventOrderItems": [
    {
      "ID": 1,
      "EventID": 1,
      "EventProductPriceID": 1,
      "EventName": "sample string 1",
      "EventNo": "sample string 2",
      "EventDate": "2025-08-02T15:05:50.0456703Z",
      "EventAddress": "sample string 3",
      "EventCity": "sample string 4",
      "EventProvince": "sample string 5",
      "EventProvinceID": 1,
      "ActivityName": "sample string 6",
      "Quantity": 1
    },
    {
      "ID": 1,
      "EventID": 1,
      "EventProductPriceID": 1,
      "EventName": "sample string 1",
      "EventNo": "sample string 2",
      "EventDate": "2025-08-02T15:05:50.0456703Z",
      "EventAddress": "sample string 3",
      "EventCity": "sample string 4",
      "EventProvince": "sample string 5",
      "EventProvinceID": 1,
      "ActivityName": "sample string 6",
      "Quantity": 1
    }
  ],
  "ProductOrderItems": [
    {
      "ID": 1,
      "ProductID": 1,
      "ProductNameEnglish": "sample string 1",
      "ProductNameFrench": "sample string 2",
      "ProductNo": "sample string 3",
      "Quantity": 1
    },
    {
      "ID": 1,
      "ProductID": 1,
      "ProductNameEnglish": "sample string 1",
      "ProductNameFrench": "sample string 2",
      "ProductNo": "sample string 3",
      "Quantity": 1
    }
  ],
  "VoucherOrderItems": [
    {
      "ID": 1,
      "VoucherID": 1,
      "VoucherNo": "sample string 1",
      "VoucherCategoryID": 1,
      "AppliedAmount": 1.0,
      "VoucherProductNameEnglish": "sample string 2",
      "VoucherProductNameFrench": "sample string 3",
      "VoucherProductID": 1,
      "VoucherDescriptionEnglish": "sample string 4",
      "VoucherDescriptionFrench": "sample string 5",
      "Quantity": 1
    },
    {
      "ID": 1,
      "VoucherID": 1,
      "VoucherNo": "sample string 1",
      "VoucherCategoryID": 1,
      "AppliedAmount": 1.0,
      "VoucherProductNameEnglish": "sample string 2",
      "VoucherProductNameFrench": "sample string 3",
      "VoucherProductID": 1,
      "VoucherDescriptionEnglish": "sample string 4",
      "VoucherDescriptionFrench": "sample string 5",
      "Quantity": 1
    }
  ],
  "AppliedPromocodeItems": [
    {
      "ID": 1,
      "Name": "sample string 1",
      "CodeFrench": "sample string 2",
      "CodeEnglish": "sample string 3",
      "Discount": 1.0
    },
    {
      "ID": 1,
      "Name": "sample string 1",
      "CodeFrench": "sample string 2",
      "CodeEnglish": "sample string 3",
      "Discount": 1.0
    }
  ]
}

application/xml, text/xml

Sample:

<CmsOrders xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Opimian.Wimps.DTO.CmsDTOs">
  <AppliedPromocodeItems>
    <CmsApplliedPromocodeOrderItem>
      <CodeEnglish>sample string 3</CodeEnglish>
      <CodeFrench>sample string 2</CodeFrench>
      <Discount>1</Discount>
      <ID>1</ID>
      <Name>sample string 1</Name>
    </CmsApplliedPromocodeOrderItem>
    <CmsApplliedPromocodeOrderItem>
      <CodeEnglish>sample string 3</CodeEnglish>
      <CodeFrench>sample string 2</CodeFrench>
      <Discount>1</Discount>
      <ID>1</ID>
      <Name>sample string 1</Name>
    </CmsApplliedPromocodeOrderItem>
  </AppliedPromocodeItems>
  <Credit>1</Credit>
  <CreditCardExpirationMonth>1</CreditCardExpirationMonth>
  <CreditCardExpirationYear>1</CreditCardExpirationYear>
  <CreditCardNumber>sample string 1</CreditCardNumber>
  <EventOrderItems>
    <CmsOrdersEvents>
      <ActivityName>sample string 6</ActivityName>
      <EventAddress>sample string 3</EventAddress>
      <EventCity>sample string 4</EventCity>
      <EventDate>2025-08-02T15:05:50.0456703Z</EventDate>
      <EventID>1</EventID>
      <EventName>sample string 1</EventName>
      <EventNo>sample string 2</EventNo>
      <EventProductPriceID>1</EventProductPriceID>
      <EventProvince>sample string 5</EventProvince>
      <EventProvinceID>1</EventProvinceID>
      <ID>1</ID>
      <Quantity>1</Quantity>
    </CmsOrdersEvents>
    <CmsOrdersEvents>
      <ActivityName>sample string 6</ActivityName>
      <EventAddress>sample string 3</EventAddress>
      <EventCity>sample string 4</EventCity>
      <EventDate>2025-08-02T15:05:50.0456703Z</EventDate>
      <EventID>1</EventID>
      <EventName>sample string 1</EventName>
      <EventNo>sample string 2</EventNo>
      <EventProductPriceID>1</EventProductPriceID>
      <EventProvince>sample string 5</EventProvince>
      <EventProvinceID>1</EventProvinceID>
      <ID>1</ID>
      <Quantity>1</Quantity>
    </CmsOrdersEvents>
  </EventOrderItems>
  <ID>1</ID>
  <LotOrderItems>
    <CmsOrdersLots>
      <BottlePrice>1</BottlePrice>
      <CasePrice>1</CasePrice>
      <Drinkability>1</Drinkability>
      <DrinkingWindow>sample string 5</DrinkingWindow>
      <ID>1</ID>
      <LotID>1</LotID>
      <LotName>sample string 2</LotName>
      <Maturity>1</Maturity>
      <NoLot>1</NoLot>
      <NoOffering>sample string 1</NoOffering>
      <Quantity>1</Quantity>
      <WineCountry>sample string 3</WineCountry>
      <WineCountryID>1</WineCountryID>
      <WineRegion>sample string 4</WineRegion>
      <WineRegionID>1</WineRegionID>
      <WineYear>1</WineYear>
    </CmsOrdersLots>
    <CmsOrdersLots>
      <BottlePrice>1</BottlePrice>
      <CasePrice>1</CasePrice>
      <Drinkability>1</Drinkability>
      <DrinkingWindow>sample string 5</DrinkingWindow>
      <ID>1</ID>
      <LotID>1</LotID>
      <LotName>sample string 2</LotName>
      <Maturity>1</Maturity>
      <NoLot>1</NoLot>
      <NoOffering>sample string 1</NoOffering>
      <Quantity>1</Quantity>
      <WineCountry>sample string 3</WineCountry>
      <WineCountryID>1</WineCountryID>
      <WineRegion>sample string 4</WineRegion>
      <WineRegionID>1</WineRegionID>
      <WineYear>1</WineYear>
    </CmsOrdersLots>
  </LotOrderItems>
  <MemberID>1</MemberID>
  <OrderConfirmationID>1</OrderConfirmationID>
  <OrderDate>2025-08-02T15:05:50.0456703Z</OrderDate>
  <OrderNumber>1</OrderNumber>
  <OrderStatusID>1</OrderStatusID>
  <ProductOrderItems>
    <CmsOrdersProducts>
      <ID>1</ID>
      <ProductID>1</ProductID>
      <ProductNameEnglish>sample string 1</ProductNameEnglish>
      <ProductNameFrench>sample string 2</ProductNameFrench>
      <ProductNo>sample string 3</ProductNo>
      <Quantity>1</Quantity>
    </CmsOrdersProducts>
    <CmsOrdersProducts>
      <ID>1</ID>
      <ProductID>1</ProductID>
      <ProductNameEnglish>sample string 1</ProductNameEnglish>
      <ProductNameFrench>sample string 2</ProductNameFrench>
      <ProductNo>sample string 3</ProductNo>
      <Quantity>1</Quantity>
    </CmsOrdersProducts>
  </ProductOrderItems>
  <SubTotal>1</SubTotal>
  <Total>1</Total>
  <VoucherOrderItems>
    <CmsOrdersVouchers>
      <AppliedAmount>1</AppliedAmount>
      <ID>1</ID>
      <Quantity>1</Quantity>
      <VoucherCategoryID>1</VoucherCategoryID>
      <VoucherDescriptionEnglish>sample string 4</VoucherDescriptionEnglish>
      <VoucherDescriptionFrench>sample string 5</VoucherDescriptionFrench>
      <VoucherID>1</VoucherID>
      <VoucherNo>sample string 1</VoucherNo>
      <VoucherProductID>1</VoucherProductID>
      <VoucherProductNameEnglish>sample string 2</VoucherProductNameEnglish>
      <VoucherProductNameFrench>sample string 3</VoucherProductNameFrench>
    </CmsOrdersVouchers>
    <CmsOrdersVouchers>
      <AppliedAmount>1</AppliedAmount>
      <ID>1</ID>
      <Quantity>1</Quantity>
      <VoucherCategoryID>1</VoucherCategoryID>
      <VoucherDescriptionEnglish>sample string 4</VoucherDescriptionEnglish>
      <VoucherDescriptionFrench>sample string 5</VoucherDescriptionFrench>
      <VoucherID>1</VoucherID>
      <VoucherNo>sample string 1</VoucherNo>
      <VoucherProductID>1</VoucherProductID>
      <VoucherProductNameEnglish>sample string 2</VoucherProductNameEnglish>
      <VoucherProductNameFrench>sample string 3</VoucherProductNameFrench>
    </CmsOrdersVouchers>
  </VoucherOrderItems>
</CmsOrders>