cart

cart.giftcard.add

Use this method to create a gift card for a specified amount.

post/cart.giftcard.add.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/cart.giftcard.add.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Query parameters

amountnumber required

Defines the gift card amount value.

currencystring

Defines currency code

store_idstring

Store Id

codestring

Gift card code

namestring

Entity name

owner_emailstring

Gift card owner email

owner_namestring

Gift card owner name

recipient_emailstring

Gift card recipient email

recipient_namestring

Gift card recipient name

messagestring

Free-form message attached to the entity.

idempotency_keystring

A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>

Response

successful operation

return_codeinteger
return_messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.