PATCH v3/baskets/{id}/gift-vouchers/{giftVoucherId}

Update the details of a specific gift voucher in a basket

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required
giftVoucherId		string	Required

Body Parameters

GiftVoucherPatch

Name	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": "2024-10-31T04:07:59.3938308+00:00",
  "deliveryType": "CustomerEmail",
  "deliveryEmailAddress": "sample string 9",
  "message": "sample string 11"
}

text/xml

Sample:

The response/request for text/xml format is no longer supported for this endpoint.

Response Information

Resource Description

GiftVoucher

Name	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.