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

Update the details of a specific gift voucher in a basket

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

giftVoucherId

string

Required

Body Parameters

GiftVoucherPatch
NameDescriptionTypeAdditional 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": "2022-12-05T11:20:09.5828158+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>2022-12-05T11:20:09.5828158+00:00</SendDate>
  <DeliveryType>CustomerEmail</DeliveryType>
  <DeliveryEmailAddress>sample string 9</DeliveryEmailAddress>
  <Message>sample string 11</Message>
</GiftVoucherPatch>

Response Information

Resource Description

GiftVoucher
NameDescriptionTypeAdditional 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.