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

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

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

По указанным фильтрам возвращает заявки на поставку, вывоз и утилизацию, а также информацию по ним.

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

Request

POST

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/supply-requests

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
{
  "requestIds": [
    1
  ],
  "requestDateFrom": "2025-01-01T00:00:00Z",
  "requestDateTo": "2025-01-01T00:00:00Z",
  "requestTypes": [
    "SUPPLY"
  ],
  "requestSubtypes": [
    "DEFAULT"
  ],
  "requestStatuses": [
    "CREATED"
  ],
  "sorting": {
    "direction": "ASC",
    "attribute": "ID"
  }
}

Name

Description

requestDateFrom

Type: string<date-time> | null

Дата начала периода для фильтрации заявок.

Example: 2025-01-01T00:00:00Z

requestDateTo

Type: string<date-time> | null

Дата окончания периода для фильтрации заявок.

Example: 2025-01-01T00:00:00Z

requestIds

Type: SupplyRequestId[] | null

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

Min items: 1

Max items: 100

Unique items: true

Example
[
  1
]

requestStatuses

Type: SupplyRequestStatusType[] | null

Статусы заявок для фильтрации.

Min items: 1

Unique items: true

Example
[
  "CREATED"
]

requestSubtypes

Type: SupplyRequestSubType[] | null

Подтипы заявок для фильтрации.

Min items: 1

Unique items: true

Example
[
  "DEFAULT"
]

requestTypes

Type: SupplyRequestType[] | null

Типы заявок для фильтрации.

Min items: 1

Unique items: true

Example
[
  "SUPPLY"
]

sorting

Type: SupplyRequestSortingDTO

Параметры сортировки.

Example
{
  "direction": "ASC",
  "attribute": "ID"
}

SupplyRequestId

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

Используется только в API

По нему не получится найти заявки в кабинете продавца на Маркете. Для этого используйте marketplaceRequestId или warehouseRequestId.

Type: integer

Min value: 1

SupplyRequestType

Тип заявки:

  • SUPPLY — поставка товаров.
  • WITHDRAW — вывоз товаров.
  • UTILIZATION — утилизация товаров.

Type: string

Enum: SUPPLY, WITHDRAW, UTILIZATION

SupplyRequestSubType

Подтип заявки:

  • DEFAULT — поставка товаров на склад хранения или вывоз с него.

  • XDOC — поставка товаров через транзитный склад или вывоз с него.

  • INVENTORYING_SUPPLY — инвентаризация на складе по запросу магазина.

  • INVENTORYING_SUPPLY_WAREHOUSE_BASED_PER_SUPPLIER — инвентаризация на складе по запросу склада.

  • MOVEMENT_SUPPLY — входящее перемещение между складами.

    При перемещении между складами создаются 2 заявки — MOVEMENT_SUPPLY и MOVEMENT_WITHDRAW.

  • ADDITIONAL_SUPPLY — дополнительная поставка непринятых товаров.

  • VIRTUAL_DISTRIBUTION_CENTER — родительская заявка при поставке товаров на склад хранения или мультипоставке.

  • VIRTUAL_DISTRIBUTION_CENTER_CHILD — дочерняя заявка при поставке товаров на склад хранения или мультипоставке.

    Для нее не возвращается transitLocation.

  • FORCE_PLAN — автоматическая утилизация по запросу склада.

  • FORCE_PLAN_ANOMALY_PER_SUPPLY — утилизация непринятых товаров.

  • PLAN_BY_SUPPLIER — утилизация по запросу магазина.

  • ANOMALY_WITHDRAW — вывоз непринятых товаров.

  • FIX_LOST_INVENTORYING — товары, которые не нашли после второй инвентаризации.

  • OPER_LOST_INVENTORYING — товары, которые не нашли после первой инвентаризации.

  • MOVEMENT_WITHDRAW — исходящее перемещение между складами.

    При перемещении между складами создаются 2 заявки — MOVEMENT_SUPPLY и MOVEMENT_WITHDRAW.

  • MISGRADING_SUPPLY — пересортица в большую сторону.

  • MISGRADING_WITHDRAW — пересортица в меньшую сторону.

  • MAN_UTIL — ручная утилизация по запросу склада.

  • WITHDRAW_AUTO_UTILIZATION — автоматическая утилизация товаров в заявке на вывоз, когда истек срок их хранения.

Type: string

Enum: DEFAULT, XDOC, INVENTORYING_SUPPLY, INVENTORYING_SUPPLY_WAREHOUSE_BASED_PER_SUPPLIER, MOVEMENT_SUPPLY, ADDITIONAL_SUPPLY, VIRTUAL_DISTRIBUTION_CENTER, VIRTUAL_DISTRIBUTION_CENTER_CHILD, FORCE_PLAN, FORCE_PLAN_ANOMALY_PER_SUPPLY, PLAN_BY_SUPPLIER, ANOMALY_WITHDRAW, FIX_LOST_INVENTORYING, OPER_LOST_INVENTORYING, MOVEMENT_WITHDRAW, MISGRADING_SUPPLY, MISGRADING_WITHDRAW, MAN_UTIL, WITHDRAW_AUTO_UTILIZATION

SupplyRequestStatusType

Статус заявки на поставку:

  • CREATED — создан черновик заявки.
  • FINISHED — заявка завершена, товары:
    • приняты на складе;
    • переданы на другой склад при перемещении;
    • переданы продавцу при вывозе;
    • утилизированы.
  • CANCELLED — заявка отменена.
  • INVALID — ошибка обработки.
  • VALIDATED — заявка в обработке.
  • PUBLISHED — создана заявка.
  • ARRIVED_TO_SERVICE — поставка прибыла на склад хранения.
  • ARRIVED_TO_XDOC_SERVICE — поставка прибыла на транзитный склад.
  • SHIPPED_TO_SERVICE — поставка отправлена с транзитного склада на склад хранения.
  • CANCELLATION_REQUESTED — запрошена отмена заявки.
  • CANCELLATION_REJECTED — заявка не будет отменена.
  • REGISTERED_IN_ELECTRONIC_QUEUE — поставка зарегистрирована в электронной очереди.
  • READY_FOR_UTILIZATION — товары готовы к утилизации.
  • TRANSIT_MOVING — перемещение товаров на склад вывоза.
  • WAREHOUSE_HANDLING — вторичная приемка товаров или их сборка для вывоза или утилизации.
  • ACCEPTED_BY_WAREHOUSE_SYSTEM — информация о заявке направлена на склад.
  • READY_TO_WITHDRAW — товары готовы к выдаче.
  • NEED_PREPARATION — ожидается информация от продавца.

Type: string

Enum: CREATED, FINISHED, CANCELLED, INVALID, VALIDATED, PUBLISHED, ARRIVED_TO_SERVICE, ARRIVED_TO_XDOC_SERVICE, SHIPPED_TO_SERVICE, CANCELLATION_REQUESTED, CANCELLATION_REJECTED, REGISTERED_IN_ELECTRONIC_QUEUE, READY_FOR_UTILIZATION, TRANSIT_MOVING, WAREHOUSE_HANDLING, ACCEPTED_BY_WAREHOUSE_SYSTEM, READY_TO_WITHDRAW, NEED_PREPARATION

SortOrderType

Направление сортировки:

  • ASC — сортировка по возрастанию.
  • DESC — сортировка по убыванию.

Type: string

Enum: ASC, DESC

SupplyRequestSortAttributeType

По какому параметру сортировать заявки:

  • ID — идентификатор заявки.

  • REQUESTED_DATE — дата поставки на склад хранения.

    Если товары проходили через транзитный склад, сортирует по датам поставки на оба склада.

  • UPDATED_AT — время обновления заявки.

  • STATUS — статус заявки.

Type: string

Enum: ID, REQUESTED_DATE, UPDATED_AT, STATUS

SupplyRequestSortingDTO

Параметры сортировки.

Name

Description

attribute

Type: SupplyRequestSortAttributeType

По какому параметру сортировать заявки:

  • ID — идентификатор заявки.

  • REQUESTED_DATE — дата поставки на склад хранения.

    Если товары проходили через транзитный склад, сортирует по датам поставки на оба склада.

  • UPDATED_AT — время обновления заявки.

  • STATUS — статус заявки.

Enum: ID, REQUESTED_DATE, UPDATED_AT, STATUS

direction

Type: SortOrderType

Направление сортировки:

  • ASC — сортировка по возрастанию.
  • DESC — сортировка по убыванию.

Enum: ASC, DESC
Example
{
  "direction": "ASC",
  "attribute": "ID"
}

Responses

200 OK

Список заявок и информация по ним.

Body

application/json
{
  "status": "OK",
  "result": {
    "requests": [
      {
        "id": {},
        "type": "SUPPLY",
        "subtype": "DEFAULT",
        "status": "CREATED",
        "updatedAt": "2025-01-01T00:00:00Z",
        "counters": {},
        "parentLink": {},
        "childrenLinks": [
          null
        ],
        "targetLocation": {},
        "transitLocation": null
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

Type: object

All of 2 types

  • Type: ApiResponse

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

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

    result

    Type: GetSupplyRequestsDTO

    Список заявок и информация по ним.

    Example
    {
  "requests": [
    {
      "id": {
        "id": 1,
        "marketplaceRequestId": "example",
        "warehouseRequestId": "example"
      },
      "type": "SUPPLY",
      "subtype": "DEFAULT",
      "status": "CREATED",
      "updatedAt": "2025-01-01T00:00:00Z",
      "counters": {
        "planCount": 0,
        "factCount": 0,
        "undefinedCount": 0,
        "surplusCount": 0,
        "shortageCount": 0,
        "defectCount": 0,
        "acceptableCount": 0,
        "unacceptableCount": 0,
        "actualPalletsCount": 0,
        "actualBoxCount": 0
      },
      "parentLink": {
        "id": null,
        "type": "VIRTUAL_DISTRIBUTION"
      },
      "childrenLinks": [
        null
      ],
      "targetLocation": {
        "requestedDate": "2025-01-01T00:00:00Z",
        "serviceId": 0,
        "name": "example",
        "address": {
          "fullAddress": "example",
          "gps": {}
        },
        "type": "FULFILLMENT"
      },
      "transitLocation": null
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}
    Example
    {
  "result": {
    "requests": [
      {
        "id": {
          "id": 1,
          "marketplaceRequestId": "example",
          "warehouseRequestId": "example"
        },
        "type": "SUPPLY",
        "subtype": "DEFAULT",
        "status": "CREATED",
        "updatedAt": "2025-01-01T00:00:00Z",
        "counters": {
          "planCount": 0,
          "factCount": 0,
          "undefinedCount": 0,
          "surplusCount": 0,
          "shortageCount": 0,
          "defectCount": 0,
          "acceptableCount": 0,
          "unacceptableCount": 0,
          "actualPalletsCount": 0,
          "actualBoxCount": 0
        },
        "parentLink": {
          "id": null,
          "type": "VIRTUAL_DISTRIBUTION"
        },
        "childrenLinks": [
          null
        ],
        "targetLocation": {
          "requestedDate": "2025-01-01T00:00:00Z",
          "serviceId": 0,
          "name": "example",
          "address": {},
          "type": "FULFILLMENT"
        },
        "transitLocation": null
      }
    ],
    "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"
}

SupplyRequestIdDTO

Идентификатор и номера заявки.

Name

Description

id

Type: SupplyRequestId

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

Используется только в API

По нему не получится найти заявки в кабинете продавца на Маркете. Для этого используйте marketplaceRequestId или warehouseRequestId.

Min value: 1

Example: 1

marketplaceRequestId

Type: string

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

Также указывается в кабинете продавца на Маркете.

Example: example

warehouseRequestId

Type: string

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

Также указывается в кабинете продавца на Маркете.

Example: example
Example
{
  "id": 1,
  "marketplaceRequestId": "example",
  "warehouseRequestId": "example"
}

SupplyRequestCountersDTO

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

Name

Description

acceptableCount

Type: integer

Количество товаров, которые можно привезти дополнительно.

Min value: 0

actualBoxCount

Type: integer

Количество коробок, которые приняты на складе.

Min value: 0

actualPalletsCount

Type: integer

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

Min value: 0

defectCount

Type: integer

Количество товаров с браком.

Min value: 0

factCount

Type: integer

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

Min value: 0

planCount

Type: integer

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

Min value: 0

shortageCount

Type: integer

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

Min value: 0

surplusCount

Type: integer

Количество лишних товаров.

Min value: 0

unacceptableCount

Type: integer

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

Min value: 0

undefinedCount

Type: integer

Количество непринятых товаров.

Min value: 0
Example
{
  "planCount": 0,
  "factCount": 0,
  "undefinedCount": 0,
  "surplusCount": 0,
  "shortageCount": 0,
  "defectCount": 0,
  "acceptableCount": 0,
  "unacceptableCount": 0,
  "actualPalletsCount": 0,
  "actualBoxCount": 0
}

SupplyRequestReferenceType

Тип связи между двумя заявками:

  • VIRTUAL_DISTRIBUTION — мультипоставка.

  • WITHDRAW — вывоз непринятых товаров.

    Подтипы заявки: DEFAULT, XDOC, VIRTUAL_DISTRIBUTION_CENTER_CHILD и ANOMALY_WITHDRAW.

  • UTILIZATION — утилизация непринятых товаров.

    Подтипы заявки: DEFAULT, XDOC, VIRTUAL_DISTRIBUTION_CENTER_CHILD и FORCE_PLAN_ANOMALY_PER_SUPPLY.

  • ADDITIONAL_SUPPLY — дополнительная поставка.

    Подтипы заявки: DEFAULT, XDOC, VIRTUAL_DISTRIBUTION_CENTER_CHILD и ADDITIONAL_SUPPLY.

Type: string

Enum: VIRTUAL_DISTRIBUTION, WITHDRAW, UTILIZATION, ADDITIONAL_SUPPLY

SupplyRequestReferenceDTO

Информация о связанных заявках.

Name

Description

id

Type: SupplyRequestIdDTO

Идентификаторы связанной заявки.

Идентификатор и номера заявки.

Example
{
  "id": 1,
  "marketplaceRequestId": "example",
  "warehouseRequestId": "example"
}

type

Type: SupplyRequestReferenceType

Тип связи.

Тип связи между двумя заявками:

  • VIRTUAL_DISTRIBUTION — мультипоставка.

  • WITHDRAW — вывоз непринятых товаров.

    Подтипы заявки: DEFAULT, XDOC, VIRTUAL_DISTRIBUTION_CENTER_CHILD и ANOMALY_WITHDRAW.

  • UTILIZATION — утилизация непринятых товаров.

    Подтипы заявки: DEFAULT, XDOC, VIRTUAL_DISTRIBUTION_CENTER_CHILD и FORCE_PLAN_ANOMALY_PER_SUPPLY.

  • ADDITIONAL_SUPPLY — дополнительная поставка.

    Подтипы заявки: DEFAULT, XDOC, VIRTUAL_DISTRIBUTION_CENTER_CHILD и ADDITIONAL_SUPPLY.

Enum: VIRTUAL_DISTRIBUTION, WITHDRAW, UTILIZATION, ADDITIONAL_SUPPLY
Example
{
  "id": {
    "id": 1,
    "marketplaceRequestId": "example",
    "warehouseRequestId": "example"
  },
  "type": "VIRTUAL_DISTRIBUTION"
}

GpsDTO

GPS-координаты широты и долготы.

Name

Description

latitude

Type: number

Широта.

longitude

Type: number

Долгота.
Example
{
  "latitude": 0.5,
  "longitude": 0.5
}

SupplyRequestLocationAddressDTO

Адрес склада или ПВЗ.

Name

Description

fullAddress

Type: string

Полный адрес склада или ПВЗ.

Example: example

gps

Type: GpsDTO

GPS-координаты широты и долготы.

Example
{
  "latitude": 0.5,
  "longitude": 0.5
}
Example
{
  "fullAddress": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  }
}

SupplyRequestLocationType

Тип склада или ПВЗ:

  • FULFILLMENT — склад хранения.
  • XDOC — транзитный склад.
  • PICKUP_POINT — ПВЗ.

Type: string

Enum: FULFILLMENT, XDOC, PICKUP_POINT

SupplyRequestLocationDTO

Информации о складе или ПВЗ в заявке.

Name

Description

address

Type: SupplyRequestLocationAddressDTO

Адрес склада или ПВЗ.

Example
{
  "fullAddress": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  }
}

name

Type: string

Название склада или ПВЗ.

Example: example

serviceId

Type: integer

Идентификатор склада или логистического партнера ПВЗ.

type

Type: SupplyRequestLocationType

Тип склада или ПВЗ:

  • FULFILLMENT — склад хранения.
  • XDOC — транзитный склад.
  • PICKUP_POINT — ПВЗ.

Enum: FULFILLMENT, XDOC, PICKUP_POINT

requestedDate

Type: string<date-time>

Дата и время поставки на склад или в ПВЗ.

Example: 2025-01-01T00:00:00Z
Example
{
  "requestedDate": "2025-01-01T00:00:00Z",
  "serviceId": 0,
  "name": "example",
  "address": {
    "fullAddress": "example",
    "gps": {
      "latitude": 0.5,
      "longitude": 0.5
    }
  },
  "type": "FULFILLMENT"
}

SupplyRequestDTO

Информация о заявке на поставку, вывоз или утилизацию.

Name

Description

counters

Type: SupplyRequestCountersDTO

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

Example
{
  "planCount": 0,
  "factCount": 0,
  "undefinedCount": 0,
  "surplusCount": 0,
  "shortageCount": 0,
  "defectCount": 0,
  "acceptableCount": 0,
  "unacceptableCount": 0,
  "actualPalletsCount": 0,
  "actualBoxCount": 0
}

id

Type: SupplyRequestIdDTO

Идентификатор и номера заявки.

Example
{
  "id": 1,
  "marketplaceRequestId": "example",
  "warehouseRequestId": "example"
}

status

Type: SupplyRequestStatusType

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

Статус заявки на поставку:

  • CREATED — создан черновик заявки.
  • FINISHED — заявка завершена, товары:
    • приняты на складе;
    • переданы на другой склад при перемещении;
    • переданы продавцу при вывозе;
    • утилизированы.
  • CANCELLED — заявка отменена.
  • INVALID — ошибка обработки.
  • VALIDATED — заявка в обработке.
  • PUBLISHED — создана заявка.
  • ARRIVED_TO_SERVICE — поставка прибыла на склад хранения.
  • ARRIVED_TO_XDOC_SERVICE — поставка прибыла на транзитный склад.
  • SHIPPED_TO_SERVICE — поставка отправлена с транзитного склада на склад хранения.
  • CANCELLATION_REQUESTED — запрошена отмена заявки.
  • CANCELLATION_REJECTED — заявка не будет отменена.
  • REGISTERED_IN_ELECTRONIC_QUEUE — поставка зарегистрирована в электронной очереди.
  • READY_FOR_UTILIZATION — товары готовы к утилизации.
  • TRANSIT_MOVING — перемещение товаров на склад вывоза.
  • WAREHOUSE_HANDLING — вторичная приемка товаров или их сборка для вывоза или утилизации.
  • ACCEPTED_BY_WAREHOUSE_SYSTEM — информация о заявке направлена на склад.
  • READY_TO_WITHDRAW — товары готовы к выдаче.
  • NEED_PREPARATION — ожидается информация от продавца.

Enum: CREATED, FINISHED, CANCELLED, INVALID, VALIDATED, PUBLISHED, ARRIVED_TO_SERVICE, ARRIVED_TO_XDOC_SERVICE, SHIPPED_TO_SERVICE, CANCELLATION_REQUESTED, CANCELLATION_REJECTED, REGISTERED_IN_ELECTRONIC_QUEUE, READY_FOR_UTILIZATION, TRANSIT_MOVING, WAREHOUSE_HANDLING, ACCEPTED_BY_WAREHOUSE_SYSTEM, READY_TO_WITHDRAW, NEED_PREPARATION

subtype

Type: SupplyRequestSubType

Подтип заявки.

Подтип заявки:

  • DEFAULT — поставка товаров на склад хранения или вывоз с него.

  • XDOC — поставка товаров через транзитный склад или вывоз с него.

  • INVENTORYING_SUPPLY — инвентаризация на складе по запросу магазина.

  • INVENTORYING_SUPPLY_WAREHOUSE_BASED_PER_SUPPLIER — инвентаризация на складе по запросу склада.

  • MOVEMENT_SUPPLY — входящее перемещение между складами.

    При перемещении между складами создаются 2 заявки — MOVEMENT_SUPPLY и MOVEMENT_WITHDRAW.

  • ADDITIONAL_SUPPLY — дополнительная поставка непринятых товаров.

  • VIRTUAL_DISTRIBUTION_CENTER — родительская заявка при поставке товаров на склад хранения или мультипоставке.

  • VIRTUAL_DISTRIBUTION_CENTER_CHILD — дочерняя заявка при поставке товаров на склад хранения или мультипоставке.

    Для нее не возвращается transitLocation.

  • FORCE_PLAN — автоматическая утилизация по запросу склада.

  • FORCE_PLAN_ANOMALY_PER_SUPPLY — утилизация непринятых товаров.

  • PLAN_BY_SUPPLIER — утилизация по запросу магазина.

  • ANOMALY_WITHDRAW — вывоз непринятых товаров.

  • FIX_LOST_INVENTORYING — товары, которые не нашли после второй инвентаризации.

  • OPER_LOST_INVENTORYING — товары, которые не нашли после первой инвентаризации.

  • MOVEMENT_WITHDRAW — исходящее перемещение между складами.

    При перемещении между складами создаются 2 заявки — MOVEMENT_SUPPLY и MOVEMENT_WITHDRAW.

  • MISGRADING_SUPPLY — пересортица в большую сторону.

  • MISGRADING_WITHDRAW — пересортица в меньшую сторону.

  • MAN_UTIL — ручная утилизация по запросу склада.

  • WITHDRAW_AUTO_UTILIZATION — автоматическая утилизация товаров в заявке на вывоз, когда истек срок их хранения.

Enum: DEFAULT, XDOC, INVENTORYING_SUPPLY, INVENTORYING_SUPPLY_WAREHOUSE_BASED_PER_SUPPLIER, MOVEMENT_SUPPLY, ADDITIONAL_SUPPLY, VIRTUAL_DISTRIBUTION_CENTER, VIRTUAL_DISTRIBUTION_CENTER_CHILD, FORCE_PLAN, FORCE_PLAN_ANOMALY_PER_SUPPLY, PLAN_BY_SUPPLIER, ANOMALY_WITHDRAW, FIX_LOST_INVENTORYING, OPER_LOST_INVENTORYING, MOVEMENT_WITHDRAW, MISGRADING_SUPPLY, MISGRADING_WITHDRAW, MAN_UTIL, WITHDRAW_AUTO_UTILIZATION

targetLocation

Type: SupplyRequestLocationDTO

Информация о складе хранения или ПВЗ.

Информации о складе или ПВЗ в заявке.

Example
{
  "requestedDate": "2025-01-01T00:00:00Z",
  "serviceId": 0,
  "name": "example",
  "address": {
    "fullAddress": "example",
    "gps": {
      "latitude": 0.5,
      "longitude": 0.5
    }
  },
  "type": "FULFILLMENT"
}

type

Type: SupplyRequestType

Тип заявки.

Тип заявки:

  • SUPPLY — поставка товаров.
  • WITHDRAW — вывоз товаров.
  • UTILIZATION — утилизация товаров.

Enum: SUPPLY, WITHDRAW, UTILIZATION

updatedAt

Type: string<date-time>

Дата и время последнего обновления заявки.

Example: 2025-01-01T00:00:00Z

childrenLinks

Type: SupplyRequestReferenceDTO[] | null

Ссылки на дочерние заявки.

Min items: 1

Example
[
  {
    "id": {
      "id": 1,
      "marketplaceRequestId": "example",
      "warehouseRequestId": "example"
    },
    "type": "VIRTUAL_DISTRIBUTION"
  }
]

parentLink

Type: SupplyRequestReferenceDTO | null

Ссылка на родительскую заявку.

Информация о связанных заявках.

Example
{
  "id": {
    "id": 1,
    "marketplaceRequestId": "example",
    "warehouseRequestId": "example"
  },
  "type": "VIRTUAL_DISTRIBUTION"
}

transitLocation

Type: SupplyRequestLocationDTO

Информация о транзитном складе или ПВЗ.

Информации о складе или ПВЗ в заявке.

Example
{
  "requestedDate": "2025-01-01T00:00:00Z",
  "serviceId": 0,
  "name": "example",
  "address": {
    "fullAddress": "example",
    "gps": {
      "latitude": 0.5,
      "longitude": 0.5
    }
  },
  "type": "FULFILLMENT"
}
Example
{
  "id": {
    "id": 1,
    "marketplaceRequestId": "example",
    "warehouseRequestId": "example"
  },
  "type": "SUPPLY",
  "subtype": "DEFAULT",
  "status": "CREATED",
  "updatedAt": "2025-01-01T00:00:00Z",
  "counters": {
    "planCount": 0,
    "factCount": 0,
    "undefinedCount": 0,
    "surplusCount": 0,
    "shortageCount": 0,
    "defectCount": 0,
    "acceptableCount": 0,
    "unacceptableCount": 0,
    "actualPalletsCount": 0,
    "actualBoxCount": 0
  },
  "parentLink": {
    "id": null,
    "type": "VIRTUAL_DISTRIBUTION"
  },
  "childrenLinks": [
    null
  ],
  "targetLocation": {
    "requestedDate": "2025-01-01T00:00:00Z",
    "serviceId": 0,
    "name": "example",
    "address": {
      "fullAddress": "example",
      "gps": {
        "latitude": 0.5,
        "longitude": 0.5
      }
    },
    "type": "FULFILLMENT"
  },
  "transitLocation": null
}

ForwardScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

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

GetSupplyRequestsDTO

Список заявок и информация по ним.

Name

Description

requests

Type: SupplyRequestDTO[]

Список заявок.

Min items: 0

Max items: 100

Example
[
  {
    "id": {
      "id": 1,
      "marketplaceRequestId": "example",
      "warehouseRequestId": "example"
    },
    "type": "SUPPLY",
    "subtype": "DEFAULT",
    "status": "CREATED",
    "updatedAt": "2025-01-01T00:00:00Z",
    "counters": {
      "planCount": 0,
      "factCount": 0,
      "undefinedCount": 0,
      "surplusCount": 0,
      "shortageCount": 0,
      "defectCount": 0,
      "acceptableCount": 0,
      "unacceptableCount": 0,
      "actualPalletsCount": 0,
      "actualBoxCount": 0
    },
    "parentLink": {
      "id": null,
      "type": "VIRTUAL_DISTRIBUTION"
    },
    "childrenLinks": [
      null
    ],
    "targetLocation": {
      "requestedDate": "2025-01-01T00:00:00Z",
      "serviceId": 0,
      "name": "example",
      "address": {
        "fullAddress": "example",
        "gps": {
          "latitude": 0.5,
          "longitude": 0.5
        }
      },
      "type": "FULFILLMENT"
    },
    "transitLocation": null
  }
]

paging

Type: ForwardScrollingPagerDTO

Информация о страницах с результатами.

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

Example
{
  "nextPageToken": "example"
}
Example
{
  "requests": [
    {
      "id": {
        "id": 1,
        "marketplaceRequestId": "example",
        "warehouseRequestId": "example"
      },
      "type": "SUPPLY",
      "subtype": "DEFAULT",
      "status": "CREATED",
      "updatedAt": "2025-01-01T00:00:00Z",
      "counters": {
        "planCount": 0,
        "factCount": 0,
        "undefinedCount": 0,
        "surplusCount": 0,
        "shortageCount": 0,
        "defectCount": 0,
        "acceptableCount": 0,
        "unacceptableCount": 0,
        "actualPalletsCount": 0,
        "actualBoxCount": 0
      },
      "parentLink": {
        "id": null,
        "type": "VIRTUAL_DISTRIBUTION"
      },
      "childrenLinks": [
        null
      ],
      "targetLocation": {
        "requestedDate": "2025-01-01T00:00:00Z",
        "serviceId": 0,
        "name": "example",
        "address": {
          "fullAddress": "example",
          "gps": {}
        },
        "type": "FULFILLMENT"
      },
      "transitLocation": null
    }
  ],
  "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"
    }
  ]
}

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.

О том, что это такое, читайте в Справке Маркета для продавцов.

Предыдущая
Ярлыки для доверительной приемки (FBS)
Следующая
Товары в заявке