POST api/account/customer/order/{orderID}/line/gift
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
orderID | integer |
Required |
Body Parameters
GiftCreateModelName | Description | Type | Additional information |
---|---|---|---|
DeliveryDate | date |
Required |
|
DeliveryDayName | string |
None. |
|
DeliveryInstructions | string |
Max length: 50 |
|
Adults | integer |
None. |
|
Children | integer |
None. |
|
GiftCardTypeID | integer |
None. |
|
Message | string |
None. |
|
Notes | string |
None. |
|
CustomerAddressID | integer |
Required |
|
Quantity | decimal number |
None. |
|
UnitPrice | decimal number |
None. |
|
ProductID | integer |
Required |
|
AdditionalProductIDs | Collection of integer |
None. |
|
VoucherCode | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "DeliveryDate": "2025-05-11T10:27:53.1574802+00:00", "DeliveryDayName": "Sunday", "DeliveryInstructions": "sample string 2", "Adults": 1, "Children": 1, "GiftCardTypeID": 1, "Message": "sample string 3", "Notes": "sample string 4", "CustomerAddressID": 5, "Quantity": 6.1, "UnitPrice": 7.0, "ProductID": 8, "AdditionalProductIDs": [ 1, 2 ], "VoucherCode": "sample string 9" }
application/xml, text/xml
Sample:
<GiftCreateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cag.Web.API.Areas.Account.Models.CustomerOrderLine"> <AdditionalProductIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </AdditionalProductIDs> <Adults>1</Adults> <Children>1</Children> <CustomerAddressID>5</CustomerAddressID> <DeliveryDate>2025-05-11T10:27:53.1574802+00:00</DeliveryDate> <DeliveryInstructions>sample string 2</DeliveryInstructions> <GiftCardTypeID>1</GiftCardTypeID> <Message>sample string 3</Message> <Notes>sample string 4</Notes> <ProductID>8</ProductID> <Quantity>6.1</Quantity> <UnitPrice>7</UnitPrice> <VoucherCode>sample string 9</VoucherCode> </GiftCreateModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.