Товарные позиции

Позиции работают строго в привязке к конкретному документу — document_id обязателен в каждом запросе.

Важно

Построчное изменение позиций документа (количество, цены) через публичный API недоступно — у строк документа много расчётных колонок (суммы, скидки, итоги НДС), которые считает приложение. Отредактировать позиции можно в самом FreshOffice. Удаление позиций через API также недоступно.

Список позиций документа

GET https://do.freshoffice.ru/document/goods/list?document_id=91234

Query Parameters

Name Type Description
document_id* Int ID документа

Добавление позиций из каталога

POST https://do.freshoffice.ru/document/goods/insert?document_id=91234&goods_ids=12,15,20

Добавляет в документ товары из складского каталога по их ID (найти можно в списке товаров).

Query Parameters

Name Type Description
document_id* Int ID документа
goods_ids* String ID товаров через запятую: 12,15,20

Пример

curl --location --request POST 'https://do.freshoffice.ru/document/goods/insert?document_id=91234&goods_ids=12,15' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw 'null'

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://do.freshoffice.ru/document/goods/insert?document_id=91234&goods_ids=12,15',
  'headers': {
    'Authorization': 'Bearer XXXX-XXXXXXX-XXXXXXX',
    'Content-Type': 'application/json'
  },
  body: 'null'
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Ответ

{
  "status": "success",
  "error": "",
  "code": null,
  "rows": 0,
  "pages": 0,
  "page": 0,
  "value": "1"
}
// value: 1 - выполнено, 0 - ошибка (текст в поле error)
Предыдущая
Обновление
Следующая
Финансы