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

Метод доступен для модели 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<int64>

Идентификатор кампании.

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

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

⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

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

Min value: 1
Example: 20

page_token

Type: string

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

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

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

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

Body

application/json
{
    "requestIds": [
        0
    ],
    "requestDateFrom": "2022-12-29T18:02:01Z",
    "requestDateTo": "2022-12-29T18:02:01Z",
    "requestTypes": [
        "SUPPLY"
    ],
    "requestSubtypes": [
        "DEFAULT"
    ],
    "requestStatuses": [
        "CREATED"
    ],
    "sorting": {
        "direction": "ASC",
        "attribute": "ID"
    }
}

Name

Description

requestDateFrom

Type: string<date-time>

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

requestDateTo

Type: string<date-time>

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

requestIds

Type: integer<int64>[]

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

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

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

Min value: 1

Min items: 1

Max items: 100

Unique items  

requestStatuses

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 — товары готовы к выдаче.

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

Min items: 1

Unique items  

requestSubtypes

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

Min items: 1

Unique items  

requestTypes

Type: SupplyRequestType[]

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

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

Enum: SUPPLY, WITHDRAW, UTILIZATION

Min items: 1

Unique items  

sorting

Type: SupplyRequestSortingDTO

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

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 — товары готовы к выдаче.

Type

Description

SupplyRequestStatusType

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

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

Description

SupplyRequestSubType

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

SupplyRequestType

Тип заявки:

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

Type

Description

SupplyRequestType

Enum: SUPPLY, WITHDRAW, UTILIZATION

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

SupplyRequestSortAttributeType

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

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

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

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

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

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

Type

Description

SupplyRequestSortAttributeType

Enum: ID, REQUESTED_DATE, UPDATED_AT, STATUS

SortOrderType

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

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

Type

Description

SortOrderType

Enum: ASC, DESC

Responses

200 OK

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

Body

application/json
{
    "status": "OK",
    "result": {
        "requests": [
            {
                "id": {
                    "id": 0,
                    "marketplaceRequestId": "string",
                    "warehouseRequestId": "string"
                },
                "type": "SUPPLY",
                "subtype": "DEFAULT",
                "status": "CREATED",
                "updatedAt": "2022-12-29T18:02:01Z",
                "counters": {
                    "planCount": 0,
                    "factCount": 0,
                    "undefinedCount": 0,
                    "surplusCount": 0,
                    "shortageCount": 0,
                    "defectCount": 0,
                    "acceptableCount": 0,
                    "unacceptableCount": 0,
                    "actualPalletsCount": 0,
                    "actualBoxCount": 0
                },
                "parentLink": {
                    "id": {
                        "id": 0,
                        "marketplaceRequestId": "string",
                        "warehouseRequestId": "string"
                    },
                    "type": "VIRTUAL_DISTRIBUTION"
                },
                "childrenLinks": [
                    {
                        "id": {
                            "id": 0,
                            "marketplaceRequestId": "string",
                            "warehouseRequestId": "string"
                        },
                        "type": "VIRTUAL_DISTRIBUTION"
                    }
                ],
                "targetLocation": {
                    "requestedDate": "2022-12-29T18:02:01Z",
                    "serviceId": 0,
                    "name": "string",
                    "address": {
                        "fullAddress": "string",
                        "gps": {
                            "latitude": 0,
                            "longitude": 0
                        }
                    },
                    "type": "FULFILLMENT"
                },
                "transitLocation": {
                    "requestedDate": "2022-12-29T18:02:01Z",
                    "serviceId": 0,
                    "name": "string",
                    "address": {
                        "fullAddress": "string",
                        "gps": {
                            "latitude": 0,
                            "longitude": 0
                        }
                    },
                    "type": "FULFILLMENT"
                }
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

status*

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

result

Type: GetSupplyRequestsDTO

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

ApiResponseStatusType

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

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

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GetSupplyRequestsDTO

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

Name

Description

requests*

Type: SupplyRequestDTO[]

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

Min items: 0

Max items: 100

paging

Type: ForwardScrollingPagerDTO

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

SupplyRequestDTO

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

Name

Description

counters*

Type: SupplyRequestCountersDTO

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

id*

Type: SupplyRequestIdDTO

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

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 — товары готовы к выдаче.

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

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

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

type*

Type: SupplyRequestType

Тип заявки:

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

Enum: SUPPLY, WITHDRAW, UTILIZATION

updatedAt*

Type: string<date-time>

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

childrenLinks

Type: SupplyRequestReferenceDTO[]

Ссылки на дочерние заявки.
Информация о связанных заявках.

Min items: 1

parentLink

Type: SupplyRequestReferenceDTO

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

transitLocation

Type: SupplyRequestLocationDTO

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

ForwardScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

SupplyRequestCountersDTO

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

Name

Description

acceptableCount

Type: integer<int32>

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

Min value: 0

actualBoxCount

Type: integer<int32>

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

Min value: 0

actualPalletsCount

Type: integer<int32>

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

Min value: 0

defectCount

Type: integer<int32>

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

Min value: 0

factCount

Type: integer<int32>

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

Min value: 0

planCount

Type: integer<int32>

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

Min value: 0

shortageCount

Type: integer<int32>

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

Min value: 0

surplusCount

Type: integer<int32>

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

Min value: 0

unacceptableCount

Type: integer<int32>

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

Min value: 0

undefinedCount

Type: integer<int32>

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

Min value: 0

SupplyRequestIdDTO

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

Name

Description

id*

Type: integer<int64>

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

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

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

Min value: 1

marketplaceRequestId

Type: string

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

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

warehouseRequestId

Type: string

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

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

SupplyRequestLocationDTO

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

Name

Description

address*

Type: SupplyRequestLocationAddressDTO

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

name*

Type: string

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

serviceId*

Type: integer<int64>

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

type*

Type: SupplyRequestLocationType

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

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

Enum: FULFILLMENT, XDOC, PICKUP_POINT

requestedDate

Type: string<date-time>

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

SupplyRequestReferenceDTO

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

Name

Description

id*

Type: SupplyRequestIdDTO

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

type*

Type: SupplyRequestReferenceType

Тип связи.

Enum: VIRTUAL_DISTRIBUTION, WITHDRAW, UTILIZATION, ADDITIONAL_SUPPLY

SupplyRequestLocationAddressDTO

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

Name

Description

fullAddress*

Type: string

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

gps*

Type: GpsDTO

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

SupplyRequestLocationType

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

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

Type

Description

SupplyRequestLocationType

Enum: FULFILLMENT, XDOC, PICKUP_POINT

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

Description

SupplyRequestReferenceType

Enum: VIRTUAL_DISTRIBUTION, WITHDRAW, UTILIZATION, ADDITIONAL_SUPPLY

GpsDTO

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

Name

Description

latitude*

Type: number

Широта.

longitude*

Type: number

Долгота.

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

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

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

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

Предыдущая
Информация о возможности печати ярлыков (FBS)
Следующая
Товары в заявке