Обновление документов

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

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

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

Полностью обновляет номер, тип и даты документов на товары. За один запрос можно обновить не более 100 документов.

Для каждого документа передайте его идентификатор и актуальные значения номера, типа и дат. Если дата не указана, ранее сохраненная дата будет удалена. Ошибка одного документа не мешает обработке остальных.

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

Request

POST

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

Path parameters

Name

Description

businessId

Type: integer

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

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

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

Min value: 1

Body

application/json
{
  "documents": [
    {
      "number": "example",
      "type": "CONFORMITY_DECLARATION",
      "activeFromDate": "2025-01-01",
      "activeToDate": "2025-01-01",
      "id": 1
    }
  ]
}

Name

Description

documents

Type: UpdateDocumentDTO[]

Документы для обновления. Идентификаторы документов не должны повторяться в одном запросе. Если идентификаторы повторяются, запрос не обрабатывается.

Min items: 1

Max items: 100

Example
[
  {
    "number": "example",
    "type": "CONFORMITY_DECLARATION",
    "activeFromDate": "2025-01-01",
    "activeToDate": "2025-01-01",
    "id": 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

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

DocumentId

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

Type: integer

Min value: 1

UpdateDocumentDTO

Полная модель документа для обновления.

Type: object

All of 2 types

  • Type: DocumentWriteDTO

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

    Example
    {
  "number": "example",
  "type": "CONFORMITY_DECLARATION",
  "activeFromDate": "2025-01-01",
  "activeToDate": "2025-01-01"
}
  • Type: object

    id

    Type: DocumentId

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

    Min value: 1

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

Responses

200 OK

Если все документы обновлены, поле status принимает значение OK, а поле result не возвращается.

Если хотя бы один документ не удалось обновить, поле status принимает значение ERROR, а поле result содержит только ошибки. Остальные документы при этом обрабатываются.

Body

application/json
{
  "status": "OK",
  "result": {
    "errors": [
      {
        "id": 1,
        "code": "DOCUMENT_VALIDATION_FAILED",
        "message": "example"
      }
    ]
  }
}

Type: object

All of 2 types

  • Type: ApiResponse

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

    Example
    {
  "status": "OK"
}
  • Type: object

    result

    Type: UpdateDocumentsResultDTO

    Ошибки документов, которые не удалось обновить.

    Example
    {
  "errors": [
    {
      "id": 1,
      "code": "DOCUMENT_VALIDATION_FAILED",
      "message": "example"
    }
  ]
}
    Example
    {
  "result": {
    "errors": [
      {
        "id": 1,
        "code": "DOCUMENT_VALIDATION_FAILED",
        "message": "example"
      }
    ]
  }
}

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

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

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR
Example
{
  "status": "OK"
}

DocumentErrorCodeType

Код ошибки документа:

  • DOCUMENT_VALIDATION_FAILED — документ не прошел проверку.
  • DOCUMENT_ALREADY_EXISTS — документ уже существует.
  • DOCUMENT_NOT_FOUND — документ не найден.
  • DOCUMENT_UPDATE_NOT_ALLOWED — изменение документа запрещено.
  • DOCUMENT_CONCURRENT_MODIFICATION — документ был изменен параллельно.

Type: string

Enum: DOCUMENT_VALIDATION_FAILED, DOCUMENT_ALREADY_EXISTS, DOCUMENT_NOT_FOUND, DOCUMENT_UPDATE_NOT_ALLOWED, DOCUMENT_CONCURRENT_MODIFICATION

UpdateDocumentErrorDTO

Ошибка обновления документа.

Name

Description

code

Type: DocumentErrorCodeType

Код ошибки документа:

  • DOCUMENT_VALIDATION_FAILED — документ не прошел проверку.
  • DOCUMENT_ALREADY_EXISTS — документ уже существует.
  • DOCUMENT_NOT_FOUND — документ не найден.
  • DOCUMENT_UPDATE_NOT_ALLOWED — изменение документа запрещено.
  • DOCUMENT_CONCURRENT_MODIFICATION — документ был изменен параллельно.

Enum: DOCUMENT_VALIDATION_FAILED, DOCUMENT_ALREADY_EXISTS, DOCUMENT_NOT_FOUND, DOCUMENT_UPDATE_NOT_ALLOWED, DOCUMENT_CONCURRENT_MODIFICATION

id

Type: DocumentId

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

Min value: 1

Example: 1

message

Type: string

Описание ошибки для человека. Для обработки ошибки используйте поле code.

Example: example
Example
{
  "id": 1,
  "code": "DOCUMENT_VALIDATION_FAILED",
  "message": "example"
}

UpdateDocumentsResultDTO

Ошибки документов, которые не удалось обновить.

Name

Description

errors

Type: UpdateDocumentErrorDTO[]

Ошибки обработки документов.

Min items: 1

Max items: 100

Example
[
  {
    "id": 1,
    "code": "DOCUMENT_VALIDATION_FAILED",
    "message": "example"
  }
]
Example
{
  "errors": [
    {
      "id": 1,
      "code": "DOCUMENT_VALIDATION_FAILED",
      "message": "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"
    }
  ]
}
Предыдущая
Создание документов
Следующая
Удаление документов