Information about documents

Info

Console

The method is available for all models.

If you are using an API Key token, one of the accesses in the list is required to call the method

inventory-and-order-processing — Order processing and inventory
inventory-and-order-processing:read-only — View order information
all-methods — Full account management
all-methods:read-only — View all data

Returns information about documents by order ID.

You can receive the data after the order status changes. DELIVERED.

⚙️ Limit: 3,000 requests per hour

Request

POST

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

Path parameters

Name

Description

campaignId

Type: integer

The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.

You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:

block Campaign ID;
tab Query log → drop-down list in the block Show logs.

⚠️ Do not confuse it with:

the store's identifier, which is displayed in the merchant's personal account.
advertising campaigns.

Min value: 1

orderId

Type: integer

The order ID.

Responses

200 OK

Information about the documents.

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

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: object

ksf

Type: object

date

Type: string<date>

The date the document was created.

Date format: YYYY-MM-DD.

Example: 2025-01-01

number

Type: string

Document number.

Example: example

status

Type: string

Document status:

READY — ready.
NOT_READY — I'm not ready.

Enum: READY, NOT_READY

Information about the document.

Example

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

Type: object

date

Type: string<date>

The date the document was created.

Date format: YYYY-MM-DD.

Example: 2025-01-01

number

Type: string

Document number.

Example: example

status

Type: string

Document status:

READY — ready.
NOT_READY — I'm not ready.

Enum: READY, NOT_READY

Information about the document.

Example

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

torgTwelve

Type: object

date

Type: string<date>

The date the document was created.

Date format: YYYY-MM-DD.

Example: 2025-01-01

number

Type: string

Document number.

Example: example

status

Type: string

Document status:

READY — ready.
NOT_READY — I'm not ready.

Enum: READY, NOT_READY

Information about the document.

Example

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

ukd

Type: object

date

Type: string<date>

The date the document was created.

Date format: YYYY-MM-DD.

Example: 2025-01-01

number

Type: string

Document number.

Example: example

status

Type: string

Document status:

READY — ready.
NOT_READY — I'm not ready.

Enum: READY, NOT_READY

Information about the document.

Example

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

upd

Type: object

date

Type: string<date>

The date the document was created.

Date format: YYYY-MM-DD.

Example: 2025-01-01

number

Type: string

Document number.

Example: example

status

Type: string

Document status:

READY — ready.
NOT_READY — I'm not ready.

Enum: READY, NOT_READY

Information about the document.

Example

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

Information about the documents.

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

The request contains incorrect data. Learn more about errors when working with orders

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

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

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

Example

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

A standard wrapper for server errors.

Example

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

401 Unauthorized

The authorization data is not specified in the request. More information about the error

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

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

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

Example

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

A standard wrapper for server errors.

Example

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

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

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

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

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

Example

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

A standard wrapper for server errors.

Example

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

404 Not Found

The requested resource was not found. More information about the error

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

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

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

Example

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

A standard wrapper for server errors.

Example

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

420 Method Failure

The resource access limit has been exceeded. More information about the error

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

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

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

Example

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

A standard wrapper for server errors.

Example

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

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

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

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

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

Example

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

A standard wrapper for server errors.

Example

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

Was the article helpful?

Information about the buyer

Information about a single shipment