Начните поиск...

Создать запись в салон по API

Запрос позволяет создать в СБИС запись к мастеру в салон на основе данных во внешней системе.

Метод запроса: POST

Адрес запроса: https://api.sbis.ru/retail/order/create?

Структура запроса
Примеры

Структура запроса

Пример в формате *.php

Пример запроса в формате *.py

В качестве примера используется функция «cURL».

В качестве примера используется библиотека «Requests».

Параметр	Тип	Описание
product*	string	Постоянное значение параметра — «salon»
pointId*	string	Идентификатор точки продаж, который вернулся в результате запроса «Получить точку продаж»
comment	string	Примечание к заказу
customer*	array[{...}]	Информация о покупателе
datetime*	string	Дата и время, на которое создается заказ, в формате гггг-мм-дд чч:мм:сс
nomenclatures	array[{...}]	Номенклатура заказа. Кроме указанных обязательных полей, необходимо указывать один из трех идентификаторов номенклатуры(externalId, id или nomNumber), также желательно указывать hierarchicalId.
visit	array[{...}]	Информация записи
Структура «customer»
externalId	string	Данные покупателя
name*	string
lastname	string
patronymic	string
email	string
phone	string
Структура «nomenclatures»
externalId	string	Внешний идентификатор номенклатурной позиции
id	integer	Сквозной идентификатор внешней системы
nomNumber	string	Сквозной идентификатор внешней системы
count*	number	Количество позиций
cost	number	Цена за одну позицию. Вы можете указать цену, отличную от той, что установлена в СБИС
name	string	Наименование позиции
modifiers	array[{...}]	Информация о модификаторах
Структура «visit»
master*	integer	Внутренний идентификатор мастера. Значение параметра возвращается в запросе «Получить список мастеров»
reminder	integer	За какое время до назначенного визита отправлять напоминание
datetimeEnd	string	Время окончания записи
Структура «modifiers»
externalId	string	Внешний идентификатор модификатора
id	integer	Внутренний идентификатор модификатора
nomNumber	string	Сквозной идентификатор внешней системы
hierarchicalId	integer	Идентификатор в иерархии
count	integer	Количество позиций модификатора

С помощью API-запросов вы можете получить информацию о записи в салон, узнать ее статус, обновить, удалить или отменить запись.

Запросить информацию о записи:
- метод: GET
- запрос: https://api.sbis.ru/retail/order/{externalId}, где {externalId} — идентификатор записи.
Изменить запись:
- метод: PUT
- запрос: https://api.sbis.ru/retail/order/{externalId}/update, где {externalId} — идентификатор записи. Отправьте всю информацию по записи вместе с измененными данными.
Отменить запись:
- метод: PUT
- запрос: https://api.sbis.ru/retail/order/{externalId}/cancel, где {externalId} — идентификатор записи.
Удалить запись:
- метод: PUT
- запрос: https://api.sbis.ru/retail/order/{externalId}/delete, где {externalId} — идентификатор записи.
Узнать статус записи:
- метод:
  GET
- запрос: https://api.sbis.ru/retail/order/{externalId}/state, где {externalId} — идентификатор записи.

В ответ вы получите

Имя поля	Тип	Описание
state	integer	Статус записи
payments	array[{...}]	Информация об оплате
Структура «Payments»
amount	number	Сумма, на которую была оплата
paymentType	string	Тип оплаты
isClosed	boolean	Принимает значение «true», если оплата прошла корректно
errorMessage	string	В случае некорректной оплаты выводится описание ошибки

Запросить ссылку на оплату записи в салон. Для этого должны быть включены интернет-платежи.
- метод:GET
- запрос: https://api.sbis.ru/retail/order/{externalId}/payment-link, где {externalId} - идентификатор записи.

Параметры запроса

Параметр	Тип	Описание
externalId *	string	Идентификатор записи в салон
shopURL*	string	URL, с которого производится вызов
successURL	string	URL для перехода при успехе
errorURL	string	URL для перехода при неудаче

В ответ вы получите

Параметр	Тип	Описание
link	string	Ссылка на запись

Примеры

Пример записи в салон

Пример получения статуса записи

Пример получения ссылки на оплату

Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.