Запрос позволяет создать в Saby запись к мастеру в салон на основе данных во внешней системе.
Структура запроса
Метод запроса: POST
Адрес запроса: https://api.sbis.ru/retail/order/create?
Параметр | Тип | Описание | ||
product* | string | название продукта Saby, с которым работает точка продаж. Укажите параметр salon | ||
pointId* | integer | идентификатор точки продаж, который возвращается в результате запроса «Получить точку продаж» | ||
comment | string | примечание к заказу | ||
customer* | array{...} | информация о покупателе | ||
| externalId | string | идентификатор клиента из внешней системы | |
name* | string | имя | ||
patronymic | string | отчество | ||
lastname | string | фамилия | ||
string | электронная почта | |||
phone* | string | номер телефона | ||
datetime* | string | дата и время, на которое создается заказ, в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС | ||
nomenclatures* | array[{...}] | информация о позициях в заказе | ||
| externalId** | string(uuid) | внешний идентификатор позиции. Обязателен, если не указаны id и nomNumber | |
id** | integer | сквозной идентификатор внешней системы. Обязателен, если не указаны externalId и nomNumber | ||
nomNumber** | string | идентификатор позиции в Saby. Обязателен, если не указаны externalId и id | ||
count* | number | количество позиций | ||
cost | number | цена за одну позицию. Вы можете указать цену, отличную от той, что установлена в Saby | ||
name | string | наименование позиции | ||
modifiers | array[{...}] | информация о модификаторах | ||
externalId | string | внешний идентификатор модификатора | ||
id | integer | внутренний идентификатор модификатора | ||
nomNumber | string | сквозной идентификатор внешней системы | ||
hierarchicalId | integer | идентификатор в иерархии | ||
count | integer | количество позиций модификатора | ||
visit | array{...} | информацией о записи | ||
master* | integer | внутренний идентификатор мастера. Значение параметра возвращается в запросе «Получить список мастеров» | ||
reminder | integer | за какое время до назначенного визита отправлять напоминание | ||
datetimeEnd | string | время окончания записи | ||
С помощью API-запросов вы можете получить информацию о записи в салон, узнать ее статус, обновить, удалить или отменить запись.
- Запросить информацию о записи:
- метод: GET
- запрос: https://api.sbis.ru/retail/order/{externalId}, где {externalId} — UUID записи.
- Изменить запись:
- метод: PUT
- запрос: https://api.sbis.ru/retail/order/{externalId}/update, где {externalId} — UUID записи. Отправьте всю информацию по записи вместе с измененными данными.
- Отменить запись:
- метод: PUT
- запрос: https://api.sbis.ru/retail/order/{externalId}/cancel, где {externalId} — UUID записи.
- Удалить запись:
- метод: PUT
- запрос: https://api.sbis.ru/retail/order/{externalId}/delete, где {externalId} — UUID записи.
- Узнать статус записи:
- метод: GET
- запрос: https://api.sbis.ru/retail/order/{externalId}/state, где {externalId} — UUID записи.
- Узнать статус нескольких записей:
- метод: GET
- запрос: https://api.sbis.ru/retail/order/state?externalIds=[{externalId}...], где {externalId} — UUID заказа.
- Запросить ссылку на оплату записи в салон. Для этого должны быть включены интернет-платежи.
- метод:GET
- запрос: https://api.sbis.ru/retail/order/{externalId}/payment-link, где {externalId} - UUID записи.
Параметры ответа
Параметр | Тип | Описание | |
| state | integer | статус записи. Возможные значения | |
| payState | integer | статус оплаты по записи. Возможные значения | |
| payments | array[{...}] | информация об оплате. Актуален только для интернет-оплат | |
| amount | number | сумма, на которую была оплата | |
| paymentType | string | тип оплаты | |
| isClosed | boolean | принимает значение true, если оплата прошла корректно | |
| errorMessage | string | выводит информацию о чеке. При успешной регистрации отображаются данные чека, а в случае ошибки — ее детальное описание | |
| productState | integer | продуктовый статус записи. Возможные значения | |
Параметры запроса
Параметр | Тип | Описание |
externalId * | string | идентификатор записи в салон |
shopURL* | string | URL, с которого производится вызов |
successURL | string | URL для перехода при успехе |
errorURL | string | URL для перехода при неудаче |
Параметры ответа
Параметр | Тип | Описание |
link | string | ссылка на запись |