enfore Promotions API (0.4.1)

Download OpenAPI specification:Download

enfore API for managing promotions and related objects

Sales vouchers represent a liability of the business against whoever owns the voucher.

The enfore platform supports three types of sales vouchers: gift cards, product vouchers, and category vouchers.

Sales Vouchers: Gift Cards

Gift cards have a direct monetary value and can be used to pay for any kind of product/service (with some limitations due to tax laws).

Iterate over gift cards.

Returns gift cards, sorted in ascending order by issued_date_and_time. For gift cards without such a value, the timestamp of their import into the system is used instead.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

query Parameters

from required	string <date-time> Defines the time starting from which objects are to be returned. Objects with exactly this date are also returned - this means that the start of a left-closed interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z
to required	string <date-time> Defines the time up to which objects are to be returned. Objects with exactly this date are not returned - this means that the end of a right-open interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z
limit	integer <int64> [ 1 .. 5000 ] Max number of objects to be returned per page. Note that both the `items` as well as the `problems` arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to `200`.
offset	integer <int64> >= 0 Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with `limit=10&offset=10`. Note that this paging with limit and offset is within a time interval that is specified with `from` and `to`. If not given, defaults to `0`.
number	string When specified, only gift cards with the specified number are returned.
external_number	string When specified, only gift cards with the specified external number are returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/sales-vouchers/gift-cards

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/gift-cards

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": "string",
"name": "string",
"number": "string",
"status": "ISSUED",
"current_balance": 
{"value": 0,
"unit": "AUD"
},
"initial_balance": 
{"value": 0,
"unit": "AUD"
},
"issued_date_and_time": "2025-03-25T16:02:20Z",
"expiration_date_and_time": "2025-03-25T16:02:20Z",
"last_used_date_and_time": "2025-03-25T16:02:20Z",
"tax": "CH_STANDARD_VAT_2008",
"source_product": "string",
"sold_via_invoice": "string"
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Create a new external gift card

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Request Body schema: application/json

name required	string The name of the gift card. This usually is the name of the "source product".
external_number required	string A unique number provided by a third-party. For use when importing externally issued gift cards into the system.
status required	string (GiftCardStatus) Enum: "ISSUED" "PARTIALLY_REDEEMED" "REDEEMED" "EXPIRED" "CANCELED" "DEACTIVATED" The possible status values for a gift card.
current_balance required	object (Money) A Money represents a monetary value (i.e., a currency and an amount), for example "120 EUR" or "2,500.75 USD".
initial_balance	object (Money) A Money represents a monetary value (i.e., a currency and an amount), for example "120 EUR" or "2,500.75 USD".
issued_date_and_time	string <date-time> Timestamp when the gift card was issued.
expiration_date_and_time	string <date-time> Timestamp when the gift card will/did expire.
tax	string (Tax) Enum: "CH_STANDARD_VAT_2008" "CH_REDUCED_VAT_2008" "CH_ACCOMMODATION_VAT_2008" "CH_STANDARD_VAT_2024" "CH_REDUCED_VAT_2024" "CH_ACCOMMODATION_VAT_2024" "CH_NO_VAT" "AT_STANDARD_VAT_2016" "AT_INTERMEDIATE_VAT_2016" "AT_REDUCED_VAT_2016" "AT_SPECIAL_VAT_2016" "AT_NO_VAT" "DE_STANDARD_VAT_2007" "DE_REDUCED_VAT_2007" "DE_STANDARD_VAT_2020" "DE_AGRICULTURE_VAT_2007" "DE_AGRICULTURE_VAT_2022" "DE_AGRICULTURE_VAT_2023" "DE_SYLVICULTURE_VAT_2007" "DE_REDUCED_VAT_2020" "DE_NO_VAT" A Tax represents a specific and unchangeable tax. Whenever a tax (rate) changes due to new legislation or other reasons, a new Tax must be defined and used from then on. For example, the standard VAT rates in Germany have been changed multiple times in the last 50 years: 01.01.1968 – 30.06.1968 = 10% 01.07.1968 – 31.12.1977 = 11% 01.01.1978 – 30.06.1979 = 12% 01.07.1979 – 30.06.1983 = 13% 01.07.1983 – 31.12.1992 = 14% 01.01.1993 – 31.03.1998 = 15% 01.04.1998 – 31.12.2006 = 16% 01.01.2007 – 30.06.2020 = 19% 01.07.2020 – 31.12.2020 = 16% 01.01.2021 – until further notice = 19% For now, we only use the tax DE_STANDARD_VAT_2007. But if, hypothetically, Germany would increase its standard VAT rate to 21% on 1/JAN/2020, we would define a new tax DE_STANDARD_VAT_2020 and use that from 1/JAN/2020 on.
source_product	string [ 1 .. 256 ] characters The ID of the gift card product that caused the creation of this gift card voucher.

Responses

201

Gift card has been created successfully

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

post/org/{org-id}/sales-vouchers/gift-cards

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/gift-cards

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"external_number": "string",
"status": "ISSUED",
"current_balance": 
{"value": 0,
"unit": "AUD"
},
"initial_balance": 
{"value": 0,
"unit": "AUD"
},
"issued_date_and_time": "2025-03-25T16:02:21Z",
"expiration_date_and_time": "2025-03-25T16:02:21Z",
"tax": "CH_STANDARD_VAT_2008",
"source_product": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"number": "string",
"external_number": "string",
"status": "ISSUED",
"current_balance": 
{"value": 0,
"unit": "AUD"
},
"initial_balance": 
{"value": 0,
"unit": "AUD"
},
"issued_date_and_time": "2025-03-25T16:02:21Z",
"expiration_date_and_time": "2025-03-25T16:02:21Z",
"last_used_date_and_time": "2025-03-25T16:02:21Z",
"tax": "CH_STANDARD_VAT_2008",
"source_product": "string",
"sold_via_invoice": "string"
}

Update the activation status of an external gift card

path Parameters

org-id required	string ID of the organization whose data is being accessed.
gift-card-id required	string ID of the gift card

Request Body schema: application/json

string (GiftCardActivationStatus)

Enum: "ACTIVE" "DEACTIVATED"

The possible activation statuses for a gift card. They result in changes to the GiftCardStatus depending on the current balance:

If ACTIVE, the sales voucher is activated (ISSUED, PARTIALLY_REDEEMED or REDEEMED)
If DEACTIVATED, it's deactivated (DEACTIVATED).
It is not possible to go to EXPIRED or CANCELED status.

Responses

201

Gift card activation status has been updated successfully

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

put/org/{org-id}/sales-vouchers/gift-cards/{gift-card-id}/activation-status

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/gift-cards/{gift-card-id}/activation-status

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

"ACTIVE"

Response samples

Content type

application/json

Copy

Expand all Collapse all

"ACTIVE"

Load a gift card.

path Parameters

org-id required	string ID of the organization whose data is being accessed.
gift-card-id required	string ID of the gift card

Responses

200

Data successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/sales-vouchers/gift-cards/{gift-card-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/gift-cards/{gift-card-id}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"number": "string",
"status": "ISSUED",
"current_balance": 
{"value": 0,
"unit": "AUD"
},
"initial_balance": 
{"value": 0,
"unit": "AUD"
},
"issued_date_and_time": "2025-03-25T16:02:21Z",
"expiration_date_and_time": "2025-03-25T16:02:21Z",
"last_used_date_and_time": "2025-03-25T16:02:21Z",
"tax": "CH_STANDARD_VAT_2008",
"source_product": "string",
"sold_via_invoice": "string",
"@type": "InternalGiftCard"
}

Get a list of registered consumers for gift card changes.

Retrieve all currently active event subscriptions.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Responses

200

List of registrations.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/sales-vouchers/gift-card-subscriptions

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/gift-card-subscriptions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": "string",
"callback_url": "https://myserver.com/send/events/here",
"public_key": "string"
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Register an event consumer with the API.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Request Body schema: application/json

callback_url

required

string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>

post/org/{org-id}/sales-vouchers/gift-card-subscriptions

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/gift-card-subscriptions

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"callback_url": "https://myserver.com/send/events/here"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"callback_url": "https://myserver.com/send/events/here",
"public_key": "string"
}

Callback payload samples

Callback

POST: <no summary>

Content type

application/json

Copy

Expand all Collapse all


{"org_id": "string",
"items": 
[
{"name": "string",
"status": "ISSUED",
"current_balance": 
{"value": 0,
"unit": "AUD"
},
"initial_balance": 
{"value": 0,
"unit": "AUD"
},
"issued_date_and_time": "2025-03-25T16:02:21Z",
"expiration_date_and_time": "2025-03-25T16:02:21Z",
"tax": "CH_STANDARD_VAT_2008",
"source_product": "string"
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Delete a subscription for gift card updates

path Parameters

org-id required	string ID of the organization whose data is being accessed.
subscription-id required	string ID of the subscription to delete

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/sales-vouchers/gift-card-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/gift-card-subscriptions/{subscription-id}

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}

Iterate over the redemptions of a gift card.

Returns redemptions of the gift card sorted ascending order by transaction_date_and_time.

path Parameters

org-id required	string ID of the organization whose data is being accessed.
gift-card-id required	string ID of the gift card

query Parameters

limit	integer <int64> [ 1 .. 5000 ] Max number of objects to be returned per page. Note that both the `items` as well as the `problems` arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to `200`.
offset	integer <int64> >= 0 Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with `limit=10&offset=10`. Note that this paging with limit and offset is within a time interval that is specified with `from` and `to`. If not given, defaults to `0`.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/sales-vouchers/gift-cards/{gift-card-id}/redemptions

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/gift-cards/{gift-card-id}/redemptions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": "string",
"transaction_date_and_time": "2025-03-25T16:02:21Z",
"redeemed_amount": 
{"value": 0,
"unit": "AUD"
},
"invoices": 
["string"
]
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Record a new external redemption for a gift card

path Parameters

org-id required	string ID of the organization whose data is being accessed.
gift-card-id required	string ID of the gift card

Request Body schema: application/json

redeemed_amount required	object (Money) A Money represents a monetary value (i.e., a currency and an amount), for example "120 EUR" or "2,500.75 USD".
external_reference required	string [ 1 .. 256 ] characters An external reference for the redemption. E.g., an invoice number.

Responses

201

Redemption has successfully been recorded

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

post/org/{org-id}/sales-vouchers/gift-cards/{gift-card-id}/redemptions

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/gift-cards/{gift-card-id}/redemptions

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"redeemed_amount": 
{"value": 0,
"unit": "AUD"
},
"external_reference": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"transaction_date_and_time": "2025-03-25T16:02:21Z",
"redeemed_amount": 
{"value": 0,
"unit": "AUD"
},
"external_reference": "string"
}

Load a gift card redemption.

path Parameters

org-id required	string ID of the organization whose data is being accessed.
gift-card-id required	string ID of the gift card
gift-card-redemption-id required	string ID of the gift card redemption

Responses

200

Data successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/sales-vouchers/gift-cards/{gift-card-id}/redemptions/{gift-card-redemption-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/gift-cards/{gift-card-id}/redemptions/{gift-card-redemption-id}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"id": "string",
"transaction_date_and_time": "2025-03-25T16:02:21Z",
"redeemed_amount": 
{"value": 0,
"unit": "AUD"
},
"invoices": 
["string"
],
"@type": "InternalGiftCardRedemption"
}

Sales Vouchers: Product Vouchers

Product vouchers can be redeemed for a specific product only.

Iterate over product vouchers.

Returns product vouchers, sorted in ascending order by issued_date_and_time. For product vouchers without such a value, the timestamp of their import into the system is used instead.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

query Parameters

from required	string <date-time> Defines the time starting from which objects are to be returned. Objects with exactly this date are also returned - this means that the start of a left-closed interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z
to required	string <date-time> Defines the time up to which objects are to be returned. Objects with exactly this date are not returned - this means that the end of a right-open interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z
limit	integer <int64> [ 1 .. 5000 ] Max number of objects to be returned per page. Note that both the `items` as well as the `problems` arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to `200`.
offset	integer <int64> >= 0 Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with `limit=10&offset=10`. Note that this paging with limit and offset is within a time interval that is specified with `from` and `to`. If not given, defaults to `0`.
number	string When specified, only product vouchers with the specified number are returned.
external_number	string When specified, only product vouchers with the specified external number are returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/sales-vouchers/product-vouchers

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/product-vouchers

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": "string",
"name": "string",
"number": "string",
"external_number": "string",
"status": "ISSUED",
"product": "string",
"product_sales_price_and_quantity": 
{"price": 
{"value": 0,
"unit": "AUD"
},
"price_is_gross": true,
"quantity": 
{"value": 0,
"unit": "ENERGY_JOULES"
}
},
"current_balance": 
{"value": 0,
"unit": "ENERGY_JOULES"
},
"initial_balance": 
{"value": 0,
"unit": "ENERGY_JOULES"
},
"issued_date_and_time": "2025-03-25T16:02:21Z",
"expiration_date_and_time": "2025-03-25T16:02:21Z",
"last_used_date_and_time": "2025-03-25T16:02:21Z",
"tax": "CH_STANDARD_VAT_2008",
"source_product": "string",
"sold_via_invoice": "string"
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Load a product voucher.

path Parameters

org-id required	string ID of the organization whose data is being accessed.
product-voucher-id required	string ID of the product voucher

Responses

200

Data successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/sales-vouchers/product-vouchers/{product-voucher-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/product-vouchers/{product-voucher-id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"number": "string",
"external_number": "string",
"status": "ISSUED",
"product": "string",
"product_sales_price_and_quantity": 
{"price": 
{"value": 0,
"unit": "AUD"
},
"price_is_gross": true,
"quantity": 
{"value": 0,
"unit": "ENERGY_JOULES"
}
},
"current_balance": 
{"value": 0,
"unit": "ENERGY_JOULES"
},
"initial_balance": 
{"value": 0,
"unit": "ENERGY_JOULES"
},
"issued_date_and_time": "2025-03-25T16:02:21Z",
"expiration_date_and_time": "2025-03-25T16:02:21Z",
"last_used_date_and_time": "2025-03-25T16:02:21Z",
"tax": "CH_STANDARD_VAT_2008",
"source_product": "string",
"sold_via_invoice": "string"
}

Get a list of registered consumers for product vouchers events.

Retrieve all currently active event subscriptions.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Responses

200

List of registrations.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/sales-vouchers/product-voucher-subscriptions

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/product-voucher-subscriptions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": "string",
"callback_url": "https://myserver.com/send/events/here",
"public_key": "string"
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Register an event consumer with the API.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Request Body schema: application/json

callback_url

required

string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>

post/org/{org-id}/sales-vouchers/product-voucher-subscriptions

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/product-voucher-subscriptions

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"callback_url": "https://myserver.com/send/events/here"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"callback_url": "https://myserver.com/send/events/here",
"public_key": "string"
}

Callback payload samples

Callback

POST: <no summary>

Content type

application/json

Copy

Expand all Collapse all


{"org_id": "string",
"items": 
[
{"name": "string",
"number": "string",
"external_number": "string",
"status": "ISSUED",
"product": "string",
"product_sales_price_and_quantity": 
{"price": 
{"value": 0,
"unit": "AUD"
},
"price_is_gross": true,
"quantity": 
{"value": 0,
"unit": "ENERGY_JOULES"
}
},
"current_balance": 
{"value": 0,
"unit": "ENERGY_JOULES"
},
"initial_balance": 
{"value": 0,
"unit": "ENERGY_JOULES"
},
"issued_date_and_time": "2025-03-25T16:02:22Z",
"expiration_date_and_time": "2025-03-25T16:02:22Z",
"last_used_date_and_time": "2025-03-25T16:02:22Z",
"tax": "CH_STANDARD_VAT_2008",
"source_product": "string"
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Delete a subscription for product voucher updates

path Parameters

org-id required	string ID of the organization whose data is being accessed.
subscription-id required	string ID of the subscription to delete

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/sales-vouchers/product-voucher-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/product-voucher-subscriptions/{subscription-id}

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}

Sales Vouchers: Category Vouchers

Category vouchers can be redeemed for products of a specfic sales category only.

Iterate over category vouchers.

Returns category vouchers, sorted in ascending order by issued_date_and_time. For category vouchers without such a value, the timestamp of their import into the system is used instead.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

query Parameters

from required	string <date-time> Defines the time starting from which objects are to be returned. Objects with exactly this date are also returned - this means that the start of a left-closed interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z
to required	string <date-time> Defines the time up to which objects are to be returned. Objects with exactly this date are not returned - this means that the end of a right-open interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z
limit	integer <int64> [ 1 .. 5000 ] Max number of objects to be returned per page. Note that both the `items` as well as the `problems` arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to `200`.
offset	integer <int64> >= 0 Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with `limit=10&offset=10`. Note that this paging with limit and offset is within a time interval that is specified with `from` and `to`. If not given, defaults to `0`.
number	string When specified, only category vouchers with the specified number are returned.
external_number	string When specified, only category vouchers with the specified external number are returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/sales-vouchers/category-vouchers

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/category-vouchers

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": "string",
"name": "string",
"number": "string",
"external_number": "string",
"status": "ISSUED",
"sales_categories": 
["string"
],
"current_balance": 
{"value": 0,
"unit": "AUD"
},
"initial_balance": 
{"value": 0,
"unit": "AUD"
},
"issued_date_and_time": "2025-03-25T16:02:22Z",
"expiration_date_and_time": "2025-03-25T16:02:22Z",
"last_used_date_and_time": "2025-03-25T16:02:22Z",
"tax": "CH_STANDARD_VAT_2008",
"source_product": "string",
"sold_via_invoice": "string"
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Load a category voucher.

path Parameters

org-id required	string ID of the organization whose data is being accessed.
category-voucher-id required	string ID of the category voucher

Responses

200

Data successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/sales-vouchers/category-vouchers/{category-voucher-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/category-vouchers/{category-voucher-id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"number": "string",
"external_number": "string",
"status": "ISSUED",
"sales_categories": 
["string"
],
"current_balance": 
{"value": 0,
"unit": "AUD"
},
"initial_balance": 
{"value": 0,
"unit": "AUD"
},
"issued_date_and_time": "2025-03-25T16:02:22Z",
"expiration_date_and_time": "2025-03-25T16:02:22Z",
"last_used_date_and_time": "2025-03-25T16:02:22Z",
"tax": "CH_STANDARD_VAT_2008",
"source_product": "string",
"sold_via_invoice": "string"
}

Get a list of registered consumers for category voucher events.

Retrieve all currently active event subscriptions.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Responses

200

List of registrations.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/sales-vouchers/category-voucher-subscriptions

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/category-voucher-subscriptions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": "string",
"callback_url": "https://myserver.com/send/events/here",
"public_key": "string"
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Register an event consumer with the API.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Request Body schema: application/json

callback_url

required

string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>

post/org/{org-id}/sales-vouchers/category-voucher-subscriptions

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/category-voucher-subscriptions

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"callback_url": "https://myserver.com/send/events/here"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"callback_url": "https://myserver.com/send/events/here",
"public_key": "string"
}

Callback payload samples

Callback

POST: <no summary>

Content type

application/json

Copy

Expand all Collapse all


{"org_id": "string",
"items": 
[
{"name": "string",
"number": "string",
"external_number": "string",
"status": "ISSUED",
"sales_categories": 
["string"
],
"current_balance": 
{"value": 0,
"unit": "AUD"
},
"initial_balance": 
{"value": 0,
"unit": "AUD"
},
"issued_date_and_time": "2025-03-25T16:02:22Z",
"expiration_date_and_time": "2025-03-25T16:02:22Z",
"last_used_date_and_time": "2025-03-25T16:02:22Z",
"tax": "CH_STANDARD_VAT_2008",
"source_product": "string"
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Delete a subscription for category voucher updates

path Parameters

org-id required	string ID of the organization whose data is being accessed.
subscription-id required	string ID of the subscription to delete

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/sales-vouchers/category-voucher-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/category-voucher-subscriptions/{subscription-id}

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}

Loyalty Programs: External

External loyalty programs are loyalty programs where the calculation and management of the earned points is handled by an external system.

Iterate over external loyalty program drafts.

Returns external loyalty program drafts, sorted in descending order by their creation timestamp.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

query Parameters

limit	integer <int64> [ 1 .. 5000 ] Max number of objects to be returned per page. Note that both the `items` as well as the `problems` arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to `200`.
offset	integer <int64> >= 0 Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with `limit=10&offset=10`. Note that this paging with limit and offset is within a time interval that is specified with `from` and `to`. If not given, defaults to `0`.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/loyalty-programs/external-loyalty-program-drafts

Production

https://external.apis.enfore.com/promotions/org/{org-id}/loyalty-programs/external-loyalty-program-drafts

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"coupon_identity": 
{"display_name": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
]
},
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"revoke_points_on_refund": true,
"do_not_grant_points_before_payment": false,
"subscription_checks": 
["WHEN_STARTING_BASKET"
],
"calculate_points_without_subscription": false
},
"subscription_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Create a new external loyalty program draft

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Request Body schema: application/json

name required	string The name of the loyalty program
description	string A description of the loyalty program
short_description	string A short description of the loyalty program
identity_images	Array of objects (PromotionIdentityImage)
start_date_and_time	string <date-time>
end_date_and_time	string <date-time>
coupon_identity	object (CouponIdentity)
configuration required	object (ExternalLoyaltyProgramConfiguration)

Responses

201

Object has been created successfully

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

post/org/{org-id}/loyalty-programs/external-loyalty-program-drafts

Production

https://external.apis.enfore.com/promotions/org/{org-id}/loyalty-programs/external-loyalty-program-drafts

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"coupon_identity": 
{"display_name": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
]
},
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"revoke_points_on_refund": true,
"do_not_grant_points_before_payment": false,
"subscription_checks": 
["WHEN_STARTING_BASKET"
],
"calculate_points_without_subscription": false
},
"subscription_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"coupon_identity": 
{"display_name": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
]
},
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"revoke_points_on_refund": true,
"do_not_grant_points_before_payment": false,
"subscription_checks": 
["WHEN_STARTING_BASKET"
],
"calculate_points_without_subscription": false
},
"subscription_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Load an external loyalty program draft.

path Parameters

org-id required	string ID of the organization whose data is being accessed.
loyalty-program-draft-id required	string ID of the loyalty program draft

Responses

200

Data successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/loyalty-programs/external-loyalty-program-drafts/{loyalty-program-draft-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/loyalty-programs/external-loyalty-program-drafts/{loyalty-program-draft-id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"coupon_identity": 
{"display_name": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
]
},
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"revoke_points_on_refund": true,
"do_not_grant_points_before_payment": false,
"subscription_checks": 
["WHEN_STARTING_BASKET"
],
"calculate_points_without_subscription": false
},
"subscription_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Update an external loyalty program draft

path Parameters

org-id required	string ID of the organization whose data is being accessed.
loyalty-program-draft-id required	string ID of the loyalty program draft

Request Body schema: application/json

name required	string The name of the loyalty program
description	string A description of the loyalty program
short_description	string A short description of the loyalty program
identity_images	Array of objects (PromotionIdentityImage)
start_date_and_time	string <date-time>
end_date_and_time	string <date-time>
coupon_identity	object (CouponIdentity)
configuration required	object (ExternalLoyaltyProgramConfiguration)

Responses

200

Object is successfully updated.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

501

Not Implemented.

put/org/{org-id}/loyalty-programs/external-loyalty-program-drafts/{loyalty-program-draft-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/loyalty-programs/external-loyalty-program-drafts/{loyalty-program-draft-id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"coupon_identity": 
{"display_name": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
]
},
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"revoke_points_on_refund": true,
"do_not_grant_points_before_payment": false,
"subscription_checks": 
["WHEN_STARTING_BASKET"
],
"calculate_points_without_subscription": false
},
"subscription_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"coupon_identity": 
{"display_name": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
]
},
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"revoke_points_on_refund": true,
"do_not_grant_points_before_payment": false,
"subscription_checks": 
["WHEN_STARTING_BASKET"
],
"calculate_points_without_subscription": false
},
"subscription_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Delete an external loyalty program draft

path Parameters

org-id required	string ID of the organization whose data is being accessed.
loyalty-program-draft-id required	string ID of the loyalty program draft

Responses

204

Object was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/loyalty-programs/external-loyalty-program-drafts/{loyalty-program-draft-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/loyalty-programs/external-loyalty-program-drafts/{loyalty-program-draft-id}

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}

Iterate over external loyalty programs.

Returns external loyalty programs, sorted in descending order by start_date_and_time. For promotions without such a value, the timestamp of their import into the system is used instead.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

query Parameters

limit	integer <int64> [ 1 .. 5000 ] Max number of objects to be returned per page. Note that both the `items` as well as the `problems` arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to `200`.
offset	integer <int64> >= 0 Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with `limit=10&offset=10`. Note that this paging with limit and offset is within a time interval that is specified with `from` and `to`. If not given, defaults to `0`.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/loyalty-programs/external-loyalty-program

Production

https://external.apis.enfore.com/promotions/org/{org-id}/loyalty-programs/external-loyalty-program

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"status": "SCHEDULED",
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"coupon_identity": 
{"display_name": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
]
},
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"revoke_points_on_refund": true,
"do_not_grant_points_before_payment": false,
"subscription_checks": 
["WHEN_STARTING_BASKET"
],
"calculate_points_without_subscription": false
},
"subscription_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Create a new external loyalty program (from an external loyalty program draft)

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Request Body schema: application/json

draft_id required	string <= 256 characters
operation required	string (LoyaltyProgramOperation) Enum: "SCHEDULE" "ACTIVATE" Possible operations for creating a loyalty program `SCHEDULE` - The loyalty program will be scheduled (requires a start date/time on the draft) `ACTIVATE` - The loyalty program will be activated immediately

Responses

200

Loyalty program has been created successfully

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

post/org/{org-id}/loyalty-programs/external-loyalty-program

Production

https://external.apis.enfore.com/promotions/org/{org-id}/loyalty-programs/external-loyalty-program

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"draft_id": "string",
"operation": "SCHEDULE"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"status": "SCHEDULED",
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"coupon_identity": 
{"display_name": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
]
},
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"revoke_points_on_refund": true,
"do_not_grant_points_before_payment": false,
"subscription_checks": 
["WHEN_STARTING_BASKET"
],
"calculate_points_without_subscription": false
},
"subscription_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Load an external loyalty program.

path Parameters

org-id required	string ID of the organization whose data is being accessed.
loyalty-program-id required	string ID of the loyalty program

Responses

200

Data successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/loyalty-programs/external-loyalty-program/{loyalty-program-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/loyalty-programs/external-loyalty-program/{loyalty-program-id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"status": "SCHEDULED",
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"coupon_identity": 
{"display_name": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
]
},
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"revoke_points_on_refund": true,
"do_not_grant_points_before_payment": false,
"subscription_checks": 
["WHEN_STARTING_BASKET"
],
"calculate_points_without_subscription": false
},
"subscription_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Update an external loyalty program.

path Parameters

org-id required	string ID of the organization whose data is being accessed.
loyalty-program-id required	string ID of the loyalty program

Request Body schema: application/json

updates

Array of objects (ExternalLoyaltyProgramUpdate)

Responses

200

Promotion successfully updated.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

patch/org/{org-id}/loyalty-programs/external-loyalty-program/{loyalty-program-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/loyalty-programs/external-loyalty-program/{loyalty-program-id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"updates": 
[
{"@type": "LoyaltyProgramEndDateAndTimeUpdate",
"end_date_and_time": "2025-03-25T16:02:22Z"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"status": "SCHEDULED",
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"coupon_identity": 
{"display_name": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
]
},
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"revoke_points_on_refund": true,
"do_not_grant_points_before_payment": false,
"subscription_checks": 
["WHEN_STARTING_BASKET"
],
"calculate_points_without_subscription": false
},
"subscription_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Update the status of an external loyalty program

path Parameters

org-id required	string ID of the organization whose data is being accessed.
loyalty-program-id required	string ID of the loyalty program

Request Body schema: text/plain

string (ExternalLoyaltyProgramStatus)

Enum: "SCHEDULED" "ACTIVE" "ARCHIVED"

Possible status values for loyalty programs

SCHEDULED - The loyalty program has not been started yet
ACTIVE - The loyalty program has been started but not ended yet
ARCHIVED - The loyalty program has ended

Responses

200

Status successfully updated.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/loyalty-programs/external-loyalty-program/{loyalty-program-id}/status

Production

https://external.apis.enfore.com/promotions/org/{org-id}/loyalty-programs/external-loyalty-program/{loyalty-program-id}/status

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}

Promotions: External Coupon Promotions

External coupon promotions are coupon-based promotions where the calculation and management of the coupons and coupon-triggered discounts are handled by an external system.

Iterate over external coupon promotion drafts.

Returns external coupon promotion drafts, sorted in descending order by their creation timestamp.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

query Parameters

limit	integer <int64> [ 1 .. 5000 ] Max number of objects to be returned per page. Note that both the `items` as well as the `problems` arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to `200`.
offset	integer <int64> >= 0 Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with `limit=10&offset=10`. Note that this paging with limit and offset is within a time interval that is specified with `from` and `to`. If not given, defaults to `0`.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/promotions/external-coupon-promotion-drafts

Production

https://external.apis.enfore.com/promotions/org/{org-id}/promotions/external-coupon-promotion-drafts

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"use_external_pricing_engine": false,
"internal_accounting": false
},
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"customer_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Create a new external coupon promotion draft

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Request Body schema: application/json

name required	string The name of the coupon promotion
description	string A description of the coupon promotion
short_description	string A short description of the coupon promotion
identity_images	Array of objects (PromotionIdentityImage)
start_date_and_time	string <date-time>
end_date_and_time	string <date-time>
configuration required	object (ExternalCouponPromotionConfiguration)

Responses

201

Object has been created successfully

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

post/org/{org-id}/promotions/external-coupon-promotion-drafts

Production

https://external.apis.enfore.com/promotions/org/{org-id}/promotions/external-coupon-promotion-drafts

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"use_external_pricing_engine": false,
"internal_accounting": false
},
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"customer_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"use_external_pricing_engine": false,
"internal_accounting": false
},
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"customer_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Load an external coupon promotion draft.

path Parameters

org-id required	string ID of the organization whose data is being accessed.
coupon-promotion-draft-id required	string ID of the coupon promotion draft

Responses

200

Data successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/promotions/external-coupon-promotion-drafts/{coupon-promotion-draft-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/promotions/external-coupon-promotion-drafts/{coupon-promotion-draft-id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"use_external_pricing_engine": false,
"internal_accounting": false
},
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"customer_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Update an external coupon promotion draft

path Parameters

org-id required	string ID of the organization whose data is being accessed.
coupon-promotion-draft-id required	string ID of the coupon promotion draft

Request Body schema: application/json

name required	string The name of the coupon promotion
description	string A description of the coupon promotion
short_description	string A short description of the coupon promotion
identity_images	Array of objects (PromotionIdentityImage)
start_date_and_time	string <date-time>
end_date_and_time	string <date-time>
configuration required	object (ExternalCouponPromotionConfiguration)

Responses

200

Object is successfully updated.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

501

Not Implemented.

put/org/{org-id}/promotions/external-coupon-promotion-drafts/{coupon-promotion-draft-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/promotions/external-coupon-promotion-drafts/{coupon-promotion-draft-id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"use_external_pricing_engine": false,
"internal_accounting": false
},
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"customer_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"use_external_pricing_engine": false,
"internal_accounting": false
},
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"customer_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Delete an external coupon promotion draft

path Parameters

org-id required	string ID of the organization whose data is being accessed.
coupon-promotion-draft-id required	string ID of the coupon promotion draft

Responses

204

Object was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/promotions/external-coupon-promotion-drafts/{coupon-promotion-draft-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/promotions/external-coupon-promotion-drafts/{coupon-promotion-draft-id}

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}

Iterate over external coupon promotions.

Returns external coupon promotions, sorted in descending order by start_date_and_time. For promotions without such a value, the timestamp of their import into the system is used instead.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

query Parameters

limit	integer <int64> [ 1 .. 5000 ] Max number of objects to be returned per page. Note that both the `items` as well as the `problems` arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to `200`.
offset	integer <int64> >= 0 Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with `limit=10&offset=10`. Note that this paging with limit and offset is within a time interval that is specified with `from` and `to`. If not given, defaults to `0`.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/promotions/external-coupon-promotion

Production

https://external.apis.enfore.com/promotions/org/{org-id}/promotions/external-coupon-promotion

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"status": "SCHEDULED",
"start_date_and_time": "2025-03-25T16:02:22Z",
"end_date_and_time": "2025-03-25T16:02:22Z",
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"use_external_pricing_engine": false,
"internal_accounting": false
},
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"customer_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Create a new external coupon promotion (from an external coupon promotion draft)

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Request Body schema: application/json

draft_id required	string <= 256 characters
operation required	string (PromotionCreateOperation) Enum: "SCHEDULE" "ACTIVATE" Possible operations for creating a promotions `SCHEDULE` - The promotion will be scheduled (requires a start date/time on the draft) `ACTIVATE` - The promotion will be activated immediately

Responses

200

Promotion has been created successfully

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

post/org/{org-id}/promotions/external-coupon-promotion

Production

https://external.apis.enfore.com/promotions/org/{org-id}/promotions/external-coupon-promotion

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"draft_id": "string",
"operation": "SCHEDULE"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"status": "SCHEDULED",
"start_date_and_time": "2025-03-25T16:02:23Z",
"end_date_and_time": "2025-03-25T16:02:23Z",
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"use_external_pricing_engine": false,
"internal_accounting": false
},
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"customer_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Load an external coupon promotion.

path Parameters

org-id required	string ID of the organization whose data is being accessed.
coupon-promotion-id required	string ID of the coupon promotion

Responses

200

Data successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/promotions/external-coupon-promotion/{coupon-promotion-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/promotions/external-coupon-promotion/{coupon-promotion-id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"status": "SCHEDULED",
"start_date_and_time": "2025-03-25T16:02:23Z",
"end_date_and_time": "2025-03-25T16:02:23Z",
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"use_external_pricing_engine": false,
"internal_accounting": false
},
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"customer_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Update an external coupon promotion.

path Parameters

org-id required	string ID of the organization whose data is being accessed.
coupon-promotion-id required	string ID of the coupon promotion

Request Body schema: application/json

updates

Array of objects (ExternalCouponPromotionUpdate)

Responses

200

Promotion successfully updated.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

422

Specified data is semantically incorrect.

patch/org/{org-id}/promotions/external-coupon-promotion/{coupon-promotion-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/promotions/external-coupon-promotion/{coupon-promotion-id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"updates": 
[
{"@type": "PromotionEndDateAndTimeUpdate",
"end_date_and_time": "2025-03-25T16:02:23Z"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"name": "string",
"description": "string",
"short_description": "string",
"identity_images": 
[
{"image_id": "string",
"limitations": 
{"language_tags": 
["strin"
]
}
}
],
"status": "SCHEDULED",
"start_date_and_time": "2025-03-25T16:02:23Z",
"end_date_and_time": "2025-03-25T16:02:23Z",
"configuration": 
{"access_configuration": 
{"url": "string",
"credentials_key": "string",
"timeout_in_millis": 2000,
"max_retries": 3,
"retry_interval_in_millis": 250
},
"processing_configuration": 
{"use_external_pricing_engine": false,
"internal_accounting": false
},
"coupon_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"customer_identifier_configuration": 
[
{"@type": "PrefixConstraint",
"prefix": "string",
"fixed_length": 0,
"modifiers": 
[
{"@type": "TruncationModifier",
"number_of_characters": 0,
"at_beginning": true
}
]
}
],
"linked_external_payment_method": 
{"id": "stringstringstringstring",
"type": "BASIC"
}
}
}

Update the status of an external coupon promotion

path Parameters

org-id required	string ID of the organization whose data is being accessed.
coupon-promotion-id required	string ID of the coupon promotion

Request Body schema: text/plain

string (ExternalCouponPromotionStatus)

Enum: "SCHEDULED" "ACTIVE" "ARCHIVED"

Possible status values for coupon promotions

SCHEDULED - The coupon promotion has not been started yet
ACTIVE - The coupon promotion has been started but not ended yet
ARCHIVED - The coupon promotion has ended

Responses

200

Status successfully updated.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/promotions/external-coupon-promotion/{coupon-promotion-id}/status

Production

https://external.apis.enfore.com/promotions/org/{org-id}/promotions/external-coupon-promotion/{coupon-promotion-id}/status

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}

Deprecated Sales Vouchers: Gift Cards

Get a list of registered consumers for gift card changes. Deprecated

Retrieve all currently active event subscriptions.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Responses

200

List of registrations.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/sales-vouchers/gift-cards-subscriptions

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/gift-cards-subscriptions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": "string",
"callback_url": "https://myserver.com/send/events/here",
"public_key": "string"
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Register an event consumer with the API. Deprecated

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Request Body schema: application/json

callback_url

required

string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>

post/org/{org-id}/sales-vouchers/gift-cards/subscriptions

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/gift-cards/subscriptions

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"callback_url": "https://myserver.com/send/events/here"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"callback_url": "https://myserver.com/send/events/here",
"public_key": "string"
}

Callback payload samples

Callback

POST: <no summary>

Content type

application/json

Copy

Expand all Collapse all


{"org_id": "string",
"items": 
[
{"name": "string",
"status": "ISSUED",
"current_balance": 
{"value": 0,
"unit": "AUD"
},
"initial_balance": 
{"value": 0,
"unit": "AUD"
},
"issued_date_and_time": "2025-03-25T16:02:23Z",
"expiration_date_and_time": "2025-03-25T16:02:23Z",
"tax": "CH_STANDARD_VAT_2008",
"source_product": "string"
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Delete a subscription for gift card updates Deprecated

path Parameters

org-id required	string ID of the organization whose data is being accessed.
subscription-id required	string ID of the subscription to delete

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/sales-vouchers/gift-cards/subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/gift-cards/subscriptions/{subscription-id}

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}

Deprecated Sales Vouchers: Product Vouchers

Get a list of registered consumers for product vouchers events. Deprecated

Retrieve all currently active event subscriptions.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Responses

200

List of registrations.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/sales-vouchers/product-vouchers-subscriptions

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/product-vouchers-subscriptions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": "string",
"callback_url": "https://myserver.com/send/events/here",
"public_key": "string"
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Register an event consumer with the API. Deprecated

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Request Body schema: application/json

callback_url

required

string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>

post/org/{org-id}/sales-vouchers/product-vouchers/subscriptions

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/product-vouchers/subscriptions

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"callback_url": "https://myserver.com/send/events/here"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"callback_url": "https://myserver.com/send/events/here",
"public_key": "string"
}

Callback payload samples

Callback

POST: <no summary>

Content type

application/json

Copy

Expand all Collapse all


{"org_id": "string",
"items": 
[
{"name": "string",
"number": "string",
"external_number": "string",
"status": "ISSUED",
"product": "string",
"product_sales_price_and_quantity": 
{"price": 
{"value": 0,
"unit": "AUD"
},
"price_is_gross": true,
"quantity": 
{"value": 0,
"unit": "ENERGY_JOULES"
}
},
"current_balance": 
{"value": 0,
"unit": "ENERGY_JOULES"
},
"initial_balance": 
{"value": 0,
"unit": "ENERGY_JOULES"
},
"issued_date_and_time": "2025-03-25T16:02:23Z",
"expiration_date_and_time": "2025-03-25T16:02:23Z",
"last_used_date_and_time": "2025-03-25T16:02:23Z",
"tax": "CH_STANDARD_VAT_2008",
"source_product": "string"
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Delete a subscription for product voucher updates Deprecated

path Parameters

org-id required	string ID of the organization whose data is being accessed.
subscription-id required	string ID of the subscription to delete

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/sales-vouchers/product-vouchers/subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/product-vouchers/subscriptions/{subscription-id}

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}

Deprecated Sales Vouchers: Category Vouchers

Get a list of registered consumers for category voucher events. Deprecated

Retrieve all currently active event subscriptions.

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Responses

200

List of registrations.

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/sales-vouchers/category-vouchers-subscriptions

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/category-vouchers-subscriptions

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"items": 
[
{"id": "string",
"callback_url": "https://myserver.com/send/events/here",
"public_key": "string"
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Register an event consumer with the API. Deprecated

path Parameters

org-id

required

string

ID of the organization whose data is being accessed.

Request Body schema: application/json

callback_url

required

string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>

post/org/{org-id}/sales-vouchers/category-vouchers/subscriptions

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/category-vouchers/subscriptions

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"callback_url": "https://myserver.com/send/events/here"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": "string",
"callback_url": "https://myserver.com/send/events/here",
"public_key": "string"
}

Callback payload samples

Callback

POST: <no summary>

Content type

application/json

Copy

Expand all Collapse all


{"org_id": "string",
"items": 
[
{"name": "string",
"number": "string",
"external_number": "string",
"status": "ISSUED",
"sales_categories": 
["string"
],
"current_balance": 
{"value": 0,
"unit": "AUD"
},
"initial_balance": 
{"value": 0,
"unit": "AUD"
},
"issued_date_and_time": "2025-03-25T16:02:23Z",
"expiration_date_and_time": "2025-03-25T16:02:23Z",
"last_used_date_and_time": "2025-03-25T16:02:23Z",
"tax": "CH_STANDARD_VAT_2008",
"source_product": "string"
}
],
"problems": 
[
{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}
]
}

Delete a subscription for category voucher updates Deprecated

path Parameters

org-id required	string ID of the organization whose data is being accessed.
subscription-id required	string ID of the subscription to delete

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/sales-vouchers/category-vouchers/subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/promotions/org/{org-id}/sales-vouchers/category-vouchers/subscriptions/{subscription-id}

Response samples

Content type

application/problem+json

Copy

Expand all Collapse all


{"type": "http://example.com",
"title": "string",
"detail": "string",
"on_resource": "http://example.com"
}