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

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

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

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

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

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

ПараметрТипОписание
product*stringПостоянное значение параметра — «delivery»
pointId*stringИдентификатор точки продаж, который вернулся в результате запроса «Получить точку продаж»
commentstringПримечание к заказу
customer*array[{...}]Информация о покупателе
datetime*stringДата и время, на которое создается заказ, в формате гггг-мм-дд чч:мм:сс
nomenclaturesarray[{...}]Номенклатура заказа. Кроме указанных обязательных полей, необходимо указывать один из трех идентификаторов номенклатуры(externalId, id или nomNumber), также желательно указывать hierarchicalId.
visit array[{...}]Информация записи
Структура «customer»
externalIdstringДанные покупателя
name*string
lastnamestring
patronymicstring
emailstring
phonestring
Структура «nomenclatures»
externalIdstringВнешний идентификатор номенклатурной позиции
idintegerСквозной идентификатор внешней системы
nomNumberstring
count*numberКоличество позиций
costnumberЦена за одну позицию. Вы можете указать цену, отличную от той, что установлена в СБИС
namestringНаименование позиции
modifiersarray[{...}]Информация о модификаторах
Структура «visit»
master*integerВнутренний идентификатор мастера. Значение параметра возвращается в запросе «Получить список мастеров»
reminderintegerЗа какое время до назначенного визита отправлять напоминание
datetimeEndstringВремя окончания записи
Структура «modifiers»
externalIdstringВнешний идентификатор модификатора
idintegerВнутренний идентификатор модификатора
nomNumberstringСквозной идентификатор внешней системы
hierarchicalIdintegerИдентификатор в иерархии
countintegerКоличество позиций модификатора

Дополнительные возможности при работе с записью

С помощью 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} — идентификатор записи.
  • В ответ вы получите

    Имя поляТипОписание
    stateinteger Статус записи
    paymentsarray[{...}]Информация об оплате
    Структура «Payments»
    amountnumberСумма оплаты
    paymentTypestringТип оплаты
    isClosedbooleanПринимает значение «true», если оплата прошла корректно
    errorMessagestringВ случае некорректной оплаты выводится описание ошибки
  • Запросить ссылку на оплату записи в салон. Запрос возможен, если в СБИС настроены интернет-платежи.
    • метод: GET
    • запрос: https://api.sbis.ru/retail/order/{externalId}/payment-link, где {externalId} - идентификатор записи.
  • Параметры запроса

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

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

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

Примеры

Пример запроса

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

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

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

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