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
- inventory-and-order-processing — Order processing and inventory
- all-methods — Full account management
Sends the confirmation code to the Market to verify it.
If the store is configured to work with confirmation codes:
In requests GET campaigns/{campaignId}/orders/{orderId}, GET campaigns/{campaignId}/orders, PUT campaigns/{campaignId}/orders/{orderId}/status in the parameter delivery, embedded in order, the parameter is returned eacType with the type Enum — the type of confirmation code for the transfer of the order.
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/campaigns/{campaignId}/orders/{orderId}/verifyEac
Path parameters
|
Name |
Description |
|
campaignId* |
Type: integer<int64> The campaign ID. You can find it using a query GET campaigns or find it in the seller's office on the Market — click on the name of your business and go to the page:
, 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: |
|
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 |
|
result |
Type: EacVerificationResultDTO The result of the request execution. |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
EacVerificationResultDTO
The result of the request execution.
|
Name |
Description |
|
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: EacVerificationStatusType The verification status of the confirmation code. Enum: |
ApiResponseStatusType
The type of response. Possible values:
OK— there are no mistakes.ERROR— an error occurred while processing the request.
|
Type |
Description |
|
Enum: |
EacVerificationStatusType
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.
|
Type |
Description |
|
Enum: |
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: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
ApiErrorDTO
The general error format.
|
Name |
Description |
|
code* |
Type: string The error code. |
|
message |
Type: string Description of the 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: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
500 Internal Server Error
Internal error in Yandex. Market. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.