Get Gift Certificate 2

Retrieve gift certificate information for a specified merchant ID.

GET/organizations/{organizationId}/gift-certificates/{merchantId}

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Get Gift Certificate 2 action (under Gift Certificates (Data API)).
Fill in the fields below, then reference the result from later steps as {{getGiftCertificate2.response.data}}.

Request

Path parameters

organizationIdstringrequired

An identifier for the organization the request is being made by

merchantIdstringrequired

The merchant ID of the requested gift certificate.

Query parameters

siteIdstringrequired

The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.

Response

Returns 200 with an object. Read it in later steps with {{getGiftCertificate2.response.data.<field>}}.

amountany

The gift certificate amount. The user cannot change the gift certificate amount after the creation of the gift certificate.

balanceobject

The gift certificate balance. This is a computed attribute and cannot be modified.

creationDatestring (date-time)

Returns the value of attribute 'creationDate'.

descriptionstring

The description of the gift certificate.

enabledboolean

The enabled flag of the gift certificate.

lastModifiedstring (date-time)

Returns the value of attribute 'lastModified'.

maskedGiftCertificateCodestring

Masked code.

merchantIdstring

The merchant ID of the gift certificate. This is a unique attribute. This is a computed attribute and cannot be modified. This is used to get, update and the delete gift certificates.

messagestring

The message to the recipient of the gift certificate.

orderNostring

The order number of the gift certificate.

recipientEmailstring

The email address of the recipient of the gift certificate.

recipientNamestring

The recipient of the gift certificate.

senderNamestring

The sender of the gift certificate.

statusstring

The status of the gift certificate. While creating a gift certificate, user can set the status to either "pending" or "issued" only.

One ofissuedpartially_redeemedpendingredeemed

transactionsarray<object>

The transactions of the gift certificate.

amountobjectrequired2 fields

A combination of a Currency and an amount of that Currency.

orderNostringrequired

The order number of the gift certificate.

timestampstring (date-time)required

The timestamp of the transaction of the gift certificate.

typeCodestringrequired

The type code of the gift certificate.

One ofcreateredeemdeleteenabledisable

json

{
  "amount": null,
  "balance": {},
  "creationDate": 1578516896.641,
  "description": "A gift certificate for birthday.\n",
  "enabled": true,
  "lastModified": 1578516896.641,
  "maskedGiftCertificateCode": "*******XQTY",
  "merchantId": "Macy's1256489\n",
  "message": "This gift certificate is to be given as birthday present\n",
  "orderNo": "MyOrder5421\n",
  "recipientEmail": "my-recipient-email@gmail.com\n",
  "recipientName": "Jane Doe\n"
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.

Was this page helpful?