Передача количества грузовых мест в заказе

Info

Console

Метод доступен для модели DBS.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

inventory-and-order-processing — Обработка заказов и учёт товаров
all-methods — Полное управление кабинетом

Этот запрос только для DBS

Если вы работаете по модели FBS, пользуйтесь PUT campaigns/{campaignId}/orders/{orderId}/boxes.

Отгружаемый Маркету заказ может не влезть в одну коробку или упаковку — в этом случае получается, что он занимает несколько грузовых мест.

Количество грузовых мест нужно обязательно передавать Маркету, если оно не равно 1. Это делается перед переводом его в статус Готов к отгрузке. Подробно о том, что в какой момент нужно передавать, рассказано в пошаговой инструкции.

Метод устроен немного нестандартно: количество задается длиной массива пустых объектов.

Раньше метод требовал передачи большего количества данных. Запросы, оформленные по старому образцу, работают, но лучше делать по-новому.

Как было раньше

Структура тела PUT-запроса:

{
  "boxes":
  [
    {
      "fulfilmentId": "{string}",
      "weight": {int64},
      "width": {int64},
      "height": {int64},
      "depth": {int64},
      "items":
      [
        {
          "id": {int64},
          "count": {int32}
        },
        ...
      ]
    },
    ...
  ]
}

Параметр	Тип	Значение
`boxes`		Список грузовых мест.

Параметры, вложенные в boxes

Параметр	Тип	Значение
`fulfilmentId`	String	Идентификатор грузового места в информационной системе магазина. Сформируйте идентификатор по шаблону: `номер заказа на Маркете-номер грузового места`. Например, `7206821‑1, 7206821‑2` и т. д.
`weight`	Int64	Масса брутто грузового места (суммарная масса упаковки и содержимого) в граммах.
`width`	Int64	Ширина грузового места в сантиметрах.
`height`	Int64	Высота грузового места в сантиметрах.
`depth`	Int64	Глубина грузового места в сантиметрах.
`items`	Int64	Список товаров в грузовом месте.

Параметры, вложенные в items

Параметр	Тип	Значение
`id`	Int64	Идентификатор товара в рамках заказа.
`count`	Int32	Количество единиц товара в грузовом месте.

⚙️ Лимит: 100 000 запросов в час

Request

PUT

https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes

Path parameters

Name	Description
campaignId*	Type: integer<int64> Идентификатор магазина в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете Min value: `1`
orderId*	Type: integer<int64> Идентификатор заказа.
shipmentId*	Type: integer<int64> Параметр больше не используется. Вставьте любое число — просто чтобы получился корректный URL.

Body

application/json

{
    "boxes": [
        {
            "fulfilmentId": "string"
        }
    ]
}

Name

Description

boxes*

Type: ParcelBoxRequestDTO[]

Список грузовых мест. По его длине Маркет определяет количество мест.
Параметр отображает одно грузовое место. Вложенные поля больше не используются, передавайте параметр пустым.

Min items: 1

ParcelBoxRequestDTO

Параметр отображает одно грузовое место. Вложенные поля больше не используются, передавайте параметр пустым.

Name

Description

fulfilmentId

⦸

Type: string

Этот параметр устарел

Не используйте его.

Pattern: ^[\p{Alnum}- ]*$

Responses

200 OK

Имеет значение только тип ответа. Если ответ ОК, количество грузомест записано.

Body

application/json

{
    "status": "OK",
    "result": {
        "boxes": [
            {
                "id": 0,
                "fulfilmentId": "string"
            }
        ]
    }
}

Name

Description

result

Type: ShipmentBoxesDTO

В ответе Маркет возвращает переданный вами список грузовых мест. Не обращайте на это поле внимания.

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ShipmentBoxesDTO

В ответе Маркет возвращает переданный вами список грузовых мест. Не обращайте на это поле внимания.

Name

Description

boxes*

Type: ParcelBoxDTO[]

Список грузовых мест. По его длине Маркет определил количество мест.
Параметр отображает одно грузовое место.

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

ParcelBoxDTO

Параметр отображает одно грузовое место.

Name

Description

fulfilmentId

⦸

Type: string

Этот параметр устарел

Не используйте его.

Pattern: ^[\p{Alnum}- ]*$

Type: integer<int64>

Идентификатор коробки в составе заказа.

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

Была ли статья полезна?

Передача кода подтверждения

Удаление товаров из заказа