younifyd
Menu

Get Gift Certificate

Retrieve an existing gift certificate.

POST/organizations/{organizationId}/gift-certificate

Use it in a workflow

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

Request

Path parameters

organizationIdstringrequired

An identifier for the organization the request is being made by

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.

Request body

Enter the body as JSON in the step's Body field.

giftCertificateCodestringrequired

The gift certificate code.

json
{
  "giftCertificateCode": "MYGIFTCERTIFICATECODE"
}

Response

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

amountnumber (double)

The gift certificate original amount.

balancenumber (double)

The gift certificate remaining balance.

descriptionstring

The gift certificate description.

enabledboolean

Is the gift certificate is enabled?

maskedGiftCertificateCodestring

The masked gift certificate code.

merchantIdstring

The merchant ID.

messagestring

The message.

recipientEmailstring

The recipient email.

recipientNamestring

The recipient name.

senderNamestring

The sender name.

statusstring

The gift certificate status.

One ofpendingissuedpartially_redeemedredeemed

json
{
  "amount": 100,
  "balance": 100,
  "enabled": true,
  "maskedGiftCertificateCode": "************FJWQ",
  "merchantId": "00000001",
  "recipientEmail": "p@gmail.com",
  "recipientName": "sampleuser",
  "senderName": "Salesforce Support",
  "status": "issued",
  "description": "string",
  "message": "string"
}

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