Информация о документах
Возвращает информацию о документах по идентификатору заказа.
Получить данные можно после того, как заказ перейдет в статус DELIVERED.
Если у вас настроена работа с push-компонентом, Маркет отправит уведомление о смене статуса заказа с помощью запроса POST order/status.
| ⚙️ Лимит: 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. |
|
orderId* |
Type: integer<int64> Идентификатор заказа. |
Responses
200 OK
Информация о документах.
Body
{
"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 |
|
status |
Type: ApiResponseStatusType Тип ответа.
|
|
result |
Type: OrderBusinessDocumentsDTO Информация о документах. |
OrderBusinessDocumentsDTO
Информация о документах.
|
Name |
Description |
|
upd |
Type: DocumentDTO Информация об УПД-1 или УПД-2. |
|
ukd |
Type: DocumentDTO Информация об УКД-1 или УКД-2. |
|
torgTwelve |
Type: DocumentDTO Информация о товарной накладной. |
|
sf |
Type: DocumentDTO Информация о счете-фактуре. |
|
ksf |
Type: DocumentDTO Информация о корректировочном счете-фактуре. |
DocumentDTO
Информация о документе.
|
Name |
Description |
|
status |
Type: OrderDocumentStatusType Статус документа.
|
|
number |
Type: string Номер документа. |
|
date |
Type: string<date> Дата создания документа. |
OrderDocumentStatusType
Статус документа:
READY— готов.NOT_READY— не готов.
|
Type |
Description |
|
Enum: |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа.
|
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Description |
|
code* |
Type: string Код ошибки. |
|
message |
Type: string Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа.
|
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа.
|
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа.
|
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа.
|
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа.
|
|
errors |
Type: ApiErrorDTO[] Список ошибок. |