Download OpenAPI specification:Download
Tabby Open API Specification
纠纷API允许卖家执行与订单纠纷相关的各种操作。卖家可以使用此API检索纠纷列表、查看特定纠纷的详细信息,如果需要可以接受或发起挑战流程。此API旨在简化处理纠纷的过程,帮助卖家更有效地解决与买家的问题。要使用纠纷API,需要提供秘密API密钥。
检索争议列表
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变量中获得。 |
{- "disputes": [
- {
- "id": "76d13ca1-e7f9-4af5-8cc0-9c9df2026587",
- "payment_id": "0a7a048f-ebd9-429a-b7d4-7e46c4735dc1",
- "amount": "123.12",
- "currency": "SAR",
- "created_at": "2022-12-01T00:00:00Z",
- "status": "new",
- "reason": "unreceived_refund",
- "days_left": 13,
- "expired_at": "2022-12-01T00:00:00Z",
- "items": [
- {
- "reference_id": "string",
- "title": "string",
- "unit_price": "string"
}
], - "order_number": "#2xxx-xxxxxx-xxx2",
- "comment": "The order wasn’t delivered, please, refund my payment!"
}
], - "next_page_token": "string"
}
通过id检索争议信息
disputeId required | string <uuid> 商户争议ID唯一识别码 |
{- "dispute": {
- "id": "76d13ca1-e7f9-4af5-8cc0-9c9df2026587",
- "payment_id": "0a7a048f-ebd9-429a-b7d4-7e46c4735dc1",
- "amount": "123.12",
- "currency": "SAR",
- "created_at": "2022-12-01T00:00:00Z",
- "status": "new",
- "reason": "unreceived_refund",
- "days_left": 13,
- "expired_at": "2022-12-01T00:00:00Z",
- "history": [
- {
- "created_at": "2022-12-01T00:00:00Z",
- "created_by": "user@example.com",
- "content": "The order wasn’t delivered, please, refund my payment!",
- "source": "customer",
- "event_type": "dispute_created",
- "note": "New amount: 123.12, We’ve delivered 1 out of 2 items to the customer"
}
], - "items": [
- {
- "reference_id": "string",
- "title": "string",
- "unit_price": "string"
}
], - "order_number": "#2xxx-xxxxxx-xxx2",
- "comment": "The order wasn’t delivered, please, refund my payment!"
}
}
批准争议。一次申请只能批准 20 项争议。
dispute_ids required | Array of strings <uuid> 爭議ID清單。 |
{- "dispute_ids": [
- "2771b2e4-xxxx-495b-ac3e-b0835bcc6cd1"
]
}
{- "disputes": [
- {
- "id": "76d13ca1-e7f9-4af5-8cc0-9c9df2026587",
- "payment_id": "0a7a048f-ebd9-429a-b7d4-7e46c4735dc1",
- "amount": "123.12",
- "currency": "SAR",
- "created_at": "2022-12-01T00:00:00Z",
- "status": "new",
- "reason": "unreceived_refund",
- "days_left": 13,
- "expired_at": "2022-12-01T00:00:00Z",
- "items": [
- {
- "reference_id": "string",
- "title": "string",
- "unit_price": "string"
}
], - "order_number": "#2xxx-xxxxxx-xxx2",
- "comment": "The order wasn’t delivered, please, refund my payment!"
}
]
}
质疑有争议的信息(申请tabby客服介入)。一次申请只能质疑 20 条争议信息。
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" 申请争议调解的原因:
|
amount | string 如果因 “金额应不同“( |
attachment_ids | Array of strings <uuid> 卖方在质疑争议时可附加的图像标识符。 |
[- {
- "dispute_id": "9e4ccd50-228a-4136-9dc6-7f698726b0c6",
- "description": "some comment here",
- "reason": "merchant_reason_order_amount_should_be_different",
- "amount": "123.12",
- "attachment_ids": [
- "dcb52aa4-2b3b-4bb4-afa5-e7e5ac7fa8ae"
]
}
]
{- "disputes": [
- {
- "id": "76d13ca1-e7f9-4af5-8cc0-9c9df2026587",
- "payment_id": "0a7a048f-ebd9-429a-b7d4-7e46c4735dc1",
- "amount": "123.12",
- "currency": "SAR",
- "created_at": "2022-12-01T00:00:00Z",
- "status": "new",
- "reason": "unreceived_refund",
- "days_left": 13,
- "expired_at": "2022-12-01T00:00:00Z",
- "items": [
- {
- "reference_id": "string",
- "title": "string",
- "unit_price": "string"
}
], - "order_number": "#2xxx-xxxxxx-xxx2",
- "comment": "The order wasn’t delivered, please, refund my payment!"
}
]
}