ReMarked Loyalty API v2 (2.9)

Download OpenAPI specification:Download

API предназначено для доступа к процессингу программ лояльности на базе ReMarked

CashBox

/сashbox/сonfig/load

Authorizations:

None

Responses

Response samples

200

Content type

application/json

{"reserve": {"active": true,
"ws_address": "ws://95.143.188.9:3009/cashes/22d3105c38742b1122372d8012ef5das",
"reconnect_time": 20,
"enable_dishes_exchange": true
},
"loyalty": {"active": true,
"checkin": true,
"balance_check": true,
"add_guest": true,
"search_by_card": true,
"search_by_phone": true,
"address": "https://app.remarked.ru/api/v2",
"loyalty_data_address": "https://app.remarked.ru/api/v2",
"token": "2157993bfaa752552883b619788d08e7",
"discount_id": "64a26747-8dc8-44b2-86b0-af86750e7c2b",
"bonus_write_off": true,
"make_discount_after_checkin": true,
"enable_promo": true,
"enable_check_transaction": true,
"iiko_waiter_settings": {"active": true,
"port": 8002
},
"enable_certificate": true,
"order_update_time": 60,
"auto_scan": {"active": true,
"type": "prefix",
"value": "RM"
},
"send_not_authorized_order": true
},
"transport_settings": {"active": true,
"api_key": "382e2b37-f6e",
"organization_id": ""
},
"show_pages": {"active": true,
"show_on_first_opening": {"active": false,
"name": "Информация о госте",
"url": "https://remarked.ru/"
},
"pages_list": [{"name": "Информация о госте",
"button": "О госте",
"url": "https://remarked.ru/"
}
]
},
"sale_of_certificates": {"active": false,
"dish_guid": "58ae9688-685e-468b-8dfd-3ecb1bf04741"
}
}

LoyaltyData

/loyaltydata/category/update

Authorizations:

None

Request Body schema: application/json

Array

guid	string <GUID> Глобальный идентификатор категории
name	string Название категории
parent	string or null <GUID> Глобальный идентификатор родительской категории

Responses

Request samples

Payload

Content type

application/json

[{"guid": "d20d4ecb-2eed-4dc2-a17e-9e6fa3b21278",
"name": "Кофе",
"parent": "4fe37f82-87e1-44b8-beae-54f8cbd49632"
}
]

Response samples

200

Content type

application/json

{"status": 200
}

/loyaltydata/nomenclature/update

Authorizations:

None

Request Body schema: application/json

Array

guid	string <GUID> Глобальный идентификатор блюда
name	string Название блюда
category	string or null <GUID> Глобальный идентификатор категории
type	enum Enum: "Dish" "Modifier" "Product" "Goods" "Service" "HalfFinishedGoods" "RKMenuItemType.MENUITEM" "RKMenuItemType.COMBOITEM" Тип позиции
price	double Стоимость позиции
description	string Стоимость позиции
	Array of objects Модификаторы блюда
	Array of objects Групповые модификаторы блюда

Responses

Request samples

Payload

Content type

application/json

[{"guid": "7a003149-da48-47be-b929-c956c4a17283",
"name": "Американо",
"category": "d20d4ecb-2eed-4dc2-a17e-9e6fa3b21278",
"type": "Dish",
"price": 100.55,
"description": "Классический кофе",
"modifiers": [{"guid": "ba93ae65-3542-4d3f-9699-f30465fd3502",
"minAmount": 0,
"maxAmount": 0,
"defaultAmount": 1
}
],
"group_modifiers": [{"guid": "a42178d1-17b4-4e0c-b58d-30062d8bf150",
"minAmount": 0,
"maxAmount": 0,
"childModifiers": [{"guid": "66a33b80-bb09-4a41-81a0-cce502ea5a76",
"minAmount": 0,
"maxAmount": 0,
"defaultAmount": 1
}
]
}
]
}
]

Response samples

200

Content type

application/json

{"status": 200
}

/loyaltydata/remaining-amounts/change

Authorizations:

None

Request Body schema: application/json

Array

guid	string <GUID> Глобальный идентификатор категории
allowedForSale	boolean Товар доступен к продаже

Responses

Request samples

Payload

Content type

application/json

[{"guid": "d20d4ecb-2eed-4dc2-a17e-9e6fa3b21278",
"allowedForSale": false
}
]

Response samples

200

Content type

application/json

{"status": 200
}

/loyaltydata/discounts/update

Authorizations:

None

Request Body schema: application/json

Array

guid	string <GUID> Глобальный идентификатор скидки
name	string Название скидки
deleted	boolean Флаг удаления
isActive	boolean Активность
isAutomatic	boolean Автоматическая скидка
canApplyManually	boolean Можно применять вручную
canApplyByCardNumber	boolean Можно применять по номеру карты
discountByFlexibleSum	boolean Можно назначить произвольную сумму
canApplyByDiscountCard	boolean Можно добавить по дисконстной карте
canApplySelectively	boolean Можно назначать выборочно на блюда

Responses

Request samples

Payload

Content type

application/json

[{"guid": "3f662a68-74d7-4b3c-ab04-18d4ce57295d",
"name": "Remarked",
"deleted": false,
"isActive": true,
"isAutomatic": false,
"canApplyManually": true,
"canApplyByCardNumber": false,
"discountByFlexibleSum": true,
"canApplyByDiscountCard": true,
"canApplySelectively": true
}
]

Response samples

200

Content type

application/json

{"status": 200
}

/loyaltydata/paymenttypes/update

Authorizations:

None

Request Body schema: application/json

Array

guid	string <GUID> Глобальный идентификатор типа оплаты
name	string Название типа оплаты
CanBeExternalProcessed	boolean Может использоваться внешними системами
CanDisplayChange	boolean Автоматически подставлять сумму для закрытия заказа
DiscountType	string or null <GUID> Идентификатор скидки прикреплёной к типу оплаты
FiscalizeAsDiscount	boolean Фискализовать как скидку
IsCombinable	boolean Комбинируется с другими типами оплаты
IsEnabled	boolean Активность
IsHidden	boolean Тип скрыт от пользователей
Kind	enum Enum: "Unknown" "Cash" "Card" "Credit" "Writeoff" "Voucher" "External" "SmartSale" "Sberbank" "Trpos" Тип типа оплаты
OpenCashDrawerOnPay	boolean Открывать денежный ящик
PrintCheque	boolean Фискализуемый
ProcessAsDiscount	boolean Проводить как скидку

Responses

Request samples

Payload

Content type

application/json

[{"guid": "3f662a68-74d7-4b3c-ab04-18d4ce57295d",
"name": "Remarked",
"CanBeExternalProcessed": false,
"CanDisplayChange": true,
"DiscountType": "3f662a68-74d7-4b3c-ab04-18d4ce57295d",
"FiscalizeAsDiscount": true,
"IsCombinable": false,
"IsEnabled": true,
"IsHidden": true,
"Kind": "Cash",
"OpenCashDrawerOnPay": true,
"PrintCheque": true,
"ProcessAsDiscount": true
}
]

Response samples

200

Content type

application/json

{"status": 200
}

Loyalty

/loyalty/guest/get

Authorizations:

None

Request Body schema: application/json

Any of

id	integer Внутренний идентификатор гостя

Responses

Request samples

Payload

Content type

application/json

Example

ID

{"id": 40404100
}

Response samples

200

Content type

application/json

{"id": 40404100,
"phone": "+71234567890",
"email": "iivanov@gmail.com",
"surname": "Иванов",
"name": "Иван",
"cards": ["12345678"
],
"total_balance": 500
}

/loyalty/guest/add

Authorizations:

None

Request Body schema: application/json

surname	string Фамилия
name	string Имя
patronymic	string Отчество
phone	string Номер телефона
email	string Email адрес
birthday	string <date> Дата рождения
gender	enum Enum: "male" "female" Пол

Responses

Request samples

Payload

Content type

application/json

{"surname": "Иванов",
"name": "Иван",
"patronymic": "Иванович",
"phone": "+71234567890",
"email": "iivanov@gmail.com",
"birthday": "1998-01-23",
"gender": "male"
}

Response samples

200

Content type

application/json

{"id": 40404100,
"phone": "+71234567890",
"email": "iivanov@gmail.com",
"surname": "Иванов",
"name": "Иван",
"cards": ["12345678"
],
"total_balance": 500,
"gender": "old"
}

/loyalty/order/update

Authorizations:

None

Request Body schema: application/json

guest_id	integer Внутренний идентификатор гостя в системе лояльности
	object Объект заказа

Responses

Request samples

Payload

Content type

application/json

{"guest_id": 40404100,
"order": {"guid": "ee8a7810-c07d-4412-aeeb-caffe67135eb",
"created_at": "2023-08-03 14:15:55",
"sum": 200.25,
"promocodes": ["PROM"
],
"certificates": {"for_sale": [{"id": 123456,
"guid": "4fe37f82-87e1-44b8-beae-54f8cbd49632"
}
],
"for_use": [{"id": 123456,
"dishes": ["2515a3d4-bad2-4866-99dd-cc53654a5ed0"
]
}
]
},
"items": [{"guid": "4fe37f82-87e1-44b8-beae-54f8cbd49632",
"product_guid": "fdfd7947-f3e3-4fc5-b820-b08250f1b8fd",
"count": 1.5,
"price": 150.5,
"discounts": [{"guid": "64a26747-8dc8-44b2-81b0-af86750e7c2b",
"sum": 25.5
}
],
"gift": false
}
]
}
}

Response samples

200

Content type

application/json

{"guest_id": 40404100,
"order": {"guid": "ee8a7810-c07d-4412-aeeb-caffe67135eb",
"created_at": "2023-08-03 14:15:55",
"sum": 200.25,
"promocodes": ["PROM"
],
"certificates": {"for_sale": [{"id": 123456,
"guid": "4fe37f82-87e1-44b8-beae-54f8cbd49632"
}
],
"for_use": [{"id": 123456,
"dishes": ["2515a3d4-bad2-4866-99dd-cc53654a5ed0"
]
}
]
},
"items": [{"guid": "4fe37f82-87e1-44b8-beae-54f8cbd49632",
"product_guid": "fdfd7947-f3e3-4fc5-b820-b08250f1b8fd",
"count": 1.5,
"price": 150.5,
"discounts": [{"guid": "64a26747-8dc8-44b2-81b0-af86750e7c2b",
"sum": 25.5
}
],
"gift": false
}
],
"promocode_status": {"status": "error",
"error": "not found",
"promo": "NY24",
"message": "Промокод не найден"
},
"certificate_status": {"status": "error",
"error": "not found",
"id": 123456,
"message": "Промокод не найден"
}
},
"withdraw_bonus_limit": 100,
"withdraw_bonus_sum": 10,
"refill_bonus_sum": 25,
"show_info": {"popup": {"message": "Выводимый текст",
"type": "warning"
},
"windows": {"title": "Заголовок",
"message": "Выводимый текст"
}
}
}

/loyalty/order/bill

Authorizations:

None

Request Body schema: application/json

guest_id	integer Внутренний идентификатор гостя в системе лояльности
withdraw_bonuses	integer Бонусы которые гость хочет списать
	object Объект заказа

Responses

Request samples

Payload

Content type

application/json

{"guest_id": 40404100,
"withdraw_bonuses": 20,
"order": {"guid": "ee8a7810-c07d-4412-aeeb-caffe67135eb",
"created_at": "2023-08-03 14:15:55",
"sum": 200.25,
"promocodes": ["PROM"
],
"certificates": {"for_sale": [{"id": 123456,
"guid": "4fe37f82-87e1-44b8-beae-54f8cbd49632"
}
],
"for_use": [{"id": 123456,
"dishes": ["2515a3d4-bad2-4866-99dd-cc53654a5ed0"
]
}
]
},
"items": [{"guid": "4fe37f82-87e1-44b8-beae-54f8cbd49632",
"product_guid": "fdfd7947-f3e3-4fc5-b820-b08250f1b8fd",
"count": 1.5,
"price": 150.5,
"discounts": [{"guid": "64a26747-8dc8-44b2-81b0-af86750e7c2b",
"sum": 25.5
}
],
"gift": false
}
]
}
}

Response samples

200

Content type

application/json

{"check": {"text": "Очень важный текст, поясняющий QR",
"qr": "https://remarked.ru/"
},
"show_info": {"popup": {"message": "Выводимый текст",
"type": "warning"
},
"windows": {"title": "Заголовок",
"message": "Выводимый текст"
}
}
}

/loyalty/transaction/makeorupdate

Authorizations:

None

Request Body schema: application/json

transaction_id	integer Внутренний идентификатор транзакции
master_order_guid	string <GUID> Внешний идентификатор заказа если он был разделён в режиме 2 ФР
guest_id	integer Внутренний идентификатор гостя в системе лояльности
withdraw_bonuses	integer Бонусы которые гость хочет списать
	object Объект заказа

Responses

Request samples

Payload

Content type

application/json

{"transaction_id": 123456,
"master_order_guid": "383b5a58-acf7-4dc9-8d69-1e9825b7266c",
"guest_id": 40404100,
"withdraw_bonuses": 20,
"order": {"guid": "ee8a7810-c07d-4412-aeeb-caffe67135eb",
"created_at": "2023-08-03 14:15:55",
"sum": 200.25,
"promocodes": ["PROM"
],
"certificates": {"for_sale": [{"id": 123456,
"guid": "4fe37f82-87e1-44b8-beae-54f8cbd49632"
}
],
"for_use": [{"id": 123456,
"dishes": ["2515a3d4-bad2-4866-99dd-cc53654a5ed0"
]
}
]
},
"items": [{"guid": "4fe37f82-87e1-44b8-beae-54f8cbd49632",
"product_guid": "fdfd7947-f3e3-4fc5-b820-b08250f1b8fd",
"count": 1.5,
"price": 150.5,
"discounts": [{"guid": "64a26747-8dc8-44b2-81b0-af86750e7c2b",
"sum": 25.5
}
],
"gift": false
}
]
}
}

Response samples

200

Content type

application/json

{"transaction_id": 123456,
"check": {"text": "Очень важный текст, поясняющий QR",
"qr": "https://remarked.ru/"
},
"show_info": {"popup": {"message": "Выводимый текст",
"type": "warning"
},
"windows": {"title": "Заголовок",
"message": "Выводимый текст"
}
}
}

/loyalty/transaction/confirm

Authorizations:

None

Request Body schema: application/json

transaction_id	integer Внутренний идентификатор транзакции
	Array of objects Массив типов оплаты использованных в заказе

Responses

Request samples

Payload

Content type

application/json

{"transaction_id": 123456,
"payments": [{"guid": "7305cd07-ecac-4b93-ad30-6d77acd0f1cb",
"sum": 520.5
}
]
}

Response samples

200

Content type

application/json

{"transaction_id": 123456
}

/loyalty/transaction/rollback

Authorizations:

None

Request Body schema: application/json

transaction_id

integer

Внутренний идентификатор транзакции

Responses

Request samples

Payload

Content type

application/json

{"transaction_id": 123456
}

Response samples

200

Content type

application/json

{"transaction_id": 123456
}

/loyalty/certificate/get

Authorizations:

None

Request Body schema: application/json

search_data	string Данные для поиска сертификата
for_sale	boolean Сертификат запрашивается для продажи

Responses

Request samples

Payload

Content type

application/json

{"search_data": "123456",
"for_sale": true
}

Response samples

200

Content type

application/json

{"id": 123456,
"title": "Тестовый сертификат",
"type": "money",
"nominal": 123456,
"dishes": [{"guid": "e33498e4-1561-4b2d-87f9-b11fdaac1e3e",
"name": "Яблочный пирог"
}
],
"dish_multiselect": true,
"for_sale": true
}