Loymax

https://docs.loymax.net/
Admin
Loymax is an IT platform for implementing loyalty programs of any complexity, enabling businesses to...
Tokens:593,529
Snippets:9,675
Trust Score:5.2
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example SPF Record Configuration

Source: https://docs.loymax.net/xwiki/bin/view/Main/Using/Smart_Communications/Mass_mailings/High-quality_mailings_recommendations/DNS_configuring

This SPF record example uses 'include' for external SPF policies and specifies IP addresses. The '-all' tag indicates that any sending server not listed should be considered unauthorized.

```dns
spf2.0/pra include:spf.example.com ip4:A.B.C.D -all
```

```dns
spf2.0/pra include:spf.example.com ip4:A.B.C.D -all
```

```dns
v=spf1 include:spf.example.com ip4:A.B.C.D -all
```

--------------------------------

### Example of $Emission.Number() Usage

Source: https://docs.loymax.net/xwiki/bin/view/Main/Using/Gift_certificates/Gift_certificates_MMP/Certificate_patterns?viewer=code

Demonstrates how $Emission.Number() can be used in conjunction with other metavariables to form a certificate number. This example shows a generated number based on a specific template.

```text
$Emission.Id(5)$Emission.Counter()
```

--------------------------------

### GET /v1.X/emissions/coupons/{id}/progress

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?viewer=content

Gets information about the background process of coupon creation for a specified queue.

```APIDOC
## GET /v1.X/emissions/coupons/{id}/progress

### Description
Gets information about the background process of coupon creation for a specified queue.

### Method
GET

### Endpoint
/v1.X/emissions/coupons/{id}/progress

### Path Parameters
- **id** (integer) - Required - The ID of the coupon emission queue.
```

--------------------------------

### Get Coupon Creation Progress

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=20.1

Gets information about the background process for creating coupons for a specified queue.

```APIDOC
## GET /v1.X/emissions/coupons/{id}/progress

### Description
Gets information about the background process for creating coupons for a specified queue.

### Method
GET

### Endpoint
/v1.X/emissions/coupons/{id}/progress

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the coupon emission queue.

```

--------------------------------

### Get Coupon Creation Progress

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=21.1

Gets information on the background process of coupon creation for a specified queue.

```APIDOC
## GET /v1.X/emissions/coupons/{id}/progress

### Description
Gets information on the background process of coupon creation for a specified queue.

### Method
GET

### Endpoint
/v1.X/emissions/coupons/{id}/progress

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the coupon queue.
```

--------------------------------

### GET /v1.X/configurations/ui

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?language=ru

Retrieves a list of UI configurations for the workstation.

```APIDOC
## GET /v1.X/configurations/ui

### Description
Retrieves a list of UI configurations for the workstation.

### Method
GET

### Endpoint
/v1.X/configurations/ui
```

--------------------------------

### Example Certificate Number for 10000 Capacity

Source: https://docs.loymax.net/xwiki/bin/view/Main/Using/Gift_certificates/Gift_certificates_MMP/Certificate_patterns?viewer=code

An example of a generated certificate number using the template for 10000 certificates. It breaks down each component of the number.

```text
2599138902000034
```

--------------------------------

### Get Coupon Emission Progress

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=17.1

Gets information about the background process of coupon creation for a specified queue.

```APIDOC
## GET /v1.X/emissions/coupons/{id}/progress

### Description
Get information on the background process of coupon creation for the specified queue.

### Method
GET

### Endpoint
/v1.X/emissions/coupons/{id}/progress

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the coupon emission queue.
```

--------------------------------

### Get Users

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=18.1

Retrieves a list of clients.

```APIDOC
## POST /v1.X/users

### Description
Retrieves a list of clients.

### Method
POST

### Endpoint
/v1.X/users

### Parameters
#### Request Body
- **properties** (array) - Optional - Specifies properties to retrieve for each user.
```

--------------------------------

### Get UI Configurations

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=21.1

Retrieves a list of workstation configurations.

```APIDOC
## GET /v1.X/configurations/ui

### Description
Retrieves a list of workstation configurations.

### Method
GET

### Endpoint
/v1.X/configurations/ui
```

--------------------------------

### Get Users

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=22.1

Retrieves a list of clients.

```APIDOC
## POST /v1.X/users

### Description
Retrieves a list of clients.

### Method
POST

### Endpoint
/v1.X/users

### Parameters
#### Request Body
- **properties** (array) - Optional - An array of properties to filter or retrieve user information.
```

--------------------------------

### Get UI Configurations

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?showLastAuthors=true&viewer=code

Retrieves a list of ATM configurations.

```APIDOC
## GET /v1.X/configurations/ui

### Description
Retrieves a list of ATM configurations.

### Method
GET

### Endpoint
/v1.X/configurations/ui
```

--------------------------------

### Get UI Configurations

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?xpage=print&xpage=copy

Retrieves a list of workstation (ARM) configurations.

```APIDOC
## GET /v1.X/configurations/ui

### Description
Retrieves a list of workstation (ARM) configurations.

### Method
GET

### Endpoint
/v1.X/configurations/ui
```

--------------------------------

### Get Clients

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=17.1

Retrieves a list of clients.

```APIDOC
## POST /v1.X/users

### Description
Returns a list of clients.

### Method
POST

### Endpoint
/v1.X/users

### Parameters
#### Request Body
- **properties** (array) - Optional - Specifies properties to filter or retrieve for clients.
```

--------------------------------

### Get User List

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=19.1

Retrieves a list of clients.

```APIDOC
## POST /v1.X/users

### Description
Returns a list of clients.

### Method
POST

### Endpoint
/v1.X/users

### Parameters
#### Request Body
- **properties** (array) - Optional - Properties to filter or retrieve user information.

```

--------------------------------

### Get Customers

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=16.1

Retrieves a list of customers.

```APIDOC
## POST /v1.X/users

### Description
Returns a list of customers.

### Method
POST

### Endpoint
/v1.X/users

### Parameters
#### Request Body
- **properties** (array) - Optional - An array of properties to filter or retrieve customer information.
```

--------------------------------

### Get Users

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?amp%3Bviewer=children&xpage=print

Retrieves a list of customers.

```APIDOC
## POST /v1.X/users

### Description
Retrieves a list of customers.

### Method
POST

### Endpoint
/v1.X/users

### Parameters
#### Request Body
- **properties** (array) - Optional - An array of properties to filter or retrieve user information.
```

--------------------------------

### GET /v1.X/LoyaltyPrograms

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?viewer=content

Retrieves a list of loyalty programs.

```APIDOC
## GET /v1.X/LoyaltyPrograms

### Description
Retrieves a list of loyalty programs.

### Method
GET

### Endpoint
/v1.X/LoyaltyPrograms

### Query Parameters
- **filter.onlyCommonForPartners** (boolean) - Optional - Filter to include only common programs for partners.
```

--------------------------------

### Get Users

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=21.1

Retrieves a list of customers.

```APIDOC
## POST /v1.X/users

### Description
Retrieves a list of customers.

### Method
POST

### Endpoint
/v1.X/users

### Parameters
#### Request Body
- **properties** (array) - Optional - Specifies properties to retrieve for users.
```

--------------------------------

### Get UI Configurations

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=17.1

Retrieves a list of UI configurations for the workstation.

```APIDOC
## GET /v1.X/configurations/ui

### Description
Returns a list of workstation configurations.

### Method
GET

### Endpoint
/v1.X/configurations/ui
```

--------------------------------

### Get UI Configurations

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=19.1

Retrieves a list of UI configurations for the workstation.

```APIDOC
## GET /v1.X/configurations/ui

### Description
Returns a list of UI configurations for the workstation.

### Method
GET

### Endpoint
/v1.X/configurations/ui

```

--------------------------------

### Example Generated Certificate Number

Source: https://docs.loymax.net/xwiki/bin/view/Main/Using/Gift_certificates/Gift_certificates_MMP/Certificate_patterns?xpage=print

An example of a generated certificate number based on the provided pattern, illustrating the breakdown of its components.

```text
2501000551854
```

--------------------------------

### Get Workstation Settings

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?language=ru&xpage=print

Retrieves a list of workstation settings for the ARM.

```APIDOC
## GET /v1.X/configurations/ui

### Description
Возвращает список настроек АРМ.

### Method
GET

### Endpoint
/v1.X/configurations/ui
```

--------------------------------

### Get Users List

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=20.1

Retrieves a list of customers.

```APIDOC
## POST /v1.X/users

### Description
Returns a list of customers.

### Method
POST

### Endpoint
/v1.X/users

### Parameters
#### Request Body
- **properties** (array) - Optional - An array of properties to filter or retrieve user information.

```

--------------------------------

### GET /v1.X/Events

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?xpage=print

Retrieves a list of business activities.

```APIDOC
## GET /v1.X/Events

### Description
Returns a list of business activities.

### Method
GET

### Endpoint
/v1.X/Events

### Parameters
#### Query Parameters
- **filter.historyUid** (string) - Optional - Filter by history UID.
- **filter.deviceId** (integer) - Optional - Filter by device ID.

```

--------------------------------

### Get User Workstations

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=14.1

Retrieves a list of workstations available to the user.

```APIDOC
## GET /v1.X/Devices

### Description
Retrieves a list of workstations available to the user.

### Method
GET

### Endpoint
/v1.X/Devices

### Parameters
#### Query Parameters
- **deviceTypeId** (integer) - Optional - Filters by workstation type ID.
```

--------------------------------

### GET /v1.X/offers/AvailablePartners

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?language=ru&viewer=code

Retrieves a list of available partners for offers.

```APIDOC
## GET /v1.X/offers/AvailablePartners

### Description
Returns a list of Partners.

### Method
GET

### Endpoint
/v1.X/offers/AvailablePartners

### Parameters
#### Query Parameters
- **loyaltyProgramId** (integer) - Optional - Loyalty program identifier.
- **sortingIds** (integer) - Optional - Identifier for sorting.
```

--------------------------------

### Export Rendering Example

Source: https://docs.loymax.net/xwiki/bin/view/Main/Frequently_asked_questions/FAQ_API?language=ru

Demonstrates how to render content using a service, specifying the output format.

```groovy
$services.rendering.render($uix.execute(), 'html/5.0')
```

```groovy
$services.rendering.render($uix.execute(), 'html/5.0')
```

--------------------------------

### GET /v1.2/purchases/{purchaseId}/chequeSum

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=15.1

Gets the cheque sum for a purchase, considering discounts.

```APIDOC
## GET /v1.2/purchases/{purchaseId}/chequeSum

### Description
Gets the cheque sum with discounts applied for a purchase.

### Method
GET

### Endpoint
/v1.2/purchases/{purchaseId}/chequeSum

### Parameters
#### Path Parameters
- **purchaseId** (integer) - Required - The ID of the purchase.
```

--------------------------------

### Example: 'Order Placed' Trigger Context Usage

Source: https://docs.loymax.net/xwiki/bin/view/Main/Using/Smart_Communications/Mass_mailings/Template_builder

Demonstrates how to use client and order details, including iterating through order items, for personalized communication in an 'Order Placed' campaign.

```N/A
{{trigger.client.properties.full_name}},
{{trigger.eorder.date}} вы оформили заказ {{trigger.eorder.number}} на сумму {{trigger.eorder.items_sum}} с доставкой в г. {{trigger.eorder.delivery_city}}.Состав заказа:{% for item in trigger.eorder.items %}
  Название товара: {{item.name}}
  Количество товара: {{item.cnt}}
  Цена товара: {{item.price}}
  Скидка: {{item.discount}}
  Стоимость товара: {{item.cnt}} x ({{item.price}} - {{item.discount}})= {{item.sum}}
{% endfor %}
```

--------------------------------

### Get List of Customers

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=14.1

Retrieves a list of customers.

```APIDOC
## POST /v1.X/users

### Description
Retrieves a list of customers.

### Method
POST

### Endpoint
/v1.X/users

### Parameters
#### Request Body
- **properties** (array) - Optional - Properties to filter or retrieve customer information.
```

--------------------------------

### UI Configurations

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?amp%3Bviewer=children&xpage=print

Retrieves a list of workstation settings.

```APIDOC
## GET /v1.X/configurations/ui

### Description
Retrieves a list of workstation settings.

### Method
GET

### Endpoint
/v1.X/configurations/ui
```

--------------------------------

### Get Event Calculation API

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=28.1

Updates the data type for the 'id' parameter in the Get Event Calculation endpoint.

```APIDOC
## GET /v1.X/EventCalculations/{id}

### Description
Returns information about a calculation by its internal identifier.

### Method
GET

### Endpoint
/v1.X/EventCalculations/{id}

### Parameters
#### Path Parameters
- **id** (long) - Required - The internal identifier of the event calculation. (Previously integer)
```

--------------------------------

### GET /v1.X/emissions/coupons

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?viewer=content

Retrieves a list of existing coupon emissions.

```APIDOC
## GET /v1.X/emissions/coupons

### Description
Retrieves a list of existing coupon emissions.

### Method
GET

### Endpoint
/v1.X/emissions/coupons

### Query Parameters
- **filter.isDynamic** (boolean) - Optional - Filter by dynamic coupons.
```

--------------------------------

### Get Partner Devices List

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=20.1

Retrieves a list of partner devices.

```APIDOC
## GET /v1.X/partners/{partnerId}/deviceInfo

### Description
Returns a list of partner devices.

### Method
GET

### Endpoint
/v1.X/partners/{partnerId}/deviceInfo

### Parameters
#### Path Parameters
- **partnerId** (string) - Required - The ID of the partner.
#### Query Parameters
- **deviceTypeId** (integer) - Optional - Filter by device type ID.

```

--------------------------------

### Create User

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?language=ru&viewer=code

Creates a new user.

```APIDOC
## POST /v1.X/users

### Description
Creates a new user.

### Method
POST

### Endpoint
/v1.X/users
```

--------------------------------

### Get All System Users

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=22.1

Retrieves a list of all system users.

```APIDOC
## GET /v1.X/SystemUsers

### Description
Returns a list of all system users.

### Method
GET

### Endpoint
/v1.X/SystemUsers

#### Query Parameters
- **isDeleted** (boolean) - Optional - Filter by deleted status.
```

--------------------------------

### Get Loyalty Programs

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=17.1

Retrieves a list of loyalty programs.

```APIDOC
## GET /v1.X/LoyaltyPrograms

### Description
Returns a list of loyalty programs.

### Method
GET

### Endpoint
/v1.X/LoyaltyPrograms

### Parameters
#### Query Parameters
- **filter.onlyCommonForPartners** (boolean) - Optional - Filters to include only common programs for partners.
```

--------------------------------

### Get Loyalty Programs

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=14.1

Retrieves a list of loyalty programs.

```APIDOC
## GET /v1.X/LoyaltyPrograms

### Description
Retrieves a list of loyalty programs.

### Method
GET

### Endpoint
/v1.X/LoyaltyPrograms

### Parameters
#### Query Parameters
- **filter.onlyCommonForPartners** (boolean) - Optional - Filters for loyalty programs common to all partners.
```

--------------------------------

### Get UI Configuration Settings

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=20.1

Retrieves a list of UI configuration settings for the workstation.

```APIDOC
## GET /v1.X/configurations/ui

### Description
Returns a list of UI configuration settings for the workstation.

### Method
GET

### Endpoint
/v1.X/configurations/ui

```

--------------------------------

### Get Audits

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?viewer=code&xpage=print

Retrieves audit information.

```APIDOC
## GET /v1.X/audits

### Description
Retrieves audit information.

### Method
GET

### Endpoint
/v1.X/audits

### Parameters
#### Query Parameters
- **filter.authorId** (integer) - Optional - The ID of the author to filter audits by.
```

--------------------------------

### Get Loyalty Programs

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=21.1

Retrieves a list of loyalty programs.

```APIDOC
## GET /v1.X/LoyaltyPrograms

### Description
Retrieves a list of loyalty programs.

### Method
GET

### Endpoint
/v1.X/LoyaltyPrograms

### Parameters
#### Query Parameters
- **filter.onlyCommonForPartners** (boolean) - Optional
```

--------------------------------

### GET /v1.X/audits

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?xpage=print&xpage=copy

Retrieves audit information.

```APIDOC
## GET /v1.X/audits

### Description
Returns audit information.

### Method
GET

### Endpoint
/v1.X/audits

### Parameters
#### Query Parameters
- **filter.authorId** (integer) - Optional - Filter by the author's ID.
```

--------------------------------

### Get Business Activities

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes

Retrieves a list of business activities.

```APIDOC
## GET /v1.X/Events

### Description
Returns a list of business activities.

### Method
GET

### Endpoint
/v1.X/Events

### Parameters
#### Query Parameters
- **filter.historyUid** (string) - Optional - Filter by history UID.
- **filter.deviceId** (integer) - Optional - Filter by device ID.
```

--------------------------------

### Using System Macros for Promocodes

Source: https://docs.loymax.net/xwiki/bin/view/Main/Using/Smart_Communications/Mass_mailings/Template_builder?viewer=code

Retrieve promocodes from a specified group for the client. Replace 'группа промокода' with the actual group name.

```Smart Communications Template Language
##~{~{client.promocode('группа промокода')}}##
```

```Smart Communications Template Language
##~{~{client.last_promocode('группа промокода')}}##
```

```Smart Communications Template Language
##~{~{client.last_campaign_promocode('группа промокода')}}##
```

--------------------------------

### GET /v1.X/targetGroups

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=15.1

Retrieves all target groups.

```APIDOC
## GET /v1.X/targetGroups

### Description
Returns all target groups.

### Method
GET

### Endpoint
/v1.X/targetGroups

### Parameters
#### Query Parameters
- **creationType** (string) - Optional - Filters target groups by creation type.
```

--------------------------------

### Get Purchases

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=16.1

Retrieves information about purchases.

```APIDOC
## GET /v1.X/deviceEmulation/purchases

### Description
Returns information about purchases.

### Method
GET

### Endpoint
/v1.X/deviceEmulation/purchases

### Parameters
#### Query Parameters
- **from** (integer) - Optional - The starting index for pagination.
- **docId** (integer) - Optional - The document ID.
- **getNextPage** (boolean) - Optional - Indicates whether to retrieve the next page of results.
```

--------------------------------

### UI Configurations

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=23.1

Retrieves a list of UI configurations for the Workstation Application.

```APIDOC
## GET /v1.X/configurations/ui

### Description
Retrieves a list of UI configurations for the Workstation Application.

### Method
GET

### Endpoint
/v1.X/configurations/ui

### Response
#### Success Response (200)
- [Response fields not specified in source]
```

--------------------------------

### Get UI Configuration Settings

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=14.1

Retrieves the list of UI configuration settings for the workstation.

```APIDOC
## GET /v1.X/configurations/ui

### Description
Retrieves a list of UI configuration settings for the workstation.

### Method
GET

### Endpoint
/v1.X/configurations/ui
```

--------------------------------

### Get Purchases

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?amp%3Bviewer=children&xpage=print

Retrieves purchase information.

```APIDOC
## GET /v1.X/deviceEmulation/purchases

### Description
Retrieves purchase information.

### Method
GET

### Endpoint
/v1.X/deviceEmulation/purchases

### Parameters
#### Query Parameters
- **from** (integer) - Optional - Starting index for the results.
- **docId** (integer) - Optional - Filter by document ID.
- **getNextPage** (boolean) - Optional - Flag to get the next page of results.
```

--------------------------------

### Get Loyalty Programs List

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=20.1

Retrieves a list of loyalty programs.

```APIDOC
## GET /v1.X/LoyaltyPrograms

### Description
Returns a list of loyalty programs.

### Method
GET

### Endpoint
/v1.X/LoyaltyPrograms

### Parameters
#### Query Parameters
- **filter.onlyCommonForPartners** (boolean) - Optional - Filter to include only common programs for partners.

```

--------------------------------

### Access Trigger Context for Order Details

Source: https://docs.loymax.net/xwiki/bin/view/Main/Using/Smart_Communications/Mass_mailings/Template_builder?viewer=code

This example demonstrates how to access and display detailed information about a customer's order within a mass mailing template. It includes iterating through order items.

```html
{% for item in trigger.eorder.items %}
 Название товара: {{item.name}}
 Количество товара: {{item.cnt}}
 Цена товара: {{item.price}}
 Скидка: {{item.discount}}
 Стоимость товара: {{item.cnt}} x (~{{item.price}} - ~{{item.discount}})= {{item.sum}}
{% endfor %}
```

--------------------------------

### Get Partner Device Info

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=14.1

Retrieves a list of partner devices.

```APIDOC
## GET /v1.X/partners/{partnerId}/deviceInfo

### Description
Retrieves a list of partner devices.

### Method
GET

### Endpoint
/v1.X/partners/{partnerId}/deviceInfo

### Parameters
#### Path Parameters
- **partnerId** (string) - Required - The ID of the partner.

#### Query Parameters
- **deviceTypeId** (integer) - Optional - Filters by device type ID.
```

--------------------------------

### POST /v1.X/Cards/BatchPack

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?language=ru

Packs and links cards in batches. Requires a file.

```APIDOC
## POST /v1.X/Cards/BatchPack

### Description
Packs and links cards in batches.

### Method
POST

### Endpoint
/v1.X/Cards/BatchPack

### Parameters
#### Request Body
- **file** (file) - Required - The file containing the cards to be packed and linked.
- **state** (string) - Optional
- **from** (integer) - Optional
- **count** (integer) - Optional
```

--------------------------------

### Personal Offer Acceptance with ML Mechanics

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/News?rev=692.1

Documentation has been expanded to cover personal offers and their acceptance using ML mechanics. New mechanics have been added, and a list of all available personal promo offer mechanics is now in a separate article. API methods for personal offers have been updated with request and response models for acceptance, and a new API method for accepting personal offers has been added.

```APIDOC
## GET /api/v1/personaloffers/{offerId}/accept

### Description
Accepts a personal offer.

### Method
POST

### Endpoint
/api/v1/personaloffers/{offerId}/accept

### Parameters
#### Path Parameters
- **offerId** (string) - Required - The ID of the personal offer to accept.

### Request Example
```json
{
  "customerId": "12345"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the result of the acceptance operation.

#### Response Example
```json
{
  "status": "accepted"
}
```
```

--------------------------------

### Get Users

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=26.1

Retrieves a list of customers. Supports specifying properties to return.

```APIDOC
## POST /v1.X/users

### Description
Retrieves a list of customers.

### Method
POST

### Endpoint
/v1.X/users

### Request Body
- **properties** (array) - Optional - Specifies which properties to return for each customer.
```

--------------------------------

### Format Recommendations into Batches and Display Product Details

Source: https://docs.loymax.net/xwiki/bin/view/Main/Using/Smart_Communications/Recommendations?xpage=print

Groups filtered recommendations into batches of three and displays product name and image URL. It only includes batches with exactly three products.

```Jinja
{% for batch in filteredRec|batch(3) %}
{% if batch|length==3 %}
{% for recommendation in batch %}
{{ recommendation.name }}
{{ recommendation.image_url }}
{% endif %}
{% endfor %}
{% endif %}
{% endfor %}
```

--------------------------------

### Using System Macros for Date Formatting

Source: https://docs.loymax.net/xwiki/bin/view/Main/Using/Smart_Communications/Mass_mailings/Template_builder?viewer=code

Get the current date and format it. The 'формат' placeholder can be replaced with desired date format specifiers.

```Smart Communications Template Language
##~{~{"now"|date('формат')}}##
```

--------------------------------

### Initialize Tag Application Variables

Source: https://docs.loymax.net/xwiki/bin/view/Main/Tags?viewer=code&xpage=print

Sets up essential variables like 'do' (action) and 'tag' from URL parameters. It also escapes the tag for URL and HTML usage. This is a prerequisite for most tag operations.

```velocity
#set ($do = "$!{request.get('do')}")
#set ($tag = "$!{request.get('tag')}")
#set ($urlEscapedTag = $escapetool.url($tag))
#set ($htmlEscapedTag = $escapetool.xml($tag))
```

--------------------------------

### GET /v1.X/notifyTemplates

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?viewer=content

Retrieves a list of notification templates.

```APIDOC
## GET /v1.X/notifyTemplates

### Description
Retrieves a list of notification templates.

### Method
GET

### Endpoint
/v1.X/notifyTemplates

### Query Parameters
- **requestModel.applicationFilter.getAll** (boolean) - Optional - Flag to get all application templates.
- **requestModel.applicationFilter.applicationId** (integer) - Optional - Filter by application ID.
```

--------------------------------

### GET /v1.X/operationPay

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?language=ru&viewer=code

Retrieves information about how a purchase was paid.

```APIDOC
## GET /v1.X/operationPay

### Description
Information about the methods used to pay for a purchase.

### Method
GET

### Endpoint
/v1.X/operationPay

### Parameters
#### Query Parameters
- **purchaseId** (integer) - Required - The ID of the purchase.
```

--------------------------------

### Example DKIM Key Record Configuration

Source: https://docs.loymax.net/xwiki/bin/view/Main/Using/Smart_Communications/Mass_mailings/High-quality_mailings_recommendations/DNS_configuring

This TXT record configures DKIM with RSA encryption and specifies the public key for signature verification. The 'o=-' tag indicates that signing is optional.

```dns
o=-;
```

```dns
o=-;
```

```dns
v=DKMI1M; k=rsa; p=MIGfMAOG......
```

--------------------------------

### Get Audit Information

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=22.1

Retrieves audit information.

```APIDOC
## GET /v1.X/audits

### Description
Returns audit information.

### Method
GET

### Endpoint
/v1.X/audits

#### Query Parameters
- **filter.authorId** (integer) - Optional - Filter by author ID.
```

--------------------------------

### POST /v1.X/coupons/link/batch

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?language=ru

Performs batch linking of coupons to clients. Requires emissionUid and a list of coupon links.

```APIDOC
## POST /v1.X/coupons/link/batch

### Description
Performs batch linking of coupons to clients.

### Method
POST

### Endpoint
/v1.X/coupons/link/batch

### Parameters
#### Request Body
- **emissionUid** (string) - Required - The unique identifier of the emission.
- **couponLinks** (array) - Required - A list of coupon links to be processed.
```

--------------------------------

### GET /v1.X/oauth/providers

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?language=ru&viewer=code

Retrieves a list of OAuth providers.

```APIDOC
## GET /v1.X/oauth/providers

### Description
Retrieves a list of OAuth providers.

### Method
GET

### Endpoint
/v1.X/oauth/providers
```

--------------------------------

### GET /v1.X/SystemUsers

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=15.1

Retrieves a list of all system users.

```APIDOC
## GET /v1.X/SystemUsers

### Description
Returns a list of all system users.

### Method
GET

### Endpoint
/v1.X/SystemUsers

### Parameters
#### Query Parameters
- **isDeleted** (boolean) - Optional - Indicates whether to include deleted users.
```

--------------------------------

### Get Available Partners

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=17.1

Retrieves a list of partners.

```APIDOC
## GET /v1.X/offers/AvailablePartners

### Description
Returns a list of partners.

### Method
GET

### Endpoint
/v1.X/offers/AvailablePartners

### Parameters
#### Query Parameters
- **loyaltyProgramId** (integer) - Optional - Filters partners by loyalty program ID.
- **sortingIds** (integer) - Optional - Specifies IDs for sorting.
```

--------------------------------

### Get UI Configurations

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=15.1

Retrieves a list of UI configurations for the Workstation Application (АРМ).

```APIDOC
## GET /v1.X/configurations/ui

### Description
Returns a list of UI configurations for the Workstation Application (АРМ).

### Method
GET

### Endpoint
/v1.X/configurations/ui
```

--------------------------------

### Get Available Partners

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=14.1

Retrieves a list of partners.

```APIDOC
## GET /v1.X/offers/AvailablePartners

### Description
Retrieves a list of partners.

### Method
GET

### Endpoint
/v1.X/offers/AvailablePartners

### Parameters
#### Query Parameters
- **loyaltyProgramId** (integer) - Optional - Filters by loyalty program ID.
- **sortingIds** (integer) - Optional - IDs for sorting the partner list.
```

--------------------------------

### API for Registering New Client

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/News?language=ru

Documentation for the API method used to register a new client. Available for OAuth applications since system version lmxR8.

```APIDOC
## POST /clients/register

### Description
Registers a new client in the system. This method is available for OAuth applications.

### Method
POST

### Endpoint
/clients/register

### Request Body
- **clientData** (object) - Required - Data for the new client.
  - **firstName** (string) - Required - The first name of the client.
  - **lastName** (string) - Required - The last name of the client.
  - **email** (string) - Optional - The email address of the client.

### Request Example
```json
{
  "clientData": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com"
  }
}
```

### Response
#### Success Response (200)
- **clientId** (string) - The unique identifier of the newly registered client.

#### Response Example
```json
{
  "clientId": "newClient123"
}
```
```

--------------------------------

### Get Available Partners

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=21.1

Retrieves a list of partners.

```APIDOC
## GET /v1.X/offers/AvailablePartners

### Description
Retrieves a list of partners.

### Method
GET

### Endpoint
/v1.X/offers/AvailablePartners

### Parameters
#### Query Parameters
- **loyaltyProgramId** (integer) - Optional
- **sortingIds** (integer) - Optional
```

--------------------------------

### Get History Records

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=17.1

Retrieves records from the history.

```APIDOC
## GET /v1.X/History/{purchaseUid}

### Description
Get records from history.

### Method
GET

### Endpoint
/v1.X/History/{purchaseUid}

### Parameters
#### Path Parameters
- **purchaseUid** (string) - Required - The unique identifier of the purchase.
```

--------------------------------

### Get ARM Settings

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=16.1

Retrieves a list of ARM (Automated Retail Management) settings.

```APIDOC
## GET /v1.X/configurations/ui

### Description
Returns a list of ARM settings.

### Method
GET

### Endpoint
/v1.X/configurations/ui
```

--------------------------------

### Get Available Partners

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=20.1

Retrieves a list of partners.

```APIDOC
## GET /v1.X/offers/AvailablePartners

### Description
Returns a list of partners.

### Method
GET

### Endpoint
/v1.X/offers/AvailablePartners

### Parameters
#### Query Parameters
- **loyaltyProgramId** (integer) - Optional - Filter by loyalty program ID.
- **sortingIds** (integer) - Optional - IDs for sorting.

```

--------------------------------

### Get Available Partners

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?viewer=code&xpage=print

Retrieves a list of partners available for a loyalty program.

```APIDOC
## GET /v1.X/offers/AvailablePartners

### Description
Retrieves a list of partners available for a loyalty program.

### Method
GET

### Endpoint
/v1.X/offers/AvailablePartners

### Parameters
#### Query Parameters
- **loyaltyProgramId** (integer) - Optional - The ID of the loyalty program.
- **sortingIds** (integer) - Optional - IDs for sorting the results.
```

--------------------------------

### List Workstations

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=27.1

Retrieves a list of workstations available to the user.

```APIDOC
## GET /v1.X/Devices

### Description
Returns a list of workstations available to the user.

### Method
GET

### Endpoint
/v1.X/Devices

### Query Parameters
- **deviceTypeId** (integer) - Optional - Filter by workstation type ID.
```

--------------------------------

### Get Purchase Information

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=14.1

Retrieves information about purchases.

```APIDOC
## GET /v1.X/deviceEmulation/purchases

### Description
Retrieves information about purchases.

### Method
GET

### Endpoint
/v1.X/deviceEmulation/purchases

### Parameters
#### Query Parameters
- **docId** (integer) - Optional - The document ID of the purchase.
- **getNextPage** (boolean) - Optional - Indicates whether to retrieve the next page of results.
```

--------------------------------

### GET /v1.X/Devices

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?viewer=content

Retrieves a list of cash registers available to the workstation user.

```APIDOC
## GET /v1.X/Devices

### Description
Retrieves a list of cash registers available to the workstation user.

### Method
GET

### Endpoint
/v1.X/Devices

### Query Parameters
- **deviceTypeId** (integer) - Optional - Filter by device type ID.
```

--------------------------------

### List User Workstations

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=29.1

Retrieves a list of workstations available to the user.

```APIDOC
## GET /v1.X/Devices

### Description
Returns a list of workstations available to the user.

### Method
GET

### Endpoint
/v1.X/Devices

### Query Parameters
- **deviceTypeId** (integer) - Optional - Filter by device type ID.
```

--------------------------------

### Get History Records

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=19.1

Retrieves records from the history.

```APIDOC
## GET /v1.X/History/{purchaseUid}

### Description
Gets records from the history.

### Method
GET

### Endpoint
/v1.X/History/{purchaseUid}

### Parameters
#### Path Parameters
- **purchaseUid** (string) - Required - The unique identifier of the purchase.

```

--------------------------------

### Get Purchases Information

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=19.1

Retrieves information about purchases.

```APIDOC
## GET /v1.X/deviceEmulation/purchases

### Description
Returns information about purchases.

### Method
GET

### Endpoint
/v1.X/deviceEmulation/purchases

### Parameters
#### Query Parameters
- **docId** (integer) - Optional - The ID of the document.
- **getNextPage** (boolean) - Optional - Whether to retrieve the next page of results.

```

--------------------------------

### System Macros

Source: https://docs.loymax.net/xwiki/bin/view/Main/Using/Smart_Communications/Mass_mailings/Template_builder?xpage=print

Utilize system macros for dynamic content generation, such as fetching current dates, promocodes, or survey links. Ensure correct parameters are provided for each macro.

```Smart Communications Template Language
{{"now"|date('формат')}}
```

```Smart Communications Template Language
{{client.promocode('группа промокода')}}
```

```Smart Communications Template Language
{{client.last_promocode('группа промокода')}}
```

```Smart Communications Template Language
{{client.last_campaign_promocode('группа промокода')}}
```

```Smart Communications Template Language
{{client.template_constant('наименование')}}
```

```Smart Communications Template Language
{{client.poll('POLL-идентификатор_опроса')}}
```

```Smart Communications Template Language
{{client.loyaltyCard.lastActive.number}}
```

--------------------------------

### Get Coupon Creation Background Process Progress

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?language=ru&xpage=print

Obtains information about the background process for creating coupons for a specified queue.

```APIDOC
## GET /v1.X/emissions/coupons/{id}/progress

### Description
Получить информацию по фоновому процессу создания купонов для указанной очереди.

### Method
GET

### Endpoint
/v1.X/emissions/coupons/{id}/progress

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the coupon emission queue.
```

--------------------------------

### POST /v1.X/coupons/link/batch

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?viewer=content

Performs batch linking of coupons to customers.

```APIDOC
## POST /v1.X/coupons/link/batch

### Description
Performs batch linking of coupons to customers.

### Method
POST

### Endpoint
/v1.X/coupons/link/batch

### Request Body
- **emissionUid** (string) - Required - The unique identifier of the coupon emission.
- **couponLinks** (array) - Required - An array of coupon linking information.
```

--------------------------------

### Get Target Groups

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes

Retrieves all target groups.

```APIDOC
## GET /v1.X/targetGroups

### Description
Returns all target groups.

### Method
GET

### Endpoint
/v1.X/targetGroups

### Parameters
#### Query Parameters
- **isExternal** (boolean) - Optional - Filter by external status.
- **creationType** (string) - Optional - Filter by creation type.
```

--------------------------------

### Variable Replacement Example

Source: https://docs.loymax.net/xwiki/bin/view/Main/Using/Smart_Communications/Mass_mailings/Template_builder?xpage=print

Illustrates the result of a variable substitution in a message. After processing, the placeholder is replaced with the client's data.

```text
Добрый день, Иванов Иван Иванович.
```

--------------------------------

### GET /v1.X/Pushes/{messageId}

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?showLastAuthors=true&viewer=code

Retrieves information about a push notification.

```APIDOC
## GET /v1.X/Pushes/{messageId}

### Description
Retrieves information about a push notification.

### Method
GET

### Endpoint
/v1.X/Pushes/{messageId}

### Parameters
#### Query Parameters
- **personId** (integer) - optional - The ID of the person, required when authorizing via OAuth application without client involvement.
```

--------------------------------

### Get User History

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?showLastAuthors=true&viewer=code

Retrieves the operation history for a client.

```APIDOC
## GET /v1.X/Users/{personId}/History

### Description
Returns the operation history for a client.

### Method
GET

### Endpoint
/v1.X/Users/{personId}/History

### Parameters
#### Path Parameters
- **personId** (integer) - Required - The ID of the person.

#### Query Parameters
- **filter.states** (string) - Optional - Filter by operation states.
```

--------------------------------

### POST /v1.X/users

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?viewer=content

Retrieves a list of customers.

```APIDOC
## POST /v1.X/users

### Description
Retrieves a list of customers.

### Method
POST

### Endpoint
/v1.X/users

### Request Body
- **properties** (array) - Optional - Properties to filter or retrieve customer information.
```

--------------------------------

### Batch Coupon Linking Method

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2?viewer=code

A new method allows for batch linking of coupons to Loyalty Program participants, enabling coupon distribution without requiring a purchase.

```APIDOC
## Batch Coupon Linking Method

### Description
This method is designed for batch linking coupons to Loyalty Program participants. It supports coupons in the 'Awaiting Distribution' state and allows distribution without a purchase. The batch size can be configured.

### Endpoint
Refer to the documentation for the specific batch coupon linking method.

### Parameters
- **CouponLinkBatchSize** (integer) - Configurable parameter for the size of the coupon batch.

### See Also
[[Method for batch linking coupons to Loyalty Program participants>>doc:Main.Integration.Ways_to_use_API.System_Api_Methods.Methods_of_system_api.CouponOperation.WebHome||anchor="02"]]
```

--------------------------------

### Get History Purchase

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=28.1

Retrieves records from the purchase history.

```APIDOC
## GET /v1.X/History/{purchaseUid}

### Description
Retrieves records from the purchase history.

### Method
GET

### Endpoint
/v1.X/History/{purchaseUid}

### Parameters
#### Path Parameters
- **purchaseUid** (string) - Required - The unique identifier of the purchase.
```

--------------------------------

### Get Purchase Information

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=25.1

Retrieves information about a purchase from history.

```APIDOC
## GET /v1.X/purchases/History/{purchaseId}

### Description
Returns information about a purchase from history.

### Method
GET

### Endpoint
/v1.X/purchases/History/{purchaseId}

### Parameters
#### Path Parameters
- **purchaseId** (integer) - Required - The ID of the purchase.

#### Query Parameters
- **withCoupons** (boolean) - Optional - Indicates whether to include coupon information.
```

```APIDOC
## GET /v1.X/purchases/History/{purchaseUid}

### Description
Returns information about a purchase from history.

### Method
GET

### Endpoint
/v1.X/purchases/History/{purchaseUid}

### Parameters
#### Path Parameters
- **purchaseUid** (string) - Required - The UID of the purchase.

#### Query Parameters
- **withCoupons** (boolean) - Optional - Indicates whether to include coupon information.
```

--------------------------------

### Get Coupon Creation Progress

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=14.1

Retrieves information about the background process of coupon creation for a specified queue.

```APIDOC
## GET /v1.X/emissions/coupons/{id}/progress

### Description
Gets information about the background process of coupon creation for the specified queue.

### Method
GET

### Endpoint
/v1.X/emissions/coupons/{id}/progress

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the coupon emission queue.
```

--------------------------------

### GET /v1.X/purchases/History/{purchaseId}

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?language=ru&viewer=code

Retrieves purchase information from history.

```APIDOC
## GET /v1.X/purchases/History/{purchaseId}

### Description
Retrieves purchase information from history.

### Method
GET

### Endpoint
/v1.X/purchases/History/{purchaseId}

### Parameters
#### Path Parameters
- **purchaseId** (integer) - Required - The ID of the purchase.
#### Query Parameters
- **withCoupons** (boolean) - Optional - Whether to include coupon information.
```

--------------------------------

### Personal Offer Acceptance with ML Mechanics

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/News

Documentation has been expanded to cover the functionality of accepting personal offers using ML mechanics. New mechanics for accepting personal offers have been added, and a list of all available mechanics is now in a separate article. API methods for working with personal offers have been updated, including request and response models for offers with acceptance.

```APIDOC
## Get Personal Offer Information

### Description
Retrieves information about a personal offer, including request and response models for offers with acceptance.

### Method
GET

### Endpoint
/api/offers/{offerId}

### Parameters
#### Path Parameters
- **offerId** (string) - Required - The ID of the personal offer.

### Response
#### Success Response (200)
- **offerDetails** (object) - Details of the personal offer.
  - **acceptanceModel** (object) - Model for offer acceptance.

#### Response Example
{
  "offerDetails": {
    "id": "offer123",
    "name": "Special Discount",
    "acceptanceModel": {
      "type": "ML_MECHANIC_V1",
      "parameters": {
        "model_version": "1.0"
      }
    }
  }
}
```

```APIDOC
## Accept Personal Offer

### Description
Accepts a personal offer after verifying its eligibility for acceptance.

### Method
POST

### Endpoint
/api/offers/{offerId}/accept

### Parameters
#### Path Parameters
- **offerId** (string) - Required - The ID of the personal offer to accept.

### Request Body
{
  "acceptanceDetails": {
    "mechanicType": "ML_MECHANIC_V1",
    "parameters": {
      "user_id": "user456"
    }
  }
}

### Response
#### Success Response (200)
- **status** (string) - The status of the acceptance operation (e.g., "accepted", "already_accepted").

#### Response Example
{
  "status": "accepted"
}
```

--------------------------------

### Get All Target Groups

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?language=ru&xpage=print

Retrieves a list of all target audiences.

```APIDOC
## GET /v1.X/targetGroups

### Description
Returns all target audiences.

### Method
GET

### Endpoint
/v1.X/targetGroups

### Parameters
#### Query Parameters
- **isExternal** (boolean) - Optional - Filters by external status.
- **creationType** (string) - Optional - Filters by creation type.
```

--------------------------------

### Get Cheque Sum

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?language=ru&xpage=print

Retrieves the cheque sum for a purchase.

```APIDOC
## GET /v1.2/purchases/{purchaseId}/chequeSum

### Description
Возвращает сумму чека по покупке.

### Method
GET

### Endpoint
/v1.2/purchases/{purchaseId}/chequeSum

### Parameters
#### Path Parameters
- **purchaseId** (integer) - Required - The ID of the purchase.
```

--------------------------------

### PUT /v1.X/coupons/enqueueByEmission/{emissionId}

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?language=ru

Transitions created coupons to the 'Queued for Issuance' state and returns coupon numbers. Requires emissionId.

```APIDOC
## PUT /v1.X/coupons/enqueueByEmission/{emissionId}

### Description
Transitions created coupons to the 'Queued for Issuance' state and returns coupon numbers.

### Method
PUT

### Endpoint
/v1.X/coupons/enqueueByEmission/{emissionId}

### Parameters
#### Path Parameters
- **emissionId** (integer) - Required - The ID of the coupon emission.
#### Query Parameters
- **count** (integer) - Optional - The number of coupons to transition.
```

--------------------------------

### Get Purchase Payment Methods

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?language=ru&xpage=print

Information on how a purchase was paid.

```APIDOC
## GET /v1.X/operationPay

### Description
Информация какими способами оплачена покупка.

### Method
GET

### Endpoint
/v1.X/operationPay

### Parameters
#### Query Parameters
- **purchaseId** (integer) - Required - The ID of the purchase.
```

--------------------------------

### Get UI Configuration Settings

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?rev=13.1

Retrieves a list of UI configuration settings for the Workstation Application (АРМ).

```APIDOC
## GET /v1.X/configurations/ui

### Description
Retrieves a list of UI configuration settings for the Workstation Application (АРМ).

### Method
GET

### Endpoint
/v1.X/configurations/ui
```

--------------------------------

### Get Coupon by ID

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?amp%3Bviewer=children&xpage=print

Retrieves coupon information by its ID.

```APIDOC
## POST /v1.X/Coupons/couponById

### Description
Retrieves coupon information by its ID.

### Method
POST

### Endpoint
/v1.X/Coupons/couponById

### Parameters
#### Request Body
- **issueDate** (string) - Optional - The issue date of the coupon. Its requirement depends on the 'UseLocalDateForCoupons' configuration.
```

--------------------------------

### POST /v1.X/oauth/providers

Source: https://docs.loymax.net/xwiki/bin/view/Main/General_information/Update_history/2022.2/API_changes?xpage=print

Creates an authentication provider. Requires a model.

```APIDOC
## POST /v1.X/oauth/providers

### Description
Creates an authentication provider.

### Method
POST

### Endpoint
/v1.X/oauth/providers

### Parameters
#### Request Body
- **model** (string) - Required - The provider model.
```
Tokens:
Raw