有关文件的资料

Info

Console

方法适用于所有模式.

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

inventory-and-order-processing — 订单处理和商品核算
inventory-and-order-processing:read-only — 查看订单信息
all-methods — 全面管理账户
all-methods:read-only — 查看所有数据

按订单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

广告系列（商店）的ID — 通过API工作时，代表您在Yandex市场系统中的商店的技术标识符。它与您的商店唯一链接，但仅用于自动交互。

您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它。点击您的帐户图标→ 设置在左边的菜单中，选择 Api和模块:

座 运动ID;
标签 查询日志 →块中的下拉列表 显示日志.

⚠️ 不要把它与:

商店的标识符，显示在商家的个人帐户中。
广告活动。

Min value: 1

orderId

Type: integer

的订单ID。

Responses

200 OK

有关文件的信息。

Body

application/json

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

Type: object

All of 2 types

Type: object
status

Type: string

响应的类型。可能的值:

OK — 没有错误。

ERROR — 处理请求时出错。

Enum: OK, ERROR
服务器响应的标准包装器。
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: object

ksf

Type: object

date

Type: string<date>

创建文档的日期。

日期格式: YYYY-MM-DD.

Example: 2025-01-01

number

Type: string

文件编号。

Example: example

status

Type: string

文件状态:

READY — 准备好了。
NOT_READY — 我还没准备好

Enum: READY, NOT_READY

文档的信息。

Example

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

Type: object

date

Type: string<date>

创建文档的日期。

日期格式: YYYY-MM-DD.

Example: 2025-01-01

number

Type: string

文件编号。

Example: example

status

Type: string

文件状态:

READY — 准备好了。
NOT_READY — 我还没准备好

Enum: READY, NOT_READY

文档的信息。

Example

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

torgTwelve

Type: object

date

Type: string<date>

创建文档的日期。

日期格式: YYYY-MM-DD.

Example: 2025-01-01

number

Type: string

文件编号。

Example: example

status

Type: string

文件状态:

READY — 准备好了。
NOT_READY — 我还没准备好

Enum: READY, NOT_READY

文档的信息。

Example

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

ukd

Type: object

date

Type: string<date>

创建文档的日期。

日期格式: YYYY-MM-DD.

Example: 2025-01-01

number

Type: string

文件编号。

Example: example

status

Type: string

文件状态:

READY — 准备好了。
NOT_READY — 我还没准备好

Enum: READY, NOT_READY

文档的信息。

Example

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

upd

Type: object

date

Type: string<date>

创建文档的日期。

日期格式: YYYY-MM-DD.

Example: 2025-01-01

number

Type: string

文件编号。

Example: example

status

Type: string

文件状态:

READY — 准备好了。
NOT_READY — 我还没准备好

Enum: READY, NOT_READY

文档的信息。

Example

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

有关文件的信息。

Example

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

Example

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

400 Bad Request

请求包含不正确的数据。详细了解处理订单时的错误

Body

application/json

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

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

响应的类型。可能的值:

OK — 没有错误。

ERROR — 处理请求时出错。

Enum: OK, ERROR
服务器响应的标准包装器。
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

的错误代码。

Example: example

message

Type: string

错误的描述。

Example: example

错误列表。

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: object

All of 2 types

Type: object
status
Type: string

响应的类型。可能的值:

OK — 没有错误。

ERROR — 处理请求时出错。

Enum: OK, ERROR
服务器响应的标准包装器。
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

的错误代码。

Example: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

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

Example

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

服务器错误的标准包装器。

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: object

All of 2 types

Type: object
status
Type: string

响应的类型。可能的值:

OK — 没有错误。

ERROR — 处理请求时出错。

Enum: OK, ERROR
服务器响应的标准包装器。
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

的错误代码。

Example: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

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

Example

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

服务器错误的标准包装器。

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: object

All of 2 types

Type: object
status
Type: string

响应的类型。可能的值:

OK — 没有错误。

ERROR — 处理请求时出错。

Enum: OK, ERROR
服务器响应的标准包装器。
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

的错误代码。

Example: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

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

Example

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

服务器错误的标准包装器。

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: object

All of 2 types

Type: object
status
Type: string

响应的类型。可能的值:

OK — 没有错误。

ERROR — 处理请求时出错。

Enum: OK, ERROR
服务器响应的标准包装器。
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

的错误代码。

Example: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

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

Example

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

服务器错误的标准包装器。

Example

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

500 Internal Server Error

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

Body

application/json

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

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

响应的类型。可能的值:

OK — 没有错误。

ERROR — 处理请求时出错。

Enum: OK, ERROR
服务器响应的标准包装器。
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

的错误代码。

Example: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

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

Example

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

服务器错误的标准包装器。

Example

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

这篇文章是否有用？

关于买方的信息

有关单次装运的信息