Этикетки грузовых мест поставки (короба и паллеты)

POST /v1/label/packages/get

POST/v1/label/packages/get

Тело запроса

shipment_id
string
required

Идентификатор отгрузки.

package_id
array

Идентификаторы грузовых мест (опционально).

format
string

Формат файла (опционально).

Допустимые значения
PDFPNGSVGZPL
size
string

Размер этикетки (опционально).

Допустимые значения
SIZE_58x40SIZE_58x30SIZE_100x150SIZE_A4

Успешный ответ

200A successful response.
application/json
object
labels
array

Успешно сгенерированные этикетки грузомест.

labelFboPackagesGetLabelItem

Показать свойства

labelFboPackagesGetLabelItem

package_id
string

Идентификатор грузоместа.

format
string

Формат документа.

Допустимые значения
PDFPNGSVGZPL
size
string

Размер этикетки.

Допустимые значения
SIZE_58x40SIZE_58x30SIZE_100x150SIZE_A4
content_type
string
  • MIME-тип содержимого.
content_base64
string

Содержимое документа в base64.

page_count
integer

Количество страниц или стикеров.

failed
array

Грузоместа, по которым не удалось сгенерировать или получить этикетку. Если пустой или отсутствует — этикетки успешно получены для всех запрошенных грузомест.

Элемент, по которому не удалось сгенерировать или получить этикетку.

Показать свойства
package_id
string

Идентификатор грузоместа.

errors
array

Структурированные ошибки валидации по полям.

Унифицированная ошибка валидации поля.

Для бизнес-правил витрины использовать code = STOREFRONT_RULE_VIOLATION.

Показать свойства
field
string
required

Имя поля в запросе (например product_id). Вложенность через точку/индекс: shipments[0].timeslot.

code
string
required

Каталог кодов валидации.

Коды schema-валидации; для бизнес-правил витрины / склада использовать следующий код

STOREFRONT_RULE_VIOLATION.

Геометрия полигонов и адреса merchant location не применяются.

  • REQUIRED: Поле отсутствует или пустое, но обязательно.
  • REQUIRED_ONE_OF: Нужен хотя бы один из набора полей.
  • CONDITIONALLY_REQUIRED: Поле обязательно при выполнении условия.
  • INVALID_TYPE: Неверный JSON-тип значения.
  • INVALID_ENUM: Значение не из допустимого enum.
  • INVALID_FORMAT: Общий сбой формата значения.
  • INVALID_DATE_TIME: Дата/время не RFC3339 или без timezone.
  • INVALID_DATE: Дата не в формате YYYY-MM-DD.
  • INVALID_TIME: Время не в формате ЧЧ:ММ.
  • INVALID_TIME_RANGE: Диапазон времени (перерыв) некорректен.
  • INVALID_URL: Невалидный URL.
  • TOO_MANY_ITEMS: Превышен maxItems / лимит элементов в запросе.
  • MIN_VALUE: Значение ниже допустимого минимума.
  • MAX_VALUE: Значение выше допустимого максимума.
  • NEGATIVE_VALUE: Отрицательное значение там, где недопустимо.
  • INVALID_RANGE: Некорректный диапазон (from > to и т.п.).
  • NOT_FOUND: Сущность не найдена.
  • CONFLICT: Конфликт состояния объекта.
  • INVALID_STATUS_TRANSITION: Недопустимый переход статуса.
  • STATUS_NOT_ALLOWED: Статус недоступен в текущем контексте.
  • STOREFRONT_RULE_VIOLATION: Нарушение бизнес-правила витрины / склада.
Допустимые значения
REQUIREDREQUIRED_ONE_OFCONDITIONALLY_REQUIREDINVALID_TYPEINVALID_ENUMINVALID_FORMATINVALID_DATE_TIMEINVALID_DATEINVALID_TIMEINVALID_TIME_RANGEINVALID_URLTOO_MANY_ITEMSMIN_VALUEMAX_VALUENEGATIVE_VALUEINVALID_RANGENOT_FOUNDCONFLICTINVALID_STATUS_TRANSITIONSTATUS_NOT_ALLOWEDSTOREFRONT_RULE_VIOLATION
message
string
required

Текст ошибки для клиента. Для STOREFRONT_RULE_VIOLATION — описание конкретного правила витрины.

Ошибки

400Некорректный запрос
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
401Ошибка авторизации
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
429Превышен лимит запросов
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
500Внутренняя ошибка сервера
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
defaultОшибка (неожиданная или прочие)
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
POST/v1/label/packages/get
1curl https://api.omninet.ru/v1/label/packages/get \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "shipment_id": "string",6  "package_id": [7    "string"8  ],9  "format": "PDF",10  "size": "string"11}'
{
  "labels": [
    {
      "package_id": "string",
      "format": "PDF",
      "size": "string",
      "content_type": "string",
      "content_base64": "string",
      "page_count": 0
    }
  ],
  "failed": [
    {
      "package_id": "string",
      "errors": [
        {
          "field": "product_id",
          "code": "NOT_FOUND",
          "message": "Товар не найден"
        }
      ]
    }
  ]
}

A successful response.