API docs by Redocly

Nemika WMS Cloud API

Download OpenAPI specification:Download

Authentication

Nemika API поддерживает форму аутентификации с помощью API KEY

ApiKey

Для авторизации вы должны передать значение атрибута ApiKey в заголовки

Security Scheme Type: API Key
Headersfully parameter name: ApiKey

Контрагенты

Получение контрагента по Guid

Возвращает контрагента

Authorizations:
ApiKey
path Parameters
guid
required
string <guid>

Guid искомого контрагента

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": {
    }
}

Получение всех контрагентов.

Получение всех контрагентов.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": [
    ]
}

Добавляет/Изменяет контрагента.

Добавляет/Изменяет контрагента.

Authorizations:
ApiKey
Request Body schema: application/json

Контрагент добавляемый в перечень

guid
string

Guid контрагента

name
string

Сокращенное имя контрагента

fullname
string

Полное имя контрагента

phone
string

Контактный телефон контрагента

address
string

Адрес контрагента

Responses

Request samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "name": "Мир карандашей",
  • "fullname": "ООО Мир Карандашей",
  • "phone": 375295235588,
  • "address": "ул. Маяковского, д. 8"
}

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "operation": 1
}

Категории

Получение категории по Guid

Возвращает категорию

Authorizations:
ApiKey
path Parameters
guid
required
string <guid>

Guid искомой категории

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": {
    }
}

Получение всех категорий.

Получение всех категорий.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": [
    ]
}

Добавляет/Изменяет категорию.

Добавляет/Изменяет категорию.

Authorizations:
ApiKey
Request Body schema: application/json

Категория добавляемая в перечень

guid
string

Guid категории

name
string

Название категории

parentGuid
string

Guid родительской категории

status
integer
Enum: "1 - Active" "2 - Inactive"

Статус категории

Responses

Request samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "name": "Канцтовары",
  • "parentGuid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "status": 1
}

Товары

Получение товара по Guid

Возвращает товар

Authorizations:
ApiKey
path Parameters
guid
required
string <guid>

Guid искомого товара

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": {
    }
}

Получение всех продуктов.

Получение всех продуктов.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": [
    ]
}

Получение серийных товаров по Id товара

Возвращает серийные товары

Authorizations:
ApiKey
path Parameters
id
required
integer <int64>

Id искомого серийного товара

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": [
    ]
}

Получение серийного товара по Id

Возвращает серийный товар

Authorizations:
ApiKey
path Parameters
id
required
integer <int64>

Id искомого серийного товара

Responses

Response samples

Content type
application/json
{
  • "serialNumber": 523521,
  • "cellNumber": "AA-03-05-01",
  • "status": 1,
  • "cellContentEntityId": 11,
  • "productEntityId": 1,
  • "containerContentId": null
}

Добавляет/Изменяет товар.

Добавляет/Изменяет товар.

Authorizations:
ApiKey
Request Body schema: application/json

Товар добавляемый в перечень

guid
string

Guid товара

name
string

Название товара

description
string

Описание товара

barcode
string

Производственный штрихкод товара

article
string

Артикул товара

categoryGuid
string

Guid категории товара

countryGuid
string

Guid страны

brandGuid
string

Guid бренда

measureGuid
string

Guid единицы измерения

type
integer
Enum: "1 - General (Общий)" "2 - Batch (Партионный)" "3 - Serial (Серийный)"

Тип товара

validTerm
integer

Срок годности товара в днях (Для партионных товаров)

weight
number

Вес товара

width
number

Ширина товара

depth
number

Глубина товара

height
number

Высота товара

cost
number

Стоимость товара

Responses

Request samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "name": "Карандаш",
  • "description": "Простой карандаш",
  • "barcode": 526314346,
  • "article": "623jc2",
  • "categoryGuid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "countryGuid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "brandGuid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "measureGuid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "type": 1,
  • "validTerm": 1,
  • "weight": 1,
  • "width": 1,
  • "depth": 1,
  • "height": 1,
  • "cost": 1
}

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "operation": 1
}

Бренды

Получение бренда по Guid

Возвращает бренд

Authorizations:
ApiKey
path Parameters
guid
required
string <guid>

Guid искомого бренда

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": {
    }
}

Получение всех брендов.

Получение всех брендов.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": [
    ]
}

Добавляет/Изменяет бренд.

Добавляет/Изменяет бренд.

Authorizations:
ApiKey
Request Body schema: application/json

Бренд добавляемый в перечень

guid
string

Guid бренда

name
string

Название бренда

Responses

Request samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "name": "Нокиа"
}

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "operation": 1
}

Страны

Получение страны по Guid

Возвращает страну

Authorizations:
ApiKey
path Parameters
guid
required
string <guid>

Guid искомой страны

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": {
    }
}

Получение всех стран.

Получение всех стран.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": [
    ]
}

Добавляет/Изменяет страну.

Добавляет/Изменяет страну.

Authorizations:
ApiKey
Request Body schema: application/json

Страна добавляемая в перечень

guid
string

Guid страны

name
string

Название страны

Responses

Request samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "name": "Колумбия"
}

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "operation": 1
}

Единицы измерения

Получение eдиницы измерения по Guid

Возвращает единицу измерения

Authorizations:
ApiKey
path Parameters
guid
required
string <guid>

Guid искомой единицы измерения

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": {
    }
}

Получение всех единиц измерения.

Получение всех единиц измерения.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": [
    ]
}

Добавляет/Изменяет единицу измерения.

Добавляет/Изменяет единицу измерения.

Authorizations:
ApiKey
Request Body schema: application/json

Единица измерения добавляемая в перечень

guid
string

Guid единицы измерения

name
string

Название единицы измерения

Responses

Request samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "name": "Нокиа"
}

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "operation": 1
}

Приход

Получение заявки на приход по Guid

Возвращает заявку на приход

Authorizations:
ApiKey
path Parameters
guid
required
string <guid>

Guid искомой заявки на приход

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": {
    }
}

Получение всех заявок на приход.

Получение всех заявок на приход.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": [
    ]
}

Добавляет/Изменяет заявку на приход.

Добавляет/Изменяет заявку на приход.

Authorizations:
ApiKey
Request Body schema: application/json

Добавляемая/Изменяемая заявка на приход

guid
string

Guid заявки на приход

number
string

Номер документа

counterpartyGuid
string

Guid контрагента

status
integer
Enum: "1 - Not processed (Не обработан)" "4 - Rejection (Отказ)"

Статус документа

Array of objects (SupplyOrderSpecAdd)

Спецификации документа

Responses

Request samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "number": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "counterpartyGuid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "status": 1,
  • "supplyOrderSpecEntities": [
    ]
}

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "operation": 1
}

Получение спецификации заявки на приход по Id

Возвращает спецификацию заявку на приход

Authorizations:
ApiKey
path Parameters
id
required
integer <int64>

Id спецификации

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": {
    }
}

Получение спецификаций по Guid заявки на приход

Возвращает спецификации заявки на приход

Authorizations:
ApiKey
path Parameters
guid
required
string <guid>

Guid заявки на приход

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": [
    ]
}

Заказ

Получение заказа по Guid

Возвращает заказ

Authorizations:
ApiKey
path Parameters
guid
required
string <guid>

Guid искомого заказа

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": {
    }
}

Получение всех заказов.

Получение всех заказов.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": [
    ]
}

Добавляет/Изменяет заказ.

Добавляет/Изменяет заказ.

Authorizations:
ApiKey
Request Body schema: application/json

Добавляемый/Изменяемый заказ

guid
string

Guid заказа

number
string

Номер документа

counterpartyGuid
string

Guid контрагента

shipmentDate
datetime

Планируемая дата отгрузки

status
integer
Enum: "1 - Not processed (Не обработан)" "4 - Reserved (Зарезервирован)" "5 - Rejection (Отказ)"

Статус документа

Array of objects (OrderSpecAdd)

Спецификации документа

Responses

Request samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "number": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "counterpartyGuid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "shipmentDate": "2024-07-24T08:07:41.708Z",
  • "status": 1,
  • "orderContentEntities": [
    ]
}

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "operation": 1
}

Получение спецификации заказа по Id

Возвращает спецификацию заказа

Authorizations:
ApiKey
path Parameters
id
required
integer <int64>

Id спецификации

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": {
    }
}

Получение спецификаций по Guid заказа

Возвращает спецификации заказа

Authorizations:
ApiKey
path Parameters
guid
required
string <guid>

Guid заказа

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": [
    ]
}

Отгрузка

Получение отгрузки по Guid

Возвращает отгрузку

Authorizations:
ApiKey
path Parameters
guid
required
string <guid>

Guid искомой отгрузки

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": {
    }
}

Получение всех отгрузок.

Получение всех отгрузок.

Authorizations:
ApiKey

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": [
    ]
}

Добавляет/Изменяет отгрузку.

Добавляет/Изменяет отгрузку.

Authorizations:
ApiKey
Request Body schema: application/json

Добавляемая/Изменяемая отгрузка

guid
string

Guid отгрузки

number
string

Номер документа

carNumber
string

Номер машины

plannedDate
datetime

Планируемая дата отгрузки

status
integer
Enum: "1 - Not processed (Не обработан)" "4 - Rejection (Отказ)"

Статус документа

Array of objects (ShipmentSpecAdd)

Спецификации документа

Responses

Request samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "number": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "carNumber": 5235153,
  • "plannedDate": "2024-08-09T09:37:35.862Z",
  • "status": 2,
  • "shipmentSpecEntities": [
    ]
}

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "operation": 1
}

Получение спецификации отгрузки по Id

Возвращает спецификацию отгрузки

Authorizations:
ApiKey
path Parameters
id
required
integer <int64>

Id спецификации

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": {
    }
}

Получение спецификаций по Guid отгрузки

Возвращает спецификации отгрузки

Authorizations:
ApiKey
path Parameters
guid
required
string <guid>

Guid отгрузки

Responses

Response samples

Content type
application/json
{
  • "guid": "60413457-0673-4d2a-8e4f-4e83e772505a",
  • "succeeded": true,
  • "status": 200,
  • "data": [
    ]
}

Статус заявки

supplyOrderId
integer

Id заявки на приход

guid
string

Guid заявки на приход

oldStatus
integer
Enum: "1 - Not processed (Не обработан)" "2 - Being processed (Обрабатывается)" "3 - Processed (Обработан)" "4 - Rejection (Отказ)"

Старый статус

newStatus
integer
Enum: "1 - Not processed (Не обработан)" "2 - Being processed (Обрабатывается)" "3 - Processed (Обработан)" "4 - Rejection (Отказ)"

Статус документа

{
  • "supplyOrderId": 1,
  • "guid": "B6C51D3F-0EAD-4D4A-9BBF-90FB8DA80FD3",
  • "oldStatus": 2,
  • "newStatus": 3
}

Статус заказа

orderId
integer

Id заказа

guid
string

Guid заказа

oldStatus
integer
Enum: "1 - Not processed (Не обработан)" "2 - Being processed (Обрабатывается)" "3 - Processed (Обработан)" "4 - Reserved (Зарезервирован)" "5 - Rejection (Отказ)" "6 - Shipped (Отгрузка)"

Старый статус

newStatus
integer
Enum: "1 - Not processed (Не обработан)" "2 - Being processed (Обрабатывается)" "3 - Processed (Обработан)" "4 - Reserved (Зарезервирован)" "5 - Rejection (Отказ)" "6 - Shipped (Отгрузка)"

Статус документа

{
  • "orderId": 1,
  • "guid": "B6C51D3F-0EAD-4D4A-9BBF-90FB8DA80FD3",
  • "oldStatus": 1,
  • "newStatus": 2
}

Статус отгрузки

shipmentId
integer

Id отгрузки

guid
string

Guid отгрузки

oldStatus
integer
Enum: "1 - Not processed (Не обработан)" "2 - Being processed (Обрабатывается)" "3 - Processed (Обработан)" "4 - Rejection (Отказ)"

Старый статус

newStatus
integer
Enum: "1 - Not processed (Не обработан)" "2 - Being processed (Обрабатывается)" "3 - Processed (Обработан)" "4 - Rejection (Отказ)"

Статус документа

{
  • "shipmentId": 1,
  • "guid": "B6C51D3F-0EAD-4D4A-9BBF-90FB8DA80FD3",
  • "oldStatus": 1,
  • "newStatus": 2
}