有关文件的资料

方法适用于所有模式.

如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一

按订单ID返回有关文档的信息。

您可以在订单状态更改后接收数据。 DELIVERED.

**⚙️ 限制:**每小时3,000个请求

Request

POST

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

活动ID。

您可以使用查询找到它 :no-translate[GET v2/campaigns] 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:

  • 模块和 API→区块 向Yandex发送数据。街市.
  • 查询日志 →块中的下拉列表 显示日志.

,不要发送商店ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。

Min value: 1

orderId*

Type: integer<int64>

的订单ID。

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

status*

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

result

Type: OrderBusinessDocumentsDTO

有关文件的信息。

ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Type

Description

ApiResponseStatusType

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.

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

错误列表。
一般错误格式。

Min items: 1

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

错误列表。
一般错误格式。

Min items: 1

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

错误列表。
一般错误格式。

Min items: 1

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

错误列表。
一般错误格式。

Min items: 1

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

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

500 Internal Server Error

Yandex中的内部错误。 市场。 有关错误的更多信息

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.