Download OpenAPI specification:Download
API for an external coupon promotion program that is called by the enfore platform.
Operations related to the promotion program coupons. Includes operations to verify coupons and mark coupons as used.
org-id required | string ID of the organization whose data is being accessed. |
coupon_code required | string The Coupon code to check. |
language | string <bcp47> Language tag that specifies the language in that localized results should be returned, if possible. See https://www.w3.org/TR/ltli/#dfn-language-tag |
customer_card_identifier | string Identifier retrieved by customer verification |
The result of the verification.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
{- "status": "UNKNOWN_IDENTIFIER",
- "coupon_description": "string",
- "identifier": "string",
- "discount": {
- "discount_target": {
- "type": "BASKET",
- "references": [
- "string"
]
}, - "value": {
- "amount": {
- "value": 0,
- "unit": "AUD"
}, - "amount_includes_tax": true,
- "@type": "AmountBasedDiscountValue"
}, - "description": "string",
- "external_reference": "string",
- "external_data": "string"
}, - "@type": "CouponVerificationSuccess"
}
org-id required | string ID of the organization whose data is being accessed. |
used_coupons | Array of strings List of used coupons |
language required | string <bcp47> [ 1 .. 256 ] characters Language tag that specifies the language in that localized results should be returned, if possible. See https://www.w3.org/TR/ltli/#dfn-language-tag |
customer_card_identifier | string <= 256 characters Identifier retrieved by customer verification |
The result of reporting the coupons.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
{- "used_coupons": [
- "string"
], - "language": "string",
- "customer_card_identifier": "string"
}
{- "@type": "CouponReportSuccess"
}
org-id required | string ID of the organization whose data is being accessed. |
basket required | object (Basket) |
language required | string <bcp47> [ 1 .. 256 ] characters Language tag that specifies the language in that localized results should be returned, if possible. See https://www.w3.org/TR/ltli/#dfn-language-tag |
selected_coupons | Array of strings Optional list of coupons that have been presented by the customer |
customer_identifier | string <= 256 characters Identifier retrieved by customer verification |
The result of the calculation.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
{- "basket": {
- "evaluation_date": "2025-04-23T13:33:31Z",
- "total_gross_amount": {
- "value": 0,
- "unit": "AUD"
}, - "items": [
- {
- "item_id": "string",
- "product_id": "string",
- "sales_category_id": "string",
- "lot_id": "string",
- "sales_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_sales_units": 0,
- "amount": {
- "value": 0,
- "unit": "AUD"
}, - "options": [
- {
- "identifier": "string",
- "product_id": "string",
- "sales_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_sales_units": 0,
- "is_single_issue": true,
- "amount": {
- "value": 0,
- "unit": "AUD"
}, - "sales_category_id": "string",
- "excluded_from_discounts": true,
- "taxes": [
- "CH_STANDARD_VAT_2008"
]
}
], - "extra_charges": [
- {
- "identifier": "string",
- "product_id": "string",
- "sales_unit": {
- "value": 0,
- "unit": "ENERGY_JOULES"
}, - "number_of_sales_units": 0,
- "is_single_issue": true,
- "amount": {
- "value": 0,
- "unit": "AUD"
}, - "sales_category_id": "string",
- "excluded_from_discounts": true,
- "taxes": [
- "CH_STANDARD_VAT_2008"
]
}
], - "excluded_from_discounts": true,
- "taxes": [
- "CH_STANDARD_VAT_2008"
]
}
], - "sales_channel_id": "string"
}, - "language": "string",
- "selected_coupons": [
- "string"
], - "customer_identifier": "string"
}
{- "discounts": [
- {
- "coupon_identifier": "string",
- "discount": {
- "discount_target": {
- "type": "BASKET",
- "references": [
- "string"
]
}, - "value": {
- "amount": {
- "value": 0,
- "unit": "AUD"
}, - "amount_includes_tax": true,
- "@type": "AmountBasedDiscountValue"
}, - "description": "string",
- "external_reference": "string",
- "external_data": "string"
}
}
], - "additional_discounts": [
- {
- "coupon_identifier": "string",
- "discount": {
- "discount_target": {
- "type": "BASKET",
- "references": [
- "string"
]
}, - "value": {
- "amount": {
- "value": 0,
- "unit": "AUD"
}, - "amount_includes_tax": true,
- "@type": "AmountBasedDiscountValue"
}, - "description": "string",
- "external_reference": "string",
- "external_data": "string"
}
}
], - "@type": "CouponDiscountCalculationSuccess"
}
org-id required | string ID of the organization whose data is being accessed. |
customer_identifier required | string The identifier to check. |
language | string <bcp47> Language tag that specifies the language in that localized results should be returned, if possible. See https://www.w3.org/TR/ltli/#dfn-language-tag |
The result of the verification.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
{- "status": "UNKNOWN",
- "contact": {
- "@type": "AnonymousContactInformation",
- "name": "string",
- "contact_address": {
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF"
}, - "contact_email": "user@example.com",
- "contact_phone": "string",
- "unique_instance_id": "string",
- "external_data": "string",
- "user_level_identifiers": [
- {
- "identifier": "string",
- "label": "string"
}
]
}, - "@type": "CustomerVerificationSuccess"
}