发送确认代码

方法适用于模式Express.

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

将确认码发送到市场进行验证。

如果商店配置为使用确认代码:

在请求中 GET v2/campaigns/{campaignId}/orders/{orderId}, GET v2/campaigns/{campaignId}/orders, PUT v2/campaigns/{campaignId}/orders/{orderId}/status 在参数中 delivery,嵌入在 order,参数返回 eacType 与类型 Enum — 订单转移的确认代码的类型。

可能的值:

  • MERCHANT_TO_COURIER (暂时不退款) — 卖方将代码传送给快递员以接收非购买;
  • COURIER_TO_MERCHANT — 快递员将代码传送给卖方以接收订单。

参数 eacType 返回订单状态 COURIER_FOUND, COURIER_ARRIVED_TO_SENDERDELIVERY_SERVICE_UNDELIVERED. 如果订单有其他状态,则可以省略该参数。

⚙️ 限制: 每小时100,000次请求

Request

PUT

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

活动ID。

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

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

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

Min value: 1

orderId*

Type: integer<int64>

的订单ID。

Body

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

Name

Description

code*

Type: string

确认EAPP的代码。

Responses

200 OK

代码验证成功完成.

Body

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

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

result

Type: EacVerificationResultDTO

查询执行的结果。

ApiResponseStatusType

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

EacVerificationResultDTO

查询执行的结果。

Name

Description

attemptsLeft

Type: integer<int32>

剩余代码验证尝试的次数。

如果商店发送了错误的代码,它将被退还。

当所有尝试都用尽时,代码将被更新。

verificationResult

Type: EacVerificationStatusType

Статус проверки кода подтверждения.

Enum: ACCEPTED, REJECTED, NEED_UPDATE

EacVerificationStatusType

确认码的验证状态:

  • ACCEPTED — 代码是正确的。
  • REJECTED — 代码不正确。
  • NEED_UPDATE — 燕基科斯.市场会给你一个新的代码。 如果超过发送代码的尝试次数,则返回该值。

Type

Description

EacVerificationStatusType

Enum: ACCEPTED, REJECTED, NEED_UPDATE

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

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

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.