REST API ​

Используемый протокол передачи данных — HTTPS.

Используемый формат обмена данными — JSON.

Все передаваемые параметры обязательны, если в описании не указано, что параметр необязательный.

bookkeeping authorization ​

POST /bookkeeping/refresh — запрос предназначен для обновления токена доступа ​

Request (запрос):

Примерное значение body:

{
  "jwt": "string"
}

Responses (ответы):

• Код 201 — успешная операция. Примерное значение:

{
  "jwt": "string"
}

Имя — Set-Cookie.

• Код 400

• Код 500 — внутренняя ошибка сервера.

bookkeeping (обработка заказов) ​

В этом подразделе описываются запросы для обработки прямых заказов, создаваемых в вэб-приложении «Заказы» или в мобильном приложении «Takwot.Заказы».

PUT /bookkeeping/providers/{providerid}/orders/{ordersid} — запрос предназначен для отправки обработанных заказов из учетной системы в веб-сервис. Например, запрос может передавать измененный заказ после его обработки ​

Request (запрос):

Примерное значение body:

{
  "comments": "string",
  "currency": 0,
  "delivery": "string",
  "items": [
    {
      "amount": "string",
      "coefficient": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "price": "string",
      "sum": "string",
      "unit": "string",
      "unitid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "status": "string",
  "status_name": "string",
  "tid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "total": "string"
}

Responses (ответы):

• Код 204 — успешная операция.
• Код 400 — некорректный запрос, информация об ошибке указывается в теле ответа. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 403 — доступ запрещен;

• Код 404 — заказ не найден;

• Код 409 — заказ дублируется, заказ принадлежит другому поставщику, статус заказа защищен;

• Код 500 — внутренняя ошибка сервера.

PUT /bookkeeping/providers/{providerid}/vendors/{vendorid} — запрос предназначен для обновления данных о клиенте (заказчике) на сервере ​

Request (запрос):

Примерное значение body:

{
  "address": "string",
  "comments": "string",
  "name": "string",
  "phones": [
    "string"
  ],
  "pricetypeid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workschedule": {
    "list": [
      {
        "since": 0,
        "till": 0
      }
    ],
    "offset": 0
  }
}

Responses (ответы):

• Код 201 — ProviderVendorSave. Данные о клиенте (заказчике) обновлены;

• Код 400 — некорректный запрос, информация об ошибке указывается в теле ответа. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 403 — доступ запрещен;

• Код 404 — клиент (заказачик) не найден;

• Код 500 — внутренняя ошибка сервера.

POST /bookkeeping/providers/{providerid}/catalogs — запрос предназначен для загрузки каталогов заказов выбранного поставщика ​

Request (запрос):

Примерное значение body:

{
  "hidden": true,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "parent": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "period": [
    0
  ]
}

Responses (ответы):

• Код 201

• Код 400 — некорректный запрос, информация об ошибке указывается в теле ответа. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 403 — доступ запрещен;

• Код 409 — дубликаты записей, уровней каталога более двух. Информация об ошибке указывается в теле ответа. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 500 — внутренняя ошибка сервера.

POST /bookkeeping/providers/{providerid}/catalogs/{catalogid}/products — запрос предназначен для добавления выбранных товаров в каталог ​

Request (запрос):

Примерное значение body:

[
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
]

Responses (ответы):

• Код 204

• Код 400 — некорректный запрос, информация об ошибке указывается в теле ответа. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 403 — доступ запрещен;

• Код 500 — внутренняя ошибка сервера.

POST /bookkeeping/providers/{providerid}/ostatus/{status} — список заказов, созданных для выбранного поставщика ​

Список ограничен 25 заказами, для следующего списка используйте параметр next.

Request (запрос):

Responses (ответы):

• Код 204 — успешная операция;

• Код 400 — некорректный запрос, информация об ошибке указывается в теле ответа. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 403 — доступ запрещен;

• Код 404 — заказ не найден;

• Код 409 — заказ принадлежит другому поставщику. Статус документа защищен.

• Код 500 — внутренняя ошибка сервера.

POST /bookkeeping/providers/{providerid}/prices — запрос предназначен для загрузки цен на продукцию поставщиков ​

Request (запрос):

Примерное значение body:

[
  {
    "price": "string",
    "pricetypeid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "productid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
]

Responses (ответы):

• Код 204 — успешная операция;

• Код 400 — некорректный запрос, информация об ошибке указывается в теле ответа. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 403 — доступ запрещен;

• Код 404 — неизвестный продукт. Тип цены неизвестного поставщика. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 500 — внутренняя ошибка сервера.

POST /bookkeeping/providers/{providerid}/pricetypes — запрос предназначен для загрузки типов цен поставщиков ​

Request (запрос):

Примерное значение body:

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  }
]

Responses (ответы):

• Код 204 — успешная операция;

• Код 400 — некорректный запрос, информация об ошибке указывается в теле ответа. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 403 — доступ запрещен;

• Код 404 — неизвестный поставщик. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 500 — внутренняя ошибка сервера.

POST /bookkeeping/providers/{providerid}/products — запрос предназначен для загрузки партии продуктов ​

Request (запрос):

Примерное значение body:

[
  {
    "balance": "string",
    "barcode": "string",
    "comments": "string",
    "hidden": true,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "price": "string"
  }
]

Responses (ответы):

• Код 204 — успешная операция;

• Код 400 — некорректный запрос, информация об ошибке указывается в теле ответа. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 403 — доступ запрещен;

• Код 500 — внутренняя ошибка сервера.

POST /bookkeeping/providers/{providerid}/products/{productid}/image — запрос предназначен для загрузки нового изображения продукта ​

Request (запрос):

Responses (ответы):

• Код 201

Примерное значение:

{
  "id": "string",
  "productid": "string"
}

• Код 400 — переданные данные серверу невалидные. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 404 — неизвестный продукт. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 500 — внутренняя ошибка сервера.

POST /bookkeeping/providers/{providerid}/stock — запрос предназначен для поставки товара на склад ​

Request (запрос):

[
  {
    "amount": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
]

Responses (ответы):

• Код 204 — успешная операция;

• Код 400 — некорректный запрос, информация об ошибке указывается в теле ответа. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 403 — доступ запрещен;

• Код 404 — неизвестный продукт. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 500 — внутренняя ошибка сервера.

POST /bookkeeping/providers/{providerid}/units — запрос предназначен для загрузки единиц измерения для выбранного поставщика ​

Request (запрос):

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "short": "string"
  }
]

Responses (ответы):

• Код 204 — успешная операция;

• Код 400 — некорректный запрос, информация об ошибке указывается в теле ответа. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 403 — доступ запрещен;

• Код 500 — внутренняя ошибка сервера.

POST /bookkeeping/providers/{providerid}/units/products — запрос предназначен для загрузки единиц измерения нескольких продуктов ​

Единицы будут заменены новыми значениями или удалены, если ни одна единица не была передана. Для сброса единицы продукта до значения «по умолчанию» ключ единицы измерения продукта должен быть default или остаться пустым.

Request (запрос):

[
  {
    "default": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "product": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "units": [
      {
        "coefficient": {},
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ]
  }
]

Responses (ответы):

• Код 204 — успешная операция;

• Код 400 — некорректный запрос, информация об ошибке указывается в теле ответа. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 403 — доступ запрещен;

• Код 404 — неизвестный продукт, единица измерения по умолчанию, единица измерения. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 500 — внутренняя ошибка сервера.

POST /bookkeeping/providers/{providerid}/vendors — запрос предназначен для создания нового поставщика ​

Request (запрос):

{
  "address": "string",
  "comments": "string",
  "name": "string",
  "phones": [
    "string"
  ],
  "pricetypeid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workschedule": {
    "list": [
      {
        "since": 0,
        "till": 0
      }
    ],
    "offset": 0
  }
}

Responses (ответы):

• Код 201 — поставщик создан. ProviderVendorSave представляет данные о поставщике;

• Код 400 — некорректный запрос, информация об ошибке указывается в теле ответа. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 403 — доступ запрещен;

• Код 404 — неизвестный поставщик;

• Код 409 — названный поставщик существует. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 500 — внутренняя ошибка сервера.

GET /bookkeeping/providers/{providerid}/orders — запрос предназначен для получения списка заказов из веб-сервиса. ​

Список ограничен 25 заказами, для следующего списка используйте параметр next.

Request (запрос):

Responses (ответы):

• Код 200 — успешная операция. Примерное значение:

[
  {
    "cancelled": true,
    "comments": "string",
    "created": "string",
    "currency": 0,
    "delivery": "string",
    "editable": true,
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "items": [
      {
        "amount": "string",
        "coefficient": "string",
        "price": "string",
        "product": {
          "balance": "string",
          "barcode": [
            "string"
          ],
          "comments": "string",
          "created": "string",
          "hidden": true,
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "images": [
            "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          ],
          "name": "string",
          "price": "string",
          "provider": {
            "aid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "email": "string",
            "initials": {
              "bgcolor": "string",
              "text": "string"
            },
            "name": "string",
            "phone": "string",
            "site": "string"
          },
          "updated": "string"
        },
        "sum": "string",
        "unit": "string",
        "unitid": 0
      }
    ],
    "orderer": {
      "aid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "id": 0,
      "id_str": 0,
      "initials": {
        "bgcolor": "string",
        "text": "string"
      },
      "name": "string"
    },
    "status": "string",
    "total": "string",
    "updated": "string",
    "vendor": {
      "address": "string",
      "aid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "initials": {
        "bgcolor": "string",
        "text": "string"
      },
      "name": "string",
      "pid": 0,
      "pid_str": 0
    }
  }
]

• Код 204 — пустой список;

• Код 400 — некорректный запрос, информация об ошибке указывается в теле ответа. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 403 — доступ запрещен;

• Код 500 — внутренняя ошибка сервера.

GET /bookkeeping/providers/{providerid}/products/{productid}/image — запрос предназначен для получения идентификаторов всех изображений, привязанных к товару ​

Request (запрос):

Responses (ответы):

• Код 200

• Код 204 — нет изображений;

• Код 400 — Переданные данные серверу невалидные. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 404 — неизвестный продукт. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 500 — внутренняя ошибка сервера.

GET /bookkeeping/providers/{providerid}/vencons — returns vendor's consumers ​

Request (запрос):

Responses (ответы):

• Код 200 — успешная операция;

• Код 204 — пустой список;

• Код 400 — некорректный запрос. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 403 — доступ запрещен;

• Код 500 — внутренняя ошибка сервера.

GET /bookkeeping/providers/{providerid}/vendors — returns provider's vendors ​

Request (запрос):

Responses (ответы):

• Код 200 — успешная операция. Примерное значение:

{
  "list": [
    {
      "address": "string",
      "aid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "comments": "string",
      "id": "string",
      "initials": {
        "bgcolor": "string",
        "text": "string"
      },
      "name": "string",
      "phones": [
        "string"
      ],
      "provider": {
        "aid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "email": "string",
        "initials": {
          "bgcolor": "string",
          "text": "string"
        },
        "name": "string",
        "phone": "string",
        "site": "string"
      },
      "workschedule": {
        "list": [
          {
            "since": 0,
            "till": 0
          }
        ],
        "offset": 0
      }
    }
  ]
}

• Код 204 — пустой список;

• Код 500 — внутренняя ошибка сервера.

GET /bookkeeping/version — запрос предназначен для получения версии модуля подключения для 1С и текущей версии REST API ​

Запрос с пустым параметром запроса name возвращает текущее значение версии REST API.

Request (запрос):

Responses (ответы):

• Код 200 — успешная операция. Примерное значение: string;

• Код 400 — некорректный запрос. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 404 — неизвестный модуль;

• Код 500 — внутренняя ошибка сервера.

DELETE /bookkeeping/providers/{providerid}/products/{productid}/image/{imageid} — запрос предназначен для удаления прикрепленного к продукту изображения ​

Request (запрос):

Responses (ответы):

• Код 204 — успешная операция;

• Код 400 — переданные серверу данные невалидные. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 404 — неизвестное изображение. Примерное значение:

{
  "field": "string",
  "message": "string",
  "value": "string"
}

• Код 500 — внутренняя ошибка сервера.