API docs by Redocly

Scap.Service (1.0)

Download OpenAPI specification:

Package

Асинхронный запрос на решение задачи Package.

Задача будет добавлена в очередь на выполнение.

Authorizations:
Bearer
Request Body schema:
required
required
object (RequestOptions)

Опции решения задачи

required
Array of objects (OverhangsDto)

Паллеты

required
Array of objects (Packaging)

Упаковки товара

Responses

Request samples

Content type
{
  • "options": {
    },
  • "pallets": [
    ],
  • "packages": [
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "string",
  • "tasksInQueue": 0
}

Получение результата решения задачи Package.

Authorizations:
Bearer
query Parameters
taskId
required
string

Responses

Response samples

Content type
application/json
{
  • "statuses": [
    ],
  • "executingDuration": 0,
  • "cost": 0,
  • "groups": [
    ],
  • "result": [
    ],
  • "error": {
    }
}

Добавление или обновление паллет.

Authorizations:
Bearer
Request Body schema:
required
Array
id
required
string non-empty

Идентификатор места хранения

type
required
integer <int32> (LocationType)
Enum: "Pallet" "Box"
required
object (RequestCharacteristics)

Габаритные характеристики параллелепипеда места хранения

loadCapacity
required
integer <int32> [ 1 .. 2147483647 ]

Грузоподъемность места хранения

required
object (RequestTare)

Характеристики тары

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string"
}

Добавление или обновление упаковок.

Authorizations:
Bearer
Request Body schema:
required
Array
id
required
string non-empty

Идентификатор упаковки

sku
required
string non-empty

Товар

required
object (RequestCharacteristicsPack)

Массогабаритные характеристики

layOnSide
required
boolean

Можно класть на бок

massClass
required
integer <int32>

Класс по массе 123…, 1- легкий, 2 – средний, 3 – тяжелый; (если 0, то это самый легкий класс)

stackingWeight
required
integer <int32>

Масса штабелирования - сколько можно класть сверху; если 0, то ограничение нам неизвестно - работаем просто по классу массы

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "string"
}

Удаление паллет.

Authorizations:
Bearer
Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
application/json
{
  • "message": "string"
}

Удаление упаковок.

Authorizations:
Bearer
Request Body schema:
required
Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
application/json
{
  • "message": "string"
}

Асинхронный запрос на получение стандарта укладки.

Задача будет добавлена в очередь на выполнение.

Authorizations:
Bearer
Request Body schema:
required
palletIds
required
Array of strings

Идентификаторы мест хранения

packageIds
required
Array of strings

Идентификатор упаковки товара

sizeOfAllowedOverhangs
required
integer <int32>

Размер разрешенных свесов; если 0, то свесы не используются.

support
required
number <float>

Минимальная доля площади опоры у коробки

Responses

Request samples

Content type
{
  • "palletIds": [
    ],
  • "packageIds": [
    ],
  • "sizeOfAllowedOverhangs": 0,
  • "support": 0.1
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Получение результата задачи стандарта укладки.

Authorizations:
Bearer
query Parameters
taskId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/clearStandards

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]