Redeem Coupon

POST/organizations/{organizationId}/coupons/actions/redeem

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Redeem Coupon action (under Coupons (Data API)).
Fill in the fields below, then reference the result from later steps as {{redeemCoupon.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.

codestringrequired

The coupon code to redeem.

customerEmailstring

The customer email to use on the redemption.

orderNostringrequired

The order number to use on the redemption. In case the coupon was redeemed externally and no order number is associated, use a reference id or custom string to identify the source of the redemption.

json

{
  "code": "Code1",
  "orderNo": "00023120@store4",
  "customerEmail": "shopper@salesforce-test.com"
}

Response

Returns 201 with a any. Read it in later steps with {{redeemCoupon.response.data.<field>}}.

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

Was this page helpful?