Download OpenAPI specification:
Вернет коллекцию изделий, отфильтрованную по параметрам, переданным в запросе. Возвращаются только опубликованные изделия.
Фильтры поиска изделий
| page | integer (page) >= 1 Default: 1 Номер страницы. itemsLimit = 10000 maxPage = (itemsLimit - itemsPerPage) / itemsPerPage. Если будет передано нулевое или отрицательное значение, page примет default значение. (внедряется в проекте постепенно) |
| itemsPerPage | integer (itemsPerPage) [ 1 .. 100 ] Default: 20 Количество элементов на странице Если будет передано нулевое или отрицательное значение, itemsPerPage примет default значение. (внедряется в проекте постепенно) |
| search | string Поиск по строке. Если в строке указано целочисленное значение, то поиск производится по точному совпадению UIN.
Для остальных значений происходит регистронезависимый поиск по вхождению подстроки в название товара |
Array of objects (product-3) | |
| count | integer |
{- "page": 1,
- "itemsPerPage": 20,
- "search": "string"
}{- "items": [
- {
- "id": "01234567-0123-0123-0123-0123456789ab",
- "name": "string",
- "designation": "string",
- "type": "string",
- "tags": [ ],
}
], - "count": 0
}Ограничение на количество операций: 10
Array of items <= 10 items Импорт товаров |
{- "operations": [
- {
- "id": "01234567-0123-0123-0123-0123456789ab",
- "operation": "create",
- "parameters": {
- "name": "string",
- "type": "string",
- "tags": [ ],
- "previewImage": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "uri": "/product-images/01234567-0123-0123-0123-0123456789ab",
- "filename": "image.jpeg",
- "description": "Описание файла",
- "size": 0,
- "section": "product-images"
}, - "media": {
- "images": {
- "isPrivate": false,
- "items": [ ]
}, - "componentImages": {
- "isPrivate": false,
- "items": [ ]
}, - "documents": {
- "graphicDocuments": {
- "isPrivate": false,
- "items": [ ]
}, - "operationalDocuments": {
- "isPrivate": false,
- "items": [ ]
}, - "certificates": {
- "isPrivate": false,
- "items": [ ]
}, - "ntdDocuments": {
- "items": [ ]
}, - "additionalReferenceMaterials": {
- "isPrivate": false,
- "items": [ ]
}, - "constructionDocumentations": {
- "isPrivate": false,
- "items": [ ]
}
}, - "videos": {
- "isPrivate": false,
- "items": [ ]
}, - "description": {
- "isPrivate": false,
- "text": ""
}, - "model3d": {
- "isPrivate": false,
- "file": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "uri": "/product-documents/01234567-0123-0123-0123-0123456789ab",
- "filename": "image.jpeg",
- "description": "Описание файла",
- "size": 0,
- "section": "product-documents"
}
}
}, - "mainProperties": [
- "01234567-0123-0123-0123-0123456789ab"
], - "properties": [
- {
- "id": "01234567-0123-0123-0123-0123456789ab",
- "name": "Длина",
- "type": "number",
- "unit": "si-millimetre",
- "value": 123.123
}, - {
- "id": "01234567-0123-0123-0123-0123456789ab",
- "name": "Материал",
- "type": "standardMaterial",
- "value": "01234567-0123-0123-0123-0123456789ab"
}, - {
- "id": "01234567-0123-0123-0123-0123456789ab",
- "name": "Габариты",
- "type": "2dimensions",
- "unit": "si-millimetre",
- "value": {
- "a": 123.123,
- "b": 123.123
}, - "deviation": {
- "type": "limit",
- "limit": "H5"
}
}
]
}
}
]
}{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "statusCode": 204
}
]
}Проксирование запроса на загрузку файла в файловое хранилище с помощью интеграционного API.
Проксирует запрос на /api/files/product-documents.
| file required | string <binary> |
| left | integer |
| top | integer |
| width | integer |
| height | integer |
| resizeMode | string Enum: "CROP" "FIT_IN" "FILL" |
| uri required | string <uri> File relative uri |
{- "uri": "/public-images/6ff0337e-bed8-11eb-acdf-73663c5093ea"
}Проксирование запроса на загрузку изображения в файловое хранилище с помощью интеграционного API.
Проксирует запрос на /api/files/product-images.
| file required | string <binary> |
| left | integer |
| top | integer |
| width | integer |
| height | integer |
| resizeMode | string Enum: "CROP" "FIT_IN" "FILL" |
| uri required | string <uri> File relative uri |
{- "uri": "/public-images/6ff0337e-bed8-11eb-acdf-73663c5093ea"
}Вернет коллекцию изделий, удовлетворяющую параметрам, переданным в запросе.
Поиск изделий
| search | string |
| page | integer (page) >= 1 Default: 1 Номер страницы. itemsLimit = 10000 maxPage = (itemsLimit - itemsPerPage) / itemsPerPage. Если будет передано нулевое или отрицательное значение, page примет default значение. (внедряется в проекте постепенно) |
| itemsPerPage | integer (itemsPerPage) [ 1 .. 100 ] Default: 20 Количество элементов на странице Если будет передано нулевое или отрицательное значение, itemsPerPage примет default значение. (внедряется в проекте постепенно) |
Array of objects |
Array of objects (product) | |
| count | integer |
{- "search": "string",
- "page": 1,
- "itemsPerPage": 20,
- "order": [
- {
- "field": "name",
- "direction": "asc"
}
]
}{- "items": [
- {
- "id": "01234567-0123-0123-0123-0123456789ab",
- "name": "string",
- "designation": "string",
- "type": "string",
- "kind": "detail",
- "tags": [ ],
- "media": {
- "description": {
- "text": ""
}
}, - "mainProperties": [
- "01234567-0123-0123-0123-0123456789ab"
], - "properties": [
- {
- "id": "01234567-0123-0123-0123-0123456789ab",
- "name": "Длина",
- "type": "number",
- "unit": "si-millimetre",
- "value": 123.123
}
],
}
], - "count": 0
}Ограничение на количество операций: 10
Array of items <= 10 items Импорт товаров |
{- "operations": [
- {
- "id": "01234567-0123-0123-0123-0123456789ab",
- "operation": "create",
- "parameters": {
- "name": "string",
- "designation": "string",
- "type": "string",
- "kind": "detail",
- "tags": [ ],
- "media": {
- "description": {
- "text": ""
}
}, - "mainProperties": [
- "01234567-0123-0123-0123-0123456789ab"
], - "properties": [
- {
- "id": "01234567-0123-0123-0123-0123456789ab",
- "name": "Длина",
- "type": "number",
- "unit": "si-millimetre",
- "value": 123.123
}
]
}
}
]
}{- "results": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "statusCode": 204
}
]
}Вернёт список изделий каталога PLM компании, аутентифицированной по Bearer API-ключу.
Поиск изделий BigFamily
| search | string |
| designation | string |
| state | string Enum: "draft" "completed" "trashed" "blocked" |
| updatedSince | string <date-time> |
| page | integer (page) >= 1 Default: 1 Номер страницы. itemsLimit = 10000 maxPage = (itemsLimit - itemsPerPage) / itemsPerPage. Если будет передано нулевое или отрицательное значение, page примет default значение. (внедряется в проекте постепенно) |
| itemsPerPage | integer (itemsPerPage) [ 1 .. 100 ] Default: 20 Количество элементов на странице Если будет передано нулевое или отрицательное значение, itemsPerPage примет default значение. (внедряется в проекте постепенно) |
Array of objects |
Array of objects (list_item) | |
| count | integer |
{- "search": "string",
- "designation": "string",
- "state": "draft",
- "updatedSince": "2019-08-24T14:15:22Z",
- "page": 1,
- "itemsPerPage": 20,
- "order": [
- {
- "field": "name",
- "direction": "asc"
}
]
}{- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "designation": "string",
- "name": "string",
- "type": "string",
- "state": {
- "code": "string",
- "name": "string"
}, - "version": 0,
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "count": 0
}Вернёт карточку одного изделия. Секции ответа задаются массивом sections.
Карточка изделия BigFamily
| id required | string <uuid> |
| sections | Array of strings Items Enum: "characteristics" "variations" "documents" "commercial" |
| id | string <uuid> |
| designation | string |
| name | string |
| type | string |
object (state) | |
| version | integer |
Array of objects (characteristic) | |
Array of objects (variation) | |
Array of objects (document) | |
object (commercial) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "sections": [
- "characteristics"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "designation": "string",
- "name": "string",
- "type": "string",
- "state": {
- "code": "string",
- "name": "string"
}, - "version": 0,
- "characteristics": [
- {
- "code": "string",
- "name": "string",
- "value": null,
- "unit": "string"
}
], - "variations": [
- {
- "size": "string",
- "barCode": "string"
}
], - "documents": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "string",
- "group": "string",
- "name": "string",
- "sizeBytes": 0,
}
], - "commercial": {
- "unit": "string",
- "purchasePrice": {
- "amount": "string",
- "currency": "string"
}, - "targetPrice": {
- "amount": "string",
- "currency": "string"
}, - "vatIncluded": true
}
}Вернёт список заявок на производство компании, аутентифицированной по Bearer API-ключу. Доступ ограничен правами сотрудника — владельца ключа (project ACL как во внутреннем API).
Поиск заявок на производство BigFamily
| search | string Поиск по названию заявки и номеру заказа |
| status | string Enum: "waiting" "inProgress" "completed" "rejected" "trashed" Фильтр по статусу заявки |
| projectId | string <uuid> Фильтр по проекту |
| deadlineFrom | string <date> Нижняя граница срока исполнения заявки (включительно) |
| deadlineTo | string <date> Верхняя граница срока исполнения заявки (включительно) |
| responsibleManagerId | string <uuid> Фильтр по ответственному менеджеру |
| supervisingManagerId | string <uuid> Фильтр по контролирующему менеджеру |
| page | integer (page) >= 1 Default: 1 Номер страницы. itemsLimit = 10000 maxPage = (itemsLimit - itemsPerPage) / itemsPerPage. Если будет передано нулевое или отрицательное значение, page примет default значение. (внедряется в проекте постепенно) |
| itemsPerPage | integer (itemsPerPage) [ 1 .. 100 ] Default: 20 Количество элементов на странице Если будет передано нулевое или отрицательное значение, itemsPerPage примет default значение. (внедряется в проекте постепенно) |
Array of objects |
Array of objects (list_item-2) | |
| count | integer Общее количество заявок по фильтрам |
{- "search": "string",
- "status": "waiting",
- "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
- "deadlineFrom": "2019-08-24",
- "deadlineTo": "2019-08-24",
- "responsibleManagerId": "d99ebc8d-7b81-4892-8dc9-e1d981f9eacd",
- "supervisingManagerId": "4ae981ce-52dd-4d90-84a2-67cea0c1724b",
- "page": 1,
- "itemsPerPage": 20,
- "order": [
- {
- "field": "name",
- "direction": "asc"
}
]
}{- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "number": "string",
- "name": "string",
- "status": {
- "code": "waiting",
- "name": "В работе"
}, - "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "СТМ Весна"
}, - "batch": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "СТМ Весна"
}, - "contractor": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "Фабрика",
- "country": "Россия"
}, - "customer": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "СТМ Весна"
}, - "deadline": "2019-08-24",
- "daysLeft": 0,
- "responsibleManager": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "Иванов Иван",
- "position": "Менеджер"
}, - "controllingManager": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "Иванов Иван",
- "position": "Менеджер"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "count": 0
}Вернёт карточку одной заявки на производство. Секции ответа задаются массивом sections. Доступ ограничен правами сотрудника — владельца API-ключа; недоступная заявка возвращается как 404.
Карточка заявки на производство BigFamily
| id required | string <uuid> Идентификатор заявки |
| sections | Array of strings Items Enum: "stages" "items" "checklist" "documents" Запрошенные секции карточки. Если массив не передан, возвращается только обзор без ключей stages, items, checklist и documents. Неизвестная секция приводит к ошибке 400. |
| id | string <uuid> (Идентификатор) |
| number | string (Номер заказа) |
| name | string (Название) |
object (status) | |
object or null (Проект) | |
object or null (Партия) | |
object or null (Исполнитель) | |
object or null (Заказчик) | |
| deadline | string or null <date> (Срок) |
| daysLeft | integer or null (Осталось дней) Знаковая календарная разница dueDate − сегодня |
object or null (Ответственный менеджер) | |
object or null (Контролирующий менеджер) | |
| createdAt | string <date-time> (Создано) |
| updatedAt | string <date-time> (Обновлено) |
Array of objects (Этапы) | |
object (checklist) | |
Array of objects (Изделия) | |
Array of objects (Документы) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "sections": [
- "stages"
]
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "number": "string",
- "name": "string",
- "status": {
- "code": "waiting",
- "name": "В работе"
}, - "project": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "СТМ Весна"
}, - "batch": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "СТМ Весна"
}, - "contractor": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "Фабрика",
- "country": "Россия"
}, - "customer": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "СТМ Весна"
}, - "deadline": "2019-08-24",
- "daysLeft": 0,
- "responsibleManager": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "Иванов Иван",
- "position": "Менеджер"
}, - "controllingManager": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "Иванов Иван",
- "position": "Менеджер"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "stages": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "В производстве",
- "order": 0,
- "plannedDate": "2019-08-24"
}
], - "checklist": {
- "completed": 0,
- "total": 0,
- "points": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "order": 0,
- "name": "Ответственные назначены",
- "isCompleted": true,
- "completedAt": "2019-08-24"
}
]
}, - "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "article": "26M-1391",
- "name": "Футболка муж.",
- "quantity": 0,
- "unit": "quantity",
- "cost": {
- "amount": "8.00",
- "currency": "USD"
}, - "stages": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "factQuantity": 0,
- "plannedQuantity": 0
}
], - "sizes": [
- {
- "variationId": "818c389d-b425-42eb-b751-daa67a093f4f",
- "quantity": 0,
- "stages": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "factQuantity": 0,
- "plannedQuantity": 0
}
]
}
]
}
], - "documents": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "type": "specification",
- "name": "specification.xlsx",
- "sizeBytes": 0,
}
]
}Возвращает коллекцию категорий каталога маркетплейса. Фильтр по каталогу всегда устанавливается в "marketplace".
Фильтры поиска категорий маркетплейса
| page | integer (page) >= 1 Default: 1 Номер страницы. itemsLimit = 10000 maxPage = (itemsLimit - itemsPerPage) / itemsPerPage. Если будет передано нулевое или отрицательное значение, page примет default значение. (внедряется в проекте постепенно) |
| itemsPerPage | integer (itemsPerPage) [ 1 .. 100 ] Default: 20 Количество элементов на странице Если будет передано нулевое или отрицательное значение, itemsPerPage примет default значение. (внедряется в проекте постепенно) |
| search | string Фильтр по вхождению строки в название категории |
| parent | string <uuid> Фильтр по ID родительской категории |
| rootsOnly | boolean Только категории верхнего уровня (внутри применяется фильтр по корневой категории маркетплейса) |
| slugs | Array of strings Фильтр по массиву slug-ов категории |
Array of objects |
Array of objects (Category) | |
| count | integer |
{- "page": 1,
- "itemsPerPage": 20,
- "search": "string",
- "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
- "rootsOnly": true,
- "slugs": [
- "string"
], - "order": [
- {
- "field": "name",
- "direction": "asc"
}
]
}{- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "Трубная продукция",
- "slug": "krany",
- "parent": "42e2bc1b-6741-4e2e-b138-97b4a342c999",
- "description": "Включает в себя задвижки, клапаны, фланцы, переходники и другие компоненты, необходимые для монтажа и функционирования трубопроводной системы.",
- "image": {
- "description": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "count": 0
}Фильтры поиска производителей. Возвращаются только те производители, у которых активирована функциональность витрины.
Array of objects (Manufacturer) |
{ }{- "items": [
- {
- "id": "01234567-0123-0123-0123-0123456789ab",
- "inn": "7802363428",
- "name": "ООО Компрессор Газ",
- "email": "admin@compressor-gaz.ru"
}
]
}Отправка уведомления о закупке
| orderUri | string [ 1 .. 1000 ] characters Ссылка на заказ в системе istock.link. |
| products | Array of strings <uuid> (id) [ 1 .. 1000 ] items [ items <uuid > ] |
{- "products": [
- "01234567-0123-0123-0123-0123456789ab"
]
}{- "error": "string",
- "violations": [
- {
- "message": "An error occurred",
- "error": "domain: error code",
- "propertyPath": "properties[0].value"
}
]
}Возвращает товары для торговой площадки. В настоящий момент, доступно для ограниченного списка компаний.
Фильтры поиска товаров для торговой площадки. Возвращаются товары только тех производителей, у которых активирована функциональность витрины.
| category | string <uuid> Фильтр по ID категории номенклатуры |
| manufacturers | Array of strings <uuid> (id) [ items <uuid > ] Список производителей товара. |
| search | string Поиск по названию, типу товара и тегам. |
| page | integer (page) >= 1 Default: 1 Номер страницы. itemsLimit = 10000 maxPage = (itemsLimit - itemsPerPage) / itemsPerPage. Если будет передано нулевое или отрицательное значение, page примет default значение. (внедряется в проекте постепенно) |
| itemsPerPage | integer (itemsPerPage) [ 1 .. 100 ] Default: 20 Количество элементов на странице Если будет передано нулевое или отрицательное значение, itemsPerPage примет default значение. (внедряется в проекте постепенно) |
Array of objects (Product) | |
| count | integer >= 0 |
{- "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
- "manufacturers": [
- "01234567-0123-0123-0123-0123456789ab"
], - "search": "string",
- "page": 1,
- "itemsPerPage": 20
}{- "items": [
- {
- "id": "01234567-0123-0123-0123-0123456789ab",
- "uin": "000010284870821",
- "name": "string",
- "type": "string",
- "tags": [
- "string"
], - "designation": "string",
- "manufacturer": {
- "id": "01234567-0123-0123-0123-0123456789ab",
- "inn": "7802363428",
- "name": "ООО Компрессор Газ",
- "email": "admin@compressor-gaz.ru"
}, - "previewImage": {
- "description": "string"
}, - "tradeItem": {
- "amount": 0,
- "unit": {
- "key": "quantity",
- "name": "штуки",
- "symbol": "шт"
}, - "price": {
- "amount": "100.55",
- "currency": "RUB",
- "vat": "20",
- "withVAT": true
}
}
}
], - "count": 0
}Фильтр по ID
| ids | Array of strings <uuid> (id) [ 1 .. 1000 ] items [ items <uuid > ] |
object |
{- "ids": [
- "01234567-0123-0123-0123-0123456789ab"
]
}{- "items": {
- "{id}": {
- "id": "01234567-0123-0123-0123-0123456789ab",
- "uin": "000010284870821",
- "name": "string",
- "type": "string",
- "tags": [
- "string"
], - "designation": "string",
- "manufacturer": {
- "id": "01234567-0123-0123-0123-0123456789ab",
- "inn": "7802363428",
- "name": "ООО Компрессор Газ",
- "email": "admin@compressor-gaz.ru"
}, - "previewImage": {
- "description": "string"
}, - "tradeItem": {
- "amount": 0,
- "unit": {
- "key": "quantity",
- "name": "штуки",
- "symbol": "шт"
}, - "price": {
- "amount": "100.55",
- "currency": "RUB",
- "vat": "20",
- "withVAT": true
}
}
}
}
}