PATCH v3/basket/gift-vouchers
Update the details of a number of gift vouchers in the current basket
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
giftVoucherIds | Collection of string |
None. |
Body Parameters
GiftVoucherPatchName | Description | Type | Additional information |
---|---|---|---|
Amount | decimal number |
None. |
|
ToName | string |
None. |
|
FromName | string |
None. |
|
SendDate | date |
None. |
|
DeliveryType | VoucherDeliveryType |
None. |
|
DeliveryEmailAddress | string |
None. |
|
Message | string |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json
Sample:
{ "amount": 1.0, "toName": "sample string 3", "fromName": "sample string 5", "sendDate": "2023-12-01T20:21:21.8795797+00:00", "deliveryType": "CustomerEmail", "deliveryEmailAddress": "sample string 9", "message": "sample string 11" }
text/xml
Sample:
<GiftVoucherPatch> <Amount>1</Amount> <ToName>sample string 3</ToName> <FromName>sample string 5</FromName> <SendDate>2023-12-01T20:21:21.8795797+00:00</SendDate> <DeliveryType>CustomerEmail</DeliveryType> <DeliveryEmailAddress>sample string 9</DeliveryEmailAddress> <Message>sample string 11</Message> </GiftVoucherPatch>
Response Information
Resource Description
Collection of GiftVoucherName | Description | Type | Additional information |
---|---|---|---|
ToName | string |
None. |
|
Message | string |
None. |
|
FromName | string |
None. |
|
Amount | decimal number |
None. |
|
SendDate | date |
None. |
|
DeliveryType | VoucherDeliveryType |
None. |
|
DeliveryEmailAddress |
The email address that the gift voucher is delivered to |
string |
None. |
Id | string |
None. |
Response Formats
application/json, text/xml
Sample:
Sample not available.