Sending the confirmation code

The method is available for the Express model.

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

Sends the confirmation code to the Market to verify it.

If the store is configured to work with confirmation codes:

In the parameter delivery, embedded in order, the parameter is returned eacType with the type Enum (type of confirmation code for order transfer) in the methods:

Possible values:

  • MERCHANT_TO_COURIER (temporarily non-refundable) — the seller transmits the code to the courier to receive a non-purchase;
  • COURIER_TO_MERCHANT — The courier transmits the code to the seller to receive the order.

Parameter eacType returned for order statuses COURIER_FOUND, COURIER_ARRIVED_TO_SENDER and DELIVERY_SERVICE_UNDELIVERED. If the order has other statuses, the parameter may be omitted.

⚙️ Limit: 100,000 requests per hour

Request

PUT

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The campaign ID.

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 send the store ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports.

Min value: 1

orderId*

Type: integer<int64>

The order ID.

Body

application/json
{
    "code": "string"
}

Name

Description

code*

Type: string

The code for confirming the EAPP.

Responses

200 OK

The code verification was completed successfully.

Body

application/json
{
    "status": "OK",
    "result": {
        "verificationResult": "ACCEPTED",
        "attemptsLeft": 0
    }
}

Name

Description

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

result
Type: object

attemptsLeft

Type: integer<int32>

The number of remaining code verification attempts.

It is refunded if the store has sent an incorrect code.

When all attempts are exhausted, the code will be updated.

verificationResult

Type: string

Verification status of the confirmation code:

  • ACCEPTED — the code is correct.
  • REJECTED — the code is incorrect.
  • NEED_UPDATE — Yandex.Market will send you a new code. The value is returned if the number of attempts to send the code is exceeded.

Enum: ACCEPTED, REJECTED, NEED_UPDATE

The result of the query execution.

400 Bad Request

The request contains incorrect data. More information about the error

Body

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

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

401 Unauthorized

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

Body

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

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

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": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

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

404 Not Found

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

Body

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

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

420 Method Failure

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

Body

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

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

500 Internal Server Error

Internal error of the Market. More information about the error

Body

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

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

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

Previous
Marking code verification statuses
Next
Removing items from an order