Salesforce B2C Commerce 24.7 > Open Commerce API 23.2 > Shop API documents 23.2

GiftCertificate document (Shop API 23.2)

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

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.