Tabby Disputes API (1.0.0)

Download OpenAPI specification:Download

License: Proprietary

Tabby Open API Specification

disputes

纠纷API允许卖家执行与订单纠纷相关的各种操作。卖家可以使用此API检索纠纷列表、查看特定纠纷的详细信息,如果需要可以接受或发起挑战流程。此API旨在简化处理纠纷的过程,帮助卖家更有效地解决与买家的问题。要使用纠纷API,需要提供秘密API密钥。

Get disputes list

检索争议列表

Authorizations:
bearerAuth
query Parameters
statuses
Array of strings (DisputeStatus)
Items Enum: "new" "declined" "cancelled" "refunded" "in_progress"
Example: statuses=new&statuses=declined

按特定状态筛选结果以显示元素。

created_at_gte
string
Example: created_at_gte=2022-12-01T00:00:00Z

过滤结果以显示在指定日期和时间之后或在指定日期和时间创建的项目

created_at_lte
string
Example: created_at_lte=2022-12-01T00:00:00Z

过滤结果以显示在指定日期和时间之前或在指定日期和时间创建的项目

page_token
string

要加载下一页争议项目,需要一个代码验证。该代码可以从第一个请求的响应中的next_page_token变量中获得。

Responses

Response samples

Get dispute by id

通过id检索争议信息

Authorizations:
bearerAuth
path Parameters
disputeId
required
string <uuid>

商户争议ID唯一识别码

Responses

Response samples

Content type
application/json
{}

Approve disputes

批准争议。一次申请只能批准 20 项争议。

Authorizations:
bearerAuth
Request Body schema: application/json
dispute_ids
required
Array of strings <uuid>

爭議ID清單。

Responses

Request samples

Content type
application/json
{
  • "dispute_ids": [
    ]
}

Response samples

Challenge disputes

质疑有争议的信息(申请tabby客服介入)。一次申请只能质疑 20 条争议信息。

Authorizations:
bearerAuth
Request Body schema: application/json
Array
dispute_id
required
string <uuid>

商户争议ID唯一识别码

description
required
string

更多关于争议调解的备注信息。

reason
required
string
Enum: "merchant_reason_other" "merchant_reason_order_on_its_way" "merchant_reason_order_has_been_already_delivered" "merchant_reason_order_amount_should_be_different" "merchant_reason_problem_with_delivery"

申请争议调解的原因:

  • merchant_reason_other:商家选择此原因是由于订单出现了其他问题,需要进一步说明。
  • merchant_reason_order_on_its_way:商家选择此原因是由于订单已经被确认并正在配送中。
  • merchant_reason_order_has_been_already_delivered:商家选择此原因是由于订单已经被送达并已经完成了。
  • merchant_reason_order_amount_should_be_different:商家选择此原因是由于订单的金额出现了问题,需要进行修改。
  • merchant_reason_problem_with_delivery:商家选择此原因是由于订单在配送过程中出现了问题,需要进行调整和解决。
amount
string

如果因 “金额应不同“(merchant_reason_order_amount_should_be_different)的原因提出异议,则需要提供新的争议金额。

attachment_ids
Array of strings <uuid>

卖方在质疑争议时可附加的图像标识符。

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Upload attachment

允許上傳爭議的附件。附件可以是PNG或JPEG格式的圖像,並且最大大小可達5兆字節。

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
attachment
required
string <binary>

卖方在质疑争议时可以附上的图片

Responses

Response samples

Content type
application/json
{
  • "id": "d7926476-be4d-417d-8a3b-5056be3442b0"
}