assignment_returnReturns. Возвраты поставщику

Метод возвращает документы «Возврат поставщику» вместе со строками. Документы можно только читать: создание и изменение через API не поддерживаются.

Все параметры, кроме ключа apikey и формата format, принимаются и в адресной строке, и в теле POST.

GET https://[компания].myvirtualpos.ru/api/returns?apikey=MySecret&days=90&warehouse_id=6&withitems=1

Условия объединяются по «и». Даты передаются строго в формате ГГГГММДД, иначе метод вернёт ошибку Incorrect date format. Документы возвращаются по убыванию id: новые первыми.

Пустые значения в JSON приходят как null, в XML — как пустой элемент.

{
  "success": 1,
  "type": "returns",
  "days_limit": 90,
  "count": 1,
  "returns": [
    {
      "return": {
        "id": 224,
        "external_id": "RET-224",
        "guid": "4DDE87A3-8AC7-DD60-2E7D-1DA863679BF7",
        "warehouse_id": 7,
        "docnum": "28.08.26",
        "docdate": "2026-08-28 00:00:00",
        "supplier_id": 2,
        "supplier_name": "Мой поставщик",
        "supplier_inn": "7805492189",
        "supplier_kpp": "780501001",
        "supplier_type": 2,
        "supplier_type_name": "Внешний поставщик",
        "supplier_readonly_inflow": 0,
        "amount": "3500.00",
        "status": "accept",
        "status_name": "Принят",
        "comment": "Брак",
        "supplier_external_id": "S-2",
        "warehouse_external_id": "WH-7",
        "created_date": "2026-08-28 13:58:22",
        "created_by": 23,
        "last_update_date": "2026-08-28 14:21:27",
        "last_update_by": 23,
        "items": [
          {
            "item": {
              "line_id": 4927,
              "guid": "5AEEE85D-A100-D900-6A0E-D7BD519F60AE",
              "item_id": 34622,
              "item_ext_id": "SKU-34622",
              "item_name": "Шампунь для глубокого очищения 1000 мл",
              "quantity": "1.000",
              "barcode": null,
              "price": "1250.0000",
              "amount": "1250.00",
              "manuf_date": "0000-00-00",
              "expir_date": "0000-00-00",
              "lot_number": ""
            }
          }
        ]
      }
    }
  ]
}

Тот же ответ при format=xml (сокращённо):

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>1</success>
  <type>returns</type>
  <days_limit>90</days_limit>
  <count>1</count>
  <returns>
    <return>
      <id>224</id>
      <status>accept</status>
      <!-- остальные поля шапки -->
      <items>
        <item>
          <line_id>4927</line_id>
          <item_id>34622</item_id>
          <quantity>1.000</quantity>
          <!-- остальные поля строки -->
        </item>
      </items>
    </return>
  </returns>
</root>

Ошибка авторизации и общие ошибки описаны в статье Общие сведения.

Если по условиям ничего не найдено, метод возвращает успешный ответ с count равным 0 и пустым списком returns.