GiftCertificate document (Shop API 20.4)

(supports custom properties)

Document representing a gift certificate.

Property Type Constraints Description
amount Decimal   The gift certificate original amount.
balance Decimal   The gift certificate balance.
description String   The gift certificate description.
enabled Boolean   Is the gift certificate is enabled?
masked_gift_certificate_code String   The masked gift certificate code.
merchant_id String   The merchant ID.
message String   The message.
recipient_email String   The recipient email.
recipient_name String   The recipient name.
sender_name String   The sender name.
status Enum {pending, issued, partially_redeemed, redeemed}   The gift certificate status.
OCAPI obsolete versions 13.x and 14.x will be end of life in 2020 and versions 15.x and 16.x in 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.