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

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/v2/campaigns/{campaignId}/orders/{orderId}/documents

Path parameters

Name

Description

campaignId

Type: integer

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

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

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

⚠️ Не путайте его с:

идентификатором магазина, который отображается в личном кабинете продавца;
рекламными кампаниями.

Min value: 1

orderId

Type: integer

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

Responses

200 OK

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

Body

application/json

{
  "status": "OK",
  "result": {
    "upd": {
      "status": "READY",
      "number": "example",
      "date": "2025-01-01"
    },
    "ukd": null,
    "torgTwelve": null,
    "sf": null,
    "ksf": null
  }
}

Type: object

All of 2 types

Type: ApiResponse

Стандартная обертка для ответов сервера.
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: OrderBusinessDocumentsDTO

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

Example

{
  "upd": {
    "status": "READY",
    "number": "example",
    "date": "2025-01-01"
  },
  "ukd": null,
  "torgTwelve": null,
  "sf": null,
  "ksf": null
}

Example

{
  "result": {
    "upd": {
      "status": "READY",
      "number": "example",
      "date": "2025-01-01"
    },
    "ukd": null,
    "torgTwelve": null,
    "sf": null,
    "ksf": null
  }
}

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

Example

{
  "status": "OK"
}

OrderDocumentStatusType

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

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

Type: string

Enum: READY, NOT_READY

DocumentDTO

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

Name	Description
date	Type: string<date> Дата создания документа. Формат даты: `ГГГГ-ММ-ДД`. Example: `2025-01-01`
number	Type: string Номер документа. Example: `example`
status	Type: OrderDocumentStatusType Статус документа. Статус документа: `READY` — готов. `NOT_READY` — не готов. Enum: `READY`, `NOT_READY`

Example

{
  "status": "READY",
  "number": "example",
  "date": "2025-01-01"
}

OrderBusinessDocumentsDTO

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

Name	Description
ksf	Type: DocumentDTO Информация о корректировочном счете-фактуре. Информация о документе. Example `{ "status": "READY", "number": "example", "date": "2025-01-01" }`
sf	Type: DocumentDTO Информация о счете-фактуре. Информация о документе. Example `{ "status": "READY", "number": "example", "date": "2025-01-01" }`
torgTwelve	Type: DocumentDTO Информация о товарной накладной. Информация о документе. Example `{ "status": "READY", "number": "example", "date": "2025-01-01" }`
ukd	Type: DocumentDTO Информация об УКД-1 или УКД-2. Информация о документе. Example `{ "status": "READY", "number": "example", "date": "2025-01-01" }`
upd	Type: DocumentDTO Информация об УПД-1 или УПД-2. Информация о документе. Example `{ "status": "READY", "number": "example", "date": "2025-01-01" }`

Example

{
  "upd": {
    "status": "READY",
    "number": "example",
    "date": "2025-01-01"
  },
  "ukd": null,
  "torgTwelve": null,
  "sf": null,
  "ksf": null
}

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибках при работе с заказами

Body

application/json

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

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

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

ApiErrorDTO

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

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: example

Example

{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

Type: ApiResponse

Стандартная обертка для ответов сервера.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: ApiErrorDTO[] | null

Список ошибок.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Example

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

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json

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

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

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

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json

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

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

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

404 Not Found

Запрашиваемый ресурс не найден. Подробнее об ошибке

Body

application/json

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

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

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

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json

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

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

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

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json

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

Type: object

All of 1 type

Type: ApiErrorResponse

Стандартная обертка для ошибок сервера.

Example

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

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

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

Информация об одной отгрузке