v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Apply a media campaign offer code on an invoice

This API helps you to apply a media campaign offer code on an invoice. By doing so, you can provide your guests the option to avail promotional discounts on their invoice when they purchase any services or products from your Customer Mobile Application (CMA) or custom Webstore. For more information on how to configure a media campaign, refer to this Help article.

You must specify appropriate data for the invoice_id parameter.

post/v1/invoices/{invoice_id}/campaign_discount/apply

Path parameters

invoice_idstring required

Mandatory Unique 32-character identifier of the guest's invoice.

Request body

offer_codestring required

media campaign offer code to be redeemed

center_idstring required

Center where the redemptions has to happen.

voucher_codestring

Voucher code associated with the campaign. Used when the campaign requires voucher validation.

Response

200

discount_appliedstring

campaign_idstring

{"stackTrail":"paths:/v1/invoices/{invoice_id}/campaign_discount/apply:post:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "discount_applied": "true",
  "campaign_id": "518D91A3-676C-4E3B-9537-036BA071F023"
}