Перейти к основному содержанию
POST
/
order
/
refuse
Refuse order (refund)
curl --request POST \
  --url https://api.example.com/order/refuse \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": 123,
  "time": "<string>",
  "cashier": "<string>",
  "qr_code": "<string>",
  "received_cash": 123,
  "received_card": 123,
  "change": 123,
  "card_type": 123,
  "ppt_id": "<string>",
  "products": [
    {
      "name": "<string>",
      "barcode": "<string>",
      "amount": 123,
      "unit_name": "<string>",
      "price": 123,
      "product_price": 123,
      "vat": 123,
      "vat_percent": 123,
      "discount": 123,
      "discount_percent": 123,
      "other": 123,
      "class_code": "<string>",
      "package_code": 123,
      "owner_type": 123,
      "labels": [
        "05367567230048c?eN1(o0029"
      ],
      "comission_info": [
        {
          "inn": "<string>",
          "pinfl": "<unknown>"
        }
      ]
    }
  ],
  "prices": [
    {
      "name": "<string>",
      "price": 123,
      "vat_type": "<string>",
      "vat_price": 123
    }
  ],
  "uuid": "<string>",
  "extra_info": [
    {
      "phone_number": "<string>",
      "qr_payment_id": "<string>",
      "qr_payment_provider": "<string>"
    }
  ],
  "send_email": false,
  "email": "<string>",
  "sms_phone_number": "+998712565009"
}
'
{
  "data": {
    "terminal_id": "<string>",
    "receipt_count": 123,
    "date_time": "<string>",
    "fiscal_sign": "<string>",
    "applet_version": "<string>",
    "qr_url": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": 123,
    "data": "<string>"
  },
  "is_success": true
}

Обзор

Order Refuse API используется для выполнения возврата по существующему заказу. Эндпоинт регистрирует фискальный возврат, пересчитывает суммы по товарам, and returns fiscal information such as receipt number and QR code. Авторизация не требуется.

Поля запроса

Основные поля

ПолеТипОбяз.Описание
numberintegerOrder number or ID
uuidstringUnique request identifier
qr_codestringLink to original receipt
timestringTime in format yyyy-MM-dd HH:mm:ss
cashierstringCashier name
received_cashintegerReceived cash amount ×100
changeintegerChange amount ×100
received_cardintegerReceived card amount ×100
card_typeintegerCard type identifier
ppt_idstringPOS terminal ID
send_emailbooleanSend receipt by email
emailstringEmail for receipt
sms_phone_numberstringPhone number for SMS receipt

Товары

ПолеТипОбяз.Описание
namestringProduct name
barcodestringProduct barcode
amountintegerQuantity ×1000
unit_namestringUnit name
priceintegerTotal price
product_pricenumberUnit price ×100
vatnumberVAT amount ×100
vat_percentnumberVAT percent
discountnumberDiscount amount ×100
discount_percentnumberDiscount percent
othernumberOther discounts ×100
class_codestringProduct class code
labelsarrayMarking codes
package_codeintegerPackage code
owner_typeintegerOwner type

Дополнительные данные

ПолеТипОбяз.Описание
phone_numberstringClient phone number
qr_payment_idstringQR payment ID
qr_payment_providerstringQR payment provider

Цены

ПолеТипОбяз.Описание
namestringPayment method name
priceintegerAmount ×100
vat_typestringVAT type
vat_priceintegerVAT amount ×100

Поля ответа

✅ Успешный ответ 200

ПолеТипОписание
data.terminal_idstringTerminal ID
data.receipt_countintegerReceipt count (Z-report)
data.date_timestringFiscal date-time
data.fiscal_signstringFiscal sign
data.applet_versionstringApplet version
data.qr_urlstringQR code URL
data.cash_box_numberstringCash box number
errornullAlways null
is_successbooleanAlways true

🚫 Ответ с ошибкой

ПолеТипОписание
datanullNo data
error.codeintegerError code
error.messagestringError message
error.datastring | nullExtra error info
is_successbooleanAlways false

Частые коды ошибок

КодОписание
65275Refund info is not valid
102Fiscal module not initialized

Тело

application/json
number
integer
обязательно
time
string
обязательно
cashier
string
обязательно
qr_code
string
обязательно
received_cash
integer
обязательно
received_card
integer
обязательно
change
integer
обязательно
card_type
integer
обязательно
ppt_id
string
обязательно
products
object[]
обязательно
prices
object[]
обязательно
uuid
string
extra_info
object[]
send_email
boolean
по умолчанию:false
email
string
sms_phone_number
string
Пример:

"+998712565009"

Ответ

200 - application/json

Refund processed

data
object
error
object
is_success
boolean