Получение документов

Info

Console

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

Пока недоступен для продавцов Market Yandex Go.

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

offers-and-cards-management — Управление товарами и карточками
offers-and-cards-management:read-only — Просмотр товаров и карточек
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

Возвращает страницу документов на товары с учетом переданных фильтров.

⚙️ Лимит без подписки: 15 запросов в минуту ⭐️ Лимит с подпиской Медиум: 30 запросов в минуту

Request

POST

https://api.partner.market.yandex.ru/v1/businesses/{businessId}/offers/documents

Path parameters

Name

Description

businessId

Type: integer

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

Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns.

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer

Количество значений на одной странице.

Default: 50

Min value: 1

Max value: 100

pageToken

Type: string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Передавайте значение выходного параметра nextPageToken, полученное при последнем запросе.

Example: ``

Body

application/json

{
  "documentIds": [
    1
  ],
  "documentNumbers": [
    "example"
  ],
  "documentTypes": [
    "CONFORMITY_DECLARATION"
  ],
  "documentStatuses": [
    "ACTIVE"
  ]
}

Name	Description
documentIds	Type: DocumentId[] \| null Идентификаторы документов. Min items: `0` Max items: `100` Unique items: `true` Example `[ 1 ]`
documentNumbers	Type: DocumentNumber[] \| null Номера документов. Min items: `0` Max items: `100` Unique items: `true` Example `[ "example" ]`
documentStatuses	Type: DocumentStatusType[] \| null Статусы документов. Min items: `0` Unique items: `true` Example `[ "ACTIVE" ]`
documentTypes	Type: DocumentType[] \| null Типы документов. Min items: `0` Unique items: `true` Example `[ "CONFORMITY_DECLARATION" ]`

DocumentId

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

Type: integer

Min value: 1

DocumentNumber

Номер, указанный в сертификате, декларации или другом документе.

Type: string

Min length: 1

Max length: 100

Pattern: ^\S(?:.*\S)?$

Example: example

DocumentType

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

CONFORMITY_DECLARATION — Декларация о соответствии.
CONFORMITY_CERTIFICATE — Сертификат соответствия.
STATE_REGISTRATION_CERTIFICATE — Государственная регистрация продукции (санэпид требования).
MEDICINAL_PRODUCT_CERTIFICATE — Обязательные документы для аптеки.
BIOLOGICALLY_ACTIVE_ADDITIVE_CERTIFICATE — Свидетельство о государственной регистрации БАД.
MEDICAL_DEVICE_CERTIFICATE — Регистрационное удостоверение медицинского изделия.
AGROCHEMICAL_PESTICIDE_CERTIFICATE — Государственная регистрация пестицида и агрохимиката.

Type: string

Enum: CONFORMITY_DECLARATION, CONFORMITY_CERTIFICATE, STATE_REGISTRATION_CERTIFICATE, MEDICINAL_PRODUCT_CERTIFICATE, BIOLOGICALLY_ACTIVE_ADDITIVE_CERTIFICATE, MEDICAL_DEVICE_CERTIFICATE, AGROCHEMICAL_PESTICIDE_CERTIFICATE

DocumentStatusType

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

ACTIVE — действует.
NOT_FOUND — не найден в реестре.
VALIDATING — проверяется.
WAITING_FIXES — ожидает исправлений.
EXPIRED — срок действия истек.
REVOKED — отозван.

Type: string

Enum: ACTIVE, NOT_FOUND, VALIDATING, WAITING_FIXES, EXPIRED, REVOKED

Responses

200 OK

Страница документов.

Body

application/json

{
  "status": "OK",
  "result": {
    "documents": [
      {}
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

Type: object

All of 2 types

Type: ApiResponse

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

Type: object

result

Type: GetDocumentsResultDTO

Страница документов.

Example

{
  "documents": [
    {
      "number": "example",
      "type": "CONFORMITY_DECLARATION",
      "activeFromDate": "2025-01-01",
      "activeToDate": "2025-01-01",
      "id": 1,
      "status": "ACTIVE"
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}

Example

{
  "result": {
    "documents": [
      {
        "number": "example",
        "type": "CONFORMITY_DECLARATION",
        "activeFromDate": "2025-01-01",
        "activeToDate": "2025-01-01",
        "id": 1,
        "status": "ACTIVE"
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

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

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

Example

{
  "status": "OK"
}

DocumentWriteDTO

Реквизиты документа.

Name	Description
number	Type: DocumentNumber Номер, указанный в сертификате, декларации или другом документе. Min length: `1` Max length: `100` Pattern: `^\S(?:.\S)?$` Example:* `example`
type	Type: DocumentType Тип документа: `CONFORMITY_DECLARATION` — Декларация о соответствии. `CONFORMITY_CERTIFICATE` — Сертификат соответствия. `STATE_REGISTRATION_CERTIFICATE` — Государственная регистрация продукции (санэпид требования). `MEDICINAL_PRODUCT_CERTIFICATE` — Обязательные документы для аптеки. `BIOLOGICALLY_ACTIVE_ADDITIVE_CERTIFICATE` — Свидетельство о государственной регистрации БАД. `MEDICAL_DEVICE_CERTIFICATE` — Регистрационное удостоверение медицинского изделия. `AGROCHEMICAL_PESTICIDE_CERTIFICATE` — Государственная регистрация пестицида и агрохимиката. Enum: `CONFORMITY_DECLARATION`, `CONFORMITY_CERTIFICATE`, `STATE_REGISTRATION_CERTIFICATE`, `MEDICINAL_PRODUCT_CERTIFICATE`, `BIOLOGICALLY_ACTIVE_ADDITIVE_CERTIFICATE`, `MEDICAL_DEVICE_CERTIFICATE`, `AGROCHEMICAL_PESTICIDE_CERTIFICATE`
activeFromDate	Type: string<date> Дата начала действия документа. Example: `2025-01-01`
activeToDate	Type: string<date> Дата окончания действия документа. Example: `2025-01-01`

Example

{
  "number": "example",
  "type": "CONFORMITY_DECLARATION",
  "activeFromDate": "2025-01-01",
  "activeToDate": "2025-01-01"
}

BusinessDocumentDTO

Документ бизнеса.

Type: object

All of 2 types

Type: DocumentWriteDTO

Реквизиты документа.

Example

{
  "number": "example",
  "type": "CONFORMITY_DECLARATION",
  "activeFromDate": "2025-01-01",
  "activeToDate": "2025-01-01"
}

Type: object

Type: DocumentId

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

Min value: 1

Example: 1

status

Type: DocumentStatusType

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

ACTIVE — действует.
NOT_FOUND — не найден в реестре.
VALIDATING — проверяется.
WAITING_FIXES — ожидает исправлений.
EXPIRED — срок действия истек.
REVOKED — отозван.

Enum: ACTIVE, NOT_FOUND, VALIDATING, WAITING_FIXES, EXPIRED, REVOKED

Example

{
  "id": 1,
  "status": "ACTIVE"
}

Example

{
  "number": "example",
  "type": "CONFORMITY_DECLARATION",
  "activeFromDate": "2025-01-01",
  "activeToDate": "2025-01-01",
  "id": 1,
  "status": "ACTIVE"
}

PackagingForwardScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

Example: example

Example

{
  "nextPageToken": "example"
}

GetDocumentsResultDTO

Страница документов.

Name

Description

documents

Type: BusinessDocumentDTO[]

Документы на странице.

Example

[
  {
    "number": "example",
    "type": "CONFORMITY_DECLARATION",
    "activeFromDate": "2025-01-01",
    "activeToDate": "2025-01-01",
    "id": 1,
    "status": "ACTIVE"
  }
]

paging

Type: PackagingForwardScrollingPagerDTO

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

Example

{
  "nextPageToken": "example"
}

Example

{
  "documents": [
    {
      "number": "example",
      "type": "CONFORMITY_DECLARATION",
      "activeFromDate": "2025-01-01",
      "activeToDate": "2025-01-01",
      "id": 1,
      "status": "ACTIVE"
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}

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"
    }
  ]
}

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"
    }
  ]
}

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

Удаление документов

В кабинете