POST api/account/customer/order/{orderID}/line/voucher

Request Information

URI Parameters

Name	Description	Type	Additional information
orderID		integer	Required

Body Parameters

VoucherCreateModel

Name	Type	Additional information
Quantity	decimal number	None.
UnitPrice	decimal number	None.
ProductID	integer	None.
GiftCardTypeID	integer	None.
Message	string	None.
PersonTitleID	integer	None.
FirstName	string	None.
LastName	string	None.
Organisation	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
City	string	None.
Region	string	None.
Postcode	string	None.
CountryID	integer	None.
Phone	string	None.
EmailAddress	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Quantity": 1.1,
  "UnitPrice": 2.0,
  "ProductID": 3,
  "GiftCardTypeID": 4,
  "Message": "sample string 5",
  "PersonTitleID": 1,
  "FirstName": "sample string 6",
  "LastName": "sample string 7",
  "Organisation": "sample string 8",
  "AddressLine1": "sample string 9",
  "AddressLine2": "sample string 10",
  "City": "sample string 11",
  "Region": "sample string 12",
  "Postcode": "sample string 13",
  "CountryID": 1,
  "Phone": "sample string 14",
  "EmailAddress": "sample string 15"
}

application/xml, text/xml

Sample:

<VoucherCreateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cag.Web.API.Areas.Account.Models.CustomerOrderLine">
  <AddressLine1>sample string 9</AddressLine1>
  <AddressLine2>sample string 10</AddressLine2>
  <City>sample string 11</City>
  <CountryID>1</CountryID>
  <EmailAddress>sample string 15</EmailAddress>
  <FirstName>sample string 6</FirstName>
  <GiftCardTypeID>4</GiftCardTypeID>
  <LastName>sample string 7</LastName>
  <Message>sample string 5</Message>
  <Organisation>sample string 8</Organisation>
  <PersonTitleID>1</PersonTitleID>
  <Phone>sample string 14</Phone>
  <Postcode>sample string 13</Postcode>
  <ProductID>3</ProductID>
  <Quantity>1.1</Quantity>
  <Region>sample string 12</Region>
  <UnitPrice>2</UnitPrice>
</VoucherCreateModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.