Возврат покупки

Метод осуществляет возврат покупки произведенной ранее c системой лояльности Bonus Money.

Запрос:

POST: https://api.bm-app.com/setReturnSellDocument

Description

documentId: (string, required) - идентификатор документа возврата (как правило UUID) во внешней системе, уникальный
documentNumber: (string, optional) - номер документа продажи во внешней системе
documentTimestamp: (string, optional) - время заказа во внешней системе
initialDocumentId: (string, required) - идентификатор первоначального документа продажи (как правило UUID) во внешней системе, уникальный

positions: (object, required) - массив позиций чека/заказа
externalUnitId: (string, required) - идентификатор позиции во внешней системе, как правило UUID
quantity: (number, required) - количество позиции чека
price: (number, required) - цена продажи без скидки 1 ед. измерения
externalDiscount: (number, required) - внешняя скидка на позицию, т.е. сумма скидки на 1 ед. измерения позиции
name: (string, required) - название позиции во внешней системе

Headers

BM-ApiKey: token

Body

{
"positions": [
{
"unitId": 0,
"externalDiscount": 0,
"externalUnitId": "77dc81d7-d1ea-11ea-a84b-dc71969d339c",
"name": "Вода",
"quantity": 1,
"price": 50
}
],
"initialDocumentId": "99678f31-c0a3-4d54-8d6f-de1a527dffb",
"documentId": "7a678f31-c0a3-4d54-8d6f-de1a527cdfb",
"documentNumber": "112",
"documentTimestamp":"2021-04-02 16:30:00",
}

Ответ:

Body:

{
"status": "ok"
}

При выполнении запросов возможно получение следующих ошибок:

  • HTTP Status 503 Превышено максимальное число запросов в секунду
  • HTTP Status 413 Превышен максимальный размер тела запроса
  • HTTP Status 401 API ключ не найден
  • HTTP Status 402 Система Bonus Money не оплачена или закончилось число транзакций предусмотренное тарифом
  • HTTP Status 400 Некорректный запрос, описание ошибки присылается в теле ответа в формате Json, доступное по ключу: message