获取rFBS取消申请列表

获取rFBS取消申请列表的方法。

请求参数

Header 参数

Client-Id

string

用户识别号。

必需

Api-Key

string

API-密钥。

必需

Body 参数application/json

filters

object (object)

过滤器

可选

cancellation_initiator

array[string]

可选

取消发起人：

SELLER — 卖家,

CLIENT — 客户或买家,

OZON — Ozon,

SYSTEM — 系统,

DELIVERY — 配送服务。

非必要参数。可以传递多个值。

枚举值:

OZONSELLERCLIENTSYSTEMDELIVER

posting_number

可选

按照快递号过滤。

非必要参数。可以传递多个值。

state

enum<string>

可选

按取消请求状态筛选：

ALL — 任何状态的申请，

ON_APPROVAL — 在审查的申请，

APPROVED — 已确定的申请，

REJECTED — 已拒绝的申请。

枚举值:

ALLON_APPROVALAPPROVEDREJECTED

limit

integer <int32>

响应中的申请数量。

必需

offset

integer <int32>

可选

将在响应中跳过的元素数。例如，如果'offset=10`，响应将从找到的第11个元素开始。

with

object (object)

附加信息。

可选

counters

boolean

可选

响应中应显示处于不同状态的申请计数器标志。

示例

{
    "filters": {
        "cancellation_initiator": [
            "CLIENT"
        ],
        "posting_number": [],
        "state": "ALL"
    },
    "limit": 2,
    "offset": 0,
    "with": {
        "counters": true
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

取消申请列表

Body

result

array[object (object) {12}]

订单取消列表。

可选

cancellation_id

integer <int64>

取消申请ID。

可选

posting_number

string

发货号。

可选

cancellation_reason

object (object)

取消原因。

可选

cancelled_at

string <date-time>

可选

创建取消订单的日期。

cancellation_reason_message

string

可选

取消者手动输入的取消申请评论。

tpl_integration_type

string

可选

与快递服务的集成类型。

state

object (object)

取消请求的状态。

可选

cancellation_initiator

enum<string>

可选

取消发起人：

OZON — Ozon，

SELLER — 卖家，

CLIENT — 买家，

SYSTEM — 系统，

DELIVERY — 快递服务。

枚举值:

OZONSELLERCLIENTSYSTEMDELIVERY

order_date

string <date-time>

订单创建日期。

可选

approve_comment

string

可选

确认或拒绝取消申请时留下的评论。

approve_date

string <date-time>

可选

确认或拒绝取消申请的日期。

auto_approve_date

string <date-time>

可选

申请将被自动确认的日期。

total

integer <int32>

可选

按指定过滤器的申请总数。

counters

object (object)

可选

订单计数器在不同的状态。

on_approval

integer <int64>

在审核的订单数。

可选

approved

integer <int64>

已确定的订单数。

可选

rejected

integer <int64>

已拒绝的订单数。

可选

示例

{
    "result": [
        {
            "cancellation_id": 50186754,
            "posting_number": "41267064-0032-1",
            "cancellation_reason": {
                "id": 508,
                "name": "买家取消订单"
            },
            "cancelled_at": "2021-09-03T07:17:12.116114Z",
            "cancellation_reason_message": "",
            "tpl_integration_type": "ThirdPartyTracking",
            "state": {
                "id": 2,
                "name": "确定",
                "state": "APPROVED"
            },
            "cancellation_initiator": "CLIENT",
            "order_date": "2021-09-03T07:04:53.220Z",
            "approve_comment": "",
            "approve_date": "2021-09-03T09:13:12.614200Z",
            "auto_approve_date": "2021-09-06T07:17:12.116114Z"
        },
        {
            "cancellation_id": 51956491,
            "posting_number": "14094410-0018-1",
            "cancellation_reason": {
                "id": 507,
                "name": "买家决定不买了"
            },
            "cancelled_at": "2021-09-13T15:03:25.155827Z",
            "cancellation_reason_message": "",
            "tpl_integration_type": "ThirdPartyTracking",
            "state": {
                "id": 5,
                "name": "自动取消",
                "state": "REJECTED"
            },
            "cancellation_initiator": "CLIENT",
            "order_date": "2021-09-13T07:48:50.143Z",
            "approve_comment": "",
            "approve_date": null,
            "auto_approve_date": "2021-09-16T15:03:25.155827Z"
        }
    ],
    "total": 19,
    "counters": {
        "on_approval": 0,
        "approved": 14,
        "rejected": 5
    }
}

🟠400请求有误

🟠403禁止访问

🟠404记录不存在

🟠409409

🔴500服务器错误