POST v3/baskets/{id}/gift-vouchers

Add a gift voucher(s) to a basket

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

Body Parameters

Collection of NewGiftVoucher
NameDescriptionTypeAdditional information
Amount

decimal number

None.

ToName

string

None.

FromName

string

None.

Message

string

None.

SendDate

date

None.

DeliveryType

VoucherDeliveryType

None.

DeliveryEmailAddress

string

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json

Sample:
[
  {
    "amount": 1.0,
    "toName": "sample string 2",
    "fromName": "sample string 3",
    "message": "sample string 4",
    "sendDate": "2022-12-05T11:59:32.6270665+00:00",
    "deliveryType": "CustomerEmail",
    "deliveryEmailAddress": "sample string 5"
  },
  {
    "amount": 1.0,
    "toName": "sample string 2",
    "fromName": "sample string 3",
    "message": "sample string 4",
    "sendDate": "2022-12-05T11:59:32.6270665+00:00",
    "deliveryType": "CustomerEmail",
    "deliveryEmailAddress": "sample string 5"
  }
]

text/xml

Sample:
<NewGiftVouchers>
  <NewGiftVoucher>
    <Amount>1</Amount>
    <ToName>sample string 2</ToName>
    <FromName>sample string 3</FromName>
    <Message>sample string 4</Message>
    <SendDate>2022-12-05T11:59:32.6270665+00:00</SendDate>
    <DeliveryType>CustomerEmail</DeliveryType>
    <DeliveryEmailAddress>sample string 5</DeliveryEmailAddress>
  </NewGiftVoucher>
  <NewGiftVoucher>
    <Amount>1</Amount>
    <ToName>sample string 2</ToName>
    <FromName>sample string 3</FromName>
    <Message>sample string 4</Message>
    <SendDate>2022-12-05T11:59:32.6270665+00:00</SendDate>
    <DeliveryType>CustomerEmail</DeliveryType>
    <DeliveryEmailAddress>sample string 5</DeliveryEmailAddress>
  </NewGiftVoucher>
</NewGiftVouchers>

Response Information

Resource Description

Collection of 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.