Получение информации о нескольких отгрузках

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

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

Возвращает информацию об отгрузках по заданным параметрам:

  • дате;
  • статусу;
  • идентификаторам заказов.

Результаты возвращаются постранично.

Ограничение для параметра limit

Не передавайте значение больше 30.

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

Request

PUT

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/first-mile/shipments

Path parameters

Name

Description

campaignId

Type: integer

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Min value: 1

Query parameters

Name

Description

limit

Type: integer

Количество значений на одной странице.

Min value: 1

page_token

Type: string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуем передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры page и pageSize, они игнорируются.

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json
{
  "dateFrom": "2025-01-01",
  "dateTo": "2025-01-01",
  "statuses": [
    "OUTBOUND_CREATED"
  ],
  "orderIds": [
    0
  ],
  "cancelledOrders": true
}

Name

Description

dateFrom

Type: string<date>

Начальная дата для фильтрации по дате отгрузки (включительно).

Формат даты: ДД-ММ-ГГГГ.

Example: 2025-01-01

dateTo

Type: string<date>

Конечная дата для фильтрации по дате отгрузки (включительно).

Формат даты: ДД-ММ-ГГГГ.

Example: 2025-01-01

cancelledOrders

Type: boolean

Возвращать ли отмененные заказы.

Значение по умолчанию: true. Если возвращать отмененные заказы не нужно, передайте значение false.

Default: true

orderIds

Type: integer[] | null

Список идентификаторов заказов из отгрузок.

Min items: 1

Unique items: true

Example
[
  0
]

statuses

Type: ShipmentStatusType[] | null

Список статусов отгрузок.

Min items: 1

Unique items: true

Example
[
  "OUTBOUND_CREATED"
]

ShipmentStatusType

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

  • OUTBOUND_CREATED — формируется.
  • OUTBOUND_READY_FOR_CONFIRMATION — можно обрабатывать.
  • OUTBOUND_CONFIRMED — подтверждена и готова к отправке.
  • OUTBOUND_SIGNED — по ней подписан электронный акт приема-передачи.
  • ACCEPTED — принята в сортировочном центре или пункте приема.
  • ACCEPTED_WITH_DISCREPANCIES — принята с расхождениями.
  • FINISHED — завершена.
  • ERROR — отменена из-за ошибки.

Type: string

Enum: OUTBOUND_CREATED, OUTBOUND_READY_FOR_CONFIRMATION, OUTBOUND_CONFIRMED, OUTBOUND_SIGNED, FINISHED, ACCEPTED, ACCEPTED_WITH_DISCREPANCIES, ERROR

Responses

200 OK

Найденные отгрузки.

Body

application/json
{
  "status": "OK",
  "result": {
    "shipments": [
      {}
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    result

    Type: SearchShipmentsResponseDTO

    Информация об отгрузках.

    Example
    {
  "shipments": [
    {
      "id": 1,
      "planIntervalFrom": "2017-11-21T00:00:00+03:00",
      "planIntervalTo": "2017-11-21T00:00:00+03:00",
      "shipmentType": "IMPORT",
      "warehouse": {
        "id": 1,
        "name": "example",
        "address": "example"
      },
      "warehouseTo": null,
      "externalId": "example",
      "deliveryService": {
        "id": 0,
        "name": "example"
      },
      "palletsCount": {
        "planned": 0,
        "fact": 0
      },
      "orderIds": [
        1
      ],
      "draftCount": 0,
      "plannedCount": 0,
      "factCount": 0,
      "signature": {
        "signed": true
      },
      "status": "OUTBOUND_CREATED",
      "statusDescription": "example",
      "statusUpdateTime": "2017-11-21T00:00:00+03:00"
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}
    Example
    {
  "result": {
    "shipments": [
      {
        "id": 1,
        "planIntervalFrom": "2017-11-21T00:00:00+03:00",
        "planIntervalTo": "2017-11-21T00:00:00+03:00",
        "shipmentType": "IMPORT",
        "warehouse": {},
        "warehouseTo": null,
        "externalId": "example",
        "deliveryService": {},
        "palletsCount": {},
        "orderIds": [
          null
        ],
        "draftCount": 0,
        "plannedCount": 0,
        "factCount": 0,
        "signature": {},
        "status": "OUTBOUND_CREATED",
        "statusDescription": "example",
        "statusUpdateTime": "2017-11-21T00:00:00+03:00"
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR
Example
{
  "status": "OK"
}

ShipmentType

Способ отгрузки заказов:

  • IMPORT — вы самостоятельно привозите заказы в выбранный сортировочный центр или пункт приема заказов.
  • WITHDRAW — вы отгружаете заказы со своего склада курьерам Яндекс Маркета.

Type: string

Enum: IMPORT, WITHDRAW

PartnerShipmentWarehouseDTO

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

Name

Description

id

Type: integer

Идентификатор склада отправления.

Min value: 1

address

Type: string

Адрес склада отправления.

Example: example

name

Type: string

Наименование склада отправления.

Example: example
Example
{
  "id": 1,
  "name": "example",
  "address": "example"
}

DeliveryServiceDTO

Служба доставки.

Name

Description

id

Type: integer

Идентификатор службы доставки.

name

Type: string

Название службы доставки.

Example: example
Example
{
  "id": 0,
  "name": "example"
}

PalletsCountDTO

Количество палет в отгрузке.

Name

Description

fact

Type: integer

Количество палет, которое приняли в сортировочном центре.

Min value: 0

planned

Type: integer

Количество палет, которое заявил продавец.

Min value: 0
Example
{
  "planned": 0,
  "fact": 0
}

SignatureDTO

Информация о подписи акта приема-передачи.

Name

Description

signed

Type: boolean

Подписан ли акт приема-передачи.
Example
{
  "signed": true
}

BaseShipmentDTO

Информация об отгрузке.

Name

Description

draftCount

Type: integer

Количество заказов, которое Маркет запланировал к отгрузке.

Min value: 0

factCount

Type: integer

Количество заказов, принятых в сортировочном центре или пункте приема.

Min value: 0

id

Type: integer

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

Min value: 1

orderIds

Type: integer[]

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

Unique items: true

Example
[
  1
]

planIntervalFrom

Type: string<date-time>

Начало планового интервала отгрузки.

Формат даты: ISO 8601 со смещением относительно UTC.

Example: 2017-11-21T00:00:00+03:00

planIntervalTo

Type: string<date-time>

Конец планового интервала отгрузки.

Формат даты: ISO 8601 со смещением относительно UTC.

Example: 2017-11-21T00:00:00+03:00

plannedCount

Type: integer

Количество заказов, которое Маркет подтвердил к отгрузке.

Min value: 0

signature

Type: SignatureDTO

Информация о подписи акта приема-передачи.

Example
{
  "signed": true
}

deliveryService

Type: DeliveryServiceDTO

Служба доставки.

Example
{
  "id": 0,
  "name": "example"
}

externalId

Type: string

Идентификатор отгрузки в вашей системе. Если вы еще не передавали идентификатор, вернется идентификатор из параметра id.

Example: example

palletsCount

Type: PalletsCountDTO

Данные о палетах в отгрузке.

Количество палет в отгрузке.

Example
{
  "planned": 0,
  "fact": 0
}

shipmentType

Type: ShipmentType

Способ отгрузки заказов.

Способ отгрузки заказов:

  • IMPORT — вы самостоятельно привозите заказы в выбранный сортировочный центр или пункт приема заказов.
  • WITHDRAW — вы отгружаете заказы со своего склада курьерам Яндекс Маркета.

Enum: IMPORT, WITHDRAW

warehouse

Type: PartnerShipmentWarehouseDTO

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

Example
{
  "id": 1,
  "name": "example",
  "address": "example"
}

warehouseTo

Type: PartnerShipmentWarehouseDTO

Данные о складе назначения.

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

Example
{
  "id": 1,
  "name": "example",
  "address": "example"
}
Example
{
  "id": 1,
  "planIntervalFrom": "2017-11-21T00:00:00+03:00",
  "planIntervalTo": "2017-11-21T00:00:00+03:00",
  "shipmentType": "IMPORT",
  "warehouse": {
    "id": 1,
    "name": "example",
    "address": "example"
  },
  "warehouseTo": null,
  "externalId": "example",
  "deliveryService": {
    "id": 0,
    "name": "example"
  },
  "palletsCount": {
    "planned": 0,
    "fact": 0
  },
  "orderIds": [
    1
  ],
  "draftCount": 0,
  "plannedCount": 0,
  "factCount": 0,
  "signature": {
    "signed": true
  }
}

ShipmentInfoDTO

Список с информацией об отгрузках.

Type: object

All of 2 types

  • Type: BaseShipmentDTO

    Информация об отгрузке.

    Example
    {
  "id": 1,
  "planIntervalFrom": "2017-11-21T00:00:00+03:00",
  "planIntervalTo": "2017-11-21T00:00:00+03:00",
  "shipmentType": "IMPORT",
  "warehouse": {
    "id": 1,
    "name": "example",
    "address": "example"
  },
  "warehouseTo": null,
  "externalId": "example",
  "deliveryService": {
    "id": 0,
    "name": "example"
  },
  "palletsCount": {
    "planned": 0,
    "fact": 0
  },
  "orderIds": [
    1
  ],
  "draftCount": 0,
  "plannedCount": 0,
  "factCount": 0,
  "signature": {
    "signed": true
  }
}
  • Type: object

    status

    Type: ShipmentStatusType

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

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

    • OUTBOUND_CREATED — формируется.
    • OUTBOUND_READY_FOR_CONFIRMATION — можно обрабатывать.
    • OUTBOUND_CONFIRMED — подтверждена и готова к отправке.
    • OUTBOUND_SIGNED — по ней подписан электронный акт приема-передачи.
    • ACCEPTED — принята в сортировочном центре или пункте приема.
    • ACCEPTED_WITH_DISCREPANCIES — принята с расхождениями.
    • FINISHED — завершена.
    • ERROR — отменена из-за ошибки.

    Enum: OUTBOUND_CREATED, OUTBOUND_READY_FOR_CONFIRMATION, OUTBOUND_CONFIRMED, OUTBOUND_SIGNED, FINISHED, ACCEPTED, ACCEPTED_WITH_DISCREPANCIES, ERROR

    statusDescription

    Type: string

    Описание статуса отгрузки.

    Example: example

    statusUpdateTime

    Type: string<date-time>

    Время последнего изменения статуса отгрузки

    Формат даты: ISO 8601 со смещением относительно UTC.

    Example: 2017-11-21T00:00:00+03:00
    Example
    {
  "status": "OUTBOUND_CREATED",
  "statusDescription": "example",
  "statusUpdateTime": "2017-11-21T00:00:00+03:00"
}
Example
{
  "id": 1,
  "planIntervalFrom": "2017-11-21T00:00:00+03:00",
  "planIntervalTo": "2017-11-21T00:00:00+03:00",
  "shipmentType": "IMPORT",
  "warehouse": {
    "id": 1,
    "name": "example",
    "address": "example"
  },
  "warehouseTo": null,
  "externalId": "example",
  "deliveryService": {
    "id": 0,
    "name": "example"
  },
  "palletsCount": {
    "planned": 0,
    "fact": 0
  },
  "orderIds": [
    1
  ],
  "draftCount": 0,
  "plannedCount": 0,
  "factCount": 0,
  "signature": {
    "signed": true
  },
  "status": "OUTBOUND_CREATED",
  "statusDescription": "example",
  "statusUpdateTime": "2017-11-21T00:00:00+03:00"
}

ForwardScrollingPagerDTO

Идентификатор следующей страницы.

Name

Description

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

Example: example
Example
{
  "nextPageToken": "example"
}

SearchShipmentsResponseDTO

Информация об отгрузках.

Name

Description

shipments

Type: ShipmentInfoDTO[]

Список с информацией об отгрузках.

Example
[
  {
    "id": 1,
    "planIntervalFrom": "2017-11-21T00:00:00+03:00",
    "planIntervalTo": "2017-11-21T00:00:00+03:00",
    "shipmentType": "IMPORT",
    "warehouse": {
      "id": 1,
      "name": "example",
      "address": "example"
    },
    "warehouseTo": null,
    "externalId": "example",
    "deliveryService": {
      "id": 0,
      "name": "example"
    },
    "palletsCount": {
      "planned": 0,
      "fact": 0
    },
    "orderIds": [
      1
    ],
    "draftCount": 0,
    "plannedCount": 0,
    "factCount": 0,
    "signature": {
      "signed": true
    },
    "status": "OUTBOUND_CREATED",
    "statusDescription": "example",
    "statusUpdateTime": "2017-11-21T00:00:00+03:00"
  }
]

paging

Type: ForwardScrollingPagerDTO

Страницы с результатами поиска.

Идентификатор следующей страницы.

Example
{
  "nextPageToken": "example"
}
Example
{
  "shipments": [
    {
      "id": 1,
      "planIntervalFrom": "2017-11-21T00:00:00+03:00",
      "planIntervalTo": "2017-11-21T00:00:00+03:00",
      "shipmentType": "IMPORT",
      "warehouse": {
        "id": 1,
        "name": "example",
        "address": "example"
      },
      "warehouseTo": null,
      "externalId": "example",
      "deliveryService": {
        "id": 0,
        "name": "example"
      },
      "palletsCount": {
        "planned": 0,
        "fact": 0
      },
      "orderIds": [
        1
      ],
      "draftCount": 0,
      "plannedCount": 0,
      "factCount": 0,
      "signature": {
        "signed": true
      },
      "status": "OUTBOUND_CREATED",
      "statusDescription": "example",
      "statusUpdateTime": "2017-11-21T00:00:00+03:00"
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}

400 Bad Request

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

ApiErrorDTO

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

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

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

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

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

401 Unauthorized

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

403 Forbidden

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

404 Not Found

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

420 Method Failure

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

No longer supported, please use an alternative and newer version.

Предыдущая
Информация об одной отгрузке
Следующая
Подтверждение отгрузки