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

Info

Console

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

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

supplies-management:read-only — Получение информации по FBY-заявкам
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

Возвращает список товаров в заявке и информацию по ним.

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

Request

POST

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

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

{
    "requestId": 0
}

Name

Description

requestId*

Type: integer<int64>

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

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

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

Min value: 1

Responses

200 OK

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

Body

application/json

{
    "status": "OK",
    "result": {
        "items": [
            {
                "offerId": "string",
                "name": "string",
                "price": {
                    "value": 0,
                    "currencyId": "RUR"
                },
                "counters": {
                    "planCount": 0,
                    "factCount": 0,
                    "surplusCount": 0,
                    "shortageCount": 0,
                    "defectCount": 0
                }
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

status*

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

result

Type: GetSupplyRequestItemsDTO

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

ApiResponseStatusType

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

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

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

GetSupplyRequestItemsDTO

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

Name

Description

items*

Type: SupplyRequestItemDTO[]

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

Min items: 0

Max items: 100

paging

Type: ForwardScrollingPagerDTO

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

SupplyRequestItemDTO

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

Name	Description
counters*	Type: SupplyRequestItemCountersDTO Количество товаров в заявке.
name*	Type: string Название товара.
offerId*	Type: string Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU: У каждого товара SKU должен быть свой. Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге. SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Что такое SKU и как его назначать Min length: `1` Max length: `255` Pattern: `^(?=.\S.)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$`
price	Type: CurrencyValueDTO Валюта и ее значение.

ForwardScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

SupplyRequestItemCountersDTO

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

Name	Description
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`

CurrencyValueDTO

Валюта и ее значение.

Name

Description

currencyId*

Type: CurrencyType

Валюта.

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

value*

Type: number

Значение.

CurrencyType

Коды валют:

RUR — российский рубль.
UAH — украинская гривна.
BYR — белорусский рубль.
KZT — казахстанский тенге.
UZS — узбекский сум.

Type

Description

CurrencyType

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

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

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

Документы по заявке