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

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

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

Возвращает документы по заявке.

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

Request

POST

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

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

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

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

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

Min value: 1

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": {
        "documents": [
            {
                "type": "SUPPLY",
                "url": "string",
                "createdAt": "2022-12-29T18:02:01Z"
            }
        ]
    }
}

Name

Description

status*

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

result

Type: GetSupplyRequestDocumentsDTO

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

ApiResponseStatusType

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

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

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GetSupplyRequestDocumentsDTO

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

Name

Description

documents*

Type: SupplyRequestDocumentDTO[]

Список документов.
Документ по заявке.

Min items: 0

SupplyRequestDocumentDTO

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

Name

Description

createdAt*

Type: string<date-time>

Дата и время создания документа.

type*

Type: SupplyRequestDocumentType

Тип документа:

  • Документы, которые загружает магазин

    • SUPPLY — список товаров.
    • ADDITIONAL_SUPPLY — список товаров в дополнительной поставке.
    • VIRTUAL_DISTRIBUTION_CENTER_SUPPLY — список товаров в мультипоставке.
    • TRANSFER — список товаров для утилизации.
    • WITHDRAW — список товаров для вывоза.

  • Поставка товаров

    • VALIDATION_ERRORS — ошибки по товарам в поставке.
    • CARGO_UNITS — ярлыки для грузомест.

  • Дополнительная поставка и непринятые товары

    • ADDITIONAL_SUPPLY_ACCEPTABLE_GOODS — товары, которые подходят для дополнительной поставки.
    • ADDITIONAL_SUPPLY_UNACCEPTABLE_GOODS — вывоз непринятых товаров.

  • Маркировка товаров

    • INBOUND_UTD — входящий УПД.
    • OUTBOUND_UTD — исходящий УПД.
    • IDENTIFIERS — коды маркировки товаров.
    • CIS_FACT — принятые товары с кодами маркировки.
    • ITEMS_WITH_CISES — товары, для которых нужна маркировка.
    • REPORT_OF_WITHDRAW_WITH_CISES — маркированные товары для вывоза со склада.
    • SECONDARY_ACCEPTANCE_CISES — маркированные товары, которые приняты после вторичной приемки.
    • RNPT_FACT — принятые товары с регистрационным номером партии товара (РНПТ).

  • Акты

    • ACT_OF_WITHDRAW — акт возврата.
    • ANOMALY_CONTAINERS_WITHDRAW_ACT — акт изъятия непринятого товара.
    • ACT_OF_WITHDRAW_FROM_STORAGE — акт списания с ответственного хранения.
    • ACT_OF_RECEPTION_TRANSFER — акт приема-передачи.
    • ACT_OF_DISCREPANCY — акт о расхождениях.
    • SECONDARY_RECEPTION_ACT — акт вторичной приемки.

Enum: SUPPLY, ADDITIONAL_SUPPLY, VIRTUAL_DISTRIBUTION_CENTER_SUPPLY, TRANSFER, INBOUND_UTD, OUTBOUND_UTD, ADDITIONAL_SUPPLY_ACCEPTABLE_GOODS, ADDITIONAL_SUPPLY_UNACCEPTABLE_GOODS, VALIDATION_ERRORS, WITHDRAW, ACT_OF_WITHDRAW, ANOMALY_CONTAINERS_WITHDRAW_ACT, ACT_OF_WITHDRAW_FROM_STORAGE, ACT_OF_RECEPTION_TRANSFER, ACT_OF_DISCREPANCY, SECONDARY_RECEPTION_ACT, CARGO_UNITS, IDENTIFIERS, CIS_FACT, ITEMS_WITH_CISES, REPORT_OF_WITHDRAW_WITH_CISES, SECONDARY_ACCEPTANCE_CISES, RNPT_FACT

url*

Type: string

Ссылка на документ.

Min length: 1

Max length: 2000

SupplyRequestDocumentType

Тип документа:

  • Документы, которые загружает магазин

    • SUPPLY — список товаров.
    • ADDITIONAL_SUPPLY — список товаров в дополнительной поставке.
    • VIRTUAL_DISTRIBUTION_CENTER_SUPPLY — список товаров в мультипоставке.
    • TRANSFER — список товаров для утилизации.
    • WITHDRAW — список товаров для вывоза.

  • Поставка товаров

    • VALIDATION_ERRORS — ошибки по товарам в поставке.
    • CARGO_UNITS — ярлыки для грузомест.

  • Дополнительная поставка и непринятые товары

    • ADDITIONAL_SUPPLY_ACCEPTABLE_GOODS — товары, которые подходят для дополнительной поставки.
    • ADDITIONAL_SUPPLY_UNACCEPTABLE_GOODS — вывоз непринятых товаров.

  • Маркировка товаров

    • INBOUND_UTD — входящий УПД.
    • OUTBOUND_UTD — исходящий УПД.
    • IDENTIFIERS — коды маркировки товаров.
    • CIS_FACT — принятые товары с кодами маркировки.
    • ITEMS_WITH_CISES — товары, для которых нужна маркировка.
    • REPORT_OF_WITHDRAW_WITH_CISES — маркированные товары для вывоза со склада.
    • SECONDARY_ACCEPTANCE_CISES — маркированные товары, которые приняты после вторичной приемки.
    • RNPT_FACT — принятые товары с регистрационным номером партии товара (РНПТ).

  • Акты

    • ACT_OF_WITHDRAW — акт возврата.
    • ANOMALY_CONTAINERS_WITHDRAW_ACT — акт изъятия непринятого товара.
    • ACT_OF_WITHDRAW_FROM_STORAGE — акт списания с ответственного хранения.
    • ACT_OF_RECEPTION_TRANSFER — акт приема-передачи.
    • ACT_OF_DISCREPANCY — акт о расхождениях.
    • SECONDARY_RECEPTION_ACT — акт вторичной приемки.

Type

Description

SupplyRequestDocumentType

Enum: SUPPLY, ADDITIONAL_SUPPLY, VIRTUAL_DISTRIBUTION_CENTER_SUPPLY, TRANSFER, INBOUND_UTD, OUTBOUND_UTD, ADDITIONAL_SUPPLY_ACCEPTABLE_GOODS, ADDITIONAL_SUPPLY_UNACCEPTABLE_GOODS, VALIDATION_ERRORS, WITHDRAW, ACT_OF_WITHDRAW, ANOMALY_CONTAINERS_WITHDRAW_ACT, ACT_OF_WITHDRAW_FROM_STORAGE, ACT_OF_RECEPTION_TRANSFER, ACT_OF_DISCREPANCY, SECONDARY_RECEPTION_ACT, CARGO_UNITS, IDENTIFIERS, CIS_FACT, ITEMS_WITH_CISES, REPORT_OF_WITHDRAW_WITH_CISES, SECONDARY_ACCEPTANCE_CISES, RNPT_FACT

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

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

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

Предыдущая
Товары в заявке
Следующая
Одна точка продаж