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

Info

Console

Метод доступен для всех моделей.

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

inventory-and-order-processing — Обработка заказов и учёт товаров
inventory-and-order-processing:read-only — Просмотр информации о заказах
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всей информации в кабинете

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

Получить данные можно после того, как заказ перейдет в статус DELIVERED.

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

Request

POST

https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/documents

Path parameters

Name

Description

campaignId*

Type: integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

orderId*

Type: integer<int64>

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

Responses

200 OK

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

Body

application/json

{
    "status": "OK",
    "result": {
        "upd": {
            "status": "READY",
            "number": "string",
            "date": "string"
        },
        "ukd": {
            "status": "READY",
            "number": "string",
            "date": "string"
        },
        "torgTwelve": {
            "status": "READY",
            "number": "string",
            "date": "string"
        },
        "sf": {
            "status": "READY",
            "number": "string",
            "date": "string"
        },
        "ksf": {
            "status": "READY",
            "number": "string",
            "date": "string"
        }
    }
}

Name

Description

result

Type: OrderBusinessDocumentsDTO

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

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

OrderBusinessDocumentsDTO

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

Name	Description
ksf	Type: DocumentDTO Информация о корректировочном счете-фактуре.
sf	Type: DocumentDTO Информация о счете-фактуре.
torgTwelve	Type: DocumentDTO Информация о товарной накладной.
ukd	Type: DocumentDTO Информация об УКД-1 или УКД-2.
upd	Type: DocumentDTO Информация об УПД-1 или УПД-2.

ApiResponseStatusType

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

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

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

DocumentDTO

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

Name	Description
date	Type: string<date> Дата создания документа.
number	Type: string Номер документа.
status	Type: OrderDocumentStatusType Статус документа. Enum: `READY`, `NOT_READY`

OrderDocumentStatusType

Статус документа:

READY — готов.
NOT_READY — не готов.

Type	Description
OrderDocumentStatusType	Enum: `READY`, `NOT_READY`

400 Bad Request

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

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[]

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

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[]

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

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[]

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

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[]

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

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[]

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

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

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

Информация о покупателе

Передача количества упаковок