获取 rFBS 取消申请列表

请求参数

Body 参数application/json

filters

object (GetConditionalCancellationListV2RequestFilters)

过滤器。

可选

cancellation_initiator

array[string]

可选

取消发起人：

SELLER — 卖家，

CLIENT — 买家，

OZON — Ozon，

SYSTEM — 系统，

DELIVERY — 配送服务。

枚举值:

OZONSELLERCLIENTSYSTEMDELIVERY

posting_number

array[string]

按货件编号筛选。

可选

state

enum<string>

可选

按取消申请状态筛选：

ALL — 所有状态的申请，

ON_APPROVAL — 审核中申请，

APPROVED — 已确认申请，

REJECTED — 已拒绝申请。

枚举值:

ALLON_APPROVALAPPROVEDREJECTED

默认值:

ALL

last_id

integer <int64>

可选

页面上最后一个值的标识符。在首次请求时此字段留空。

要获取后续值，请指定上一次请求响应中的 last_id。

limit

integer <int32>

必需

响应中包含的申请总数。

<= 500

with

object (GetConditionalCancellationListV2RequestWith)

附加信息。

可选

counter

boolean

可选

表示需要在响应中返回处于 ON_APPROVAL 状态的申请数量的标志。

示例

{
    "filters": {
        "cancellation_initiator": [
            "CLIENT"
        ],
        "posting_number": [
            "34009011-0094-1"
        ],
        "state": "ALL"
    },
    "limit": 500,
    "last_id": 0,
    "with": {
        "counter": true
    }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api-seller.ozon.ru/v2/conditional-cancellation/list' \
--header 'Content-Type: application/json' \
--data-raw '{
    "filters": {
        "cancellation_initiator": [
            "CLIENT"
        ],
        "posting_number": [
            "34009011-0094-1"
        ],
        "state": "ALL"
    },
    "limit": 500,
    "last_id": 0,
    "with": {
        "counter": true
    }
}'

返回响应

🟢200成功

application/json

取消申请列表

Body

counter

integer <int64>

可选

ON_APPROVAL 状态申请的计数器。

last_id

integer <int64>

可选

页面上最后一个值的标识符。

要获取后续值，请指定上一次请求响应中的 last_id。

result

array[object (GetConditionalCancellationListV2ResponseResult) {13}]

可选

取消申请的详细信息。

approve_comment

string

可选

在确认或拒绝取消申请时填写的备注。

approve_date

string <date-time>

可选

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

auto_approve_date

string <date-time>

可选

申请将在此日期后自动确认。

cancellation_id

integer <int64>

取消申请标识符。

可选

cancellation_initiator

enum<string>

可选

取消发起人：

SELLER — 卖家，

CLIENT — 买家，

OZON — Ozon,

SYSTEM — 系统，

DELIVERY — 配送服务。

枚举值:

OZONSELLERCLIENTSYSTEMDELIVERY

cancellation_reason

object (GetConditionalCancellationListV2ResponseCancellationReason)

取消原因。

可选

cancellation_reason_message

string

可选

取消申请中由取消发起人手动填写的备注。

cancelled_at

string <date-time>

可选

取消申请的创建日期。

order_date

string <date-time>

订单的创建日期。

可选

posting_number

string

货件编号。

可选

source_id

integer <int64>

可选

上一次取消申请的标识符。

用于保持向后兼容性。

state

object (GetConditionalCancellationListV2ResponseState)

取消申请的状态。

可选

tpl_integration_type

string

可选

与配送服务的集成类型。

示例

{
    "result": [
        {
            "approve_comment": "string",
            "approve_date": "2024-11-27T12:31:43.621Z",
            "auto_approve_date": "2024-11-27T12:31:43.621Z",
            "cancellation_id": 0,
            "cancellation_initiator": "OZON",
            "cancellation_reason": {
                "id": 0,
                "name": "string"
            },
            "cancellation_reason_message": "string",
            "cancelled_at": "2024-11-27T12:31:43.621Z",
            "order_date": "2024-11-27T12:31:43.621Z",
            "posting_number": "string",
            "state": {
                "id": 0,
                "name": "string",
                "state": "ALL"
            },
            "tpl_integration_type": "string"
        }
    ],
    "counter": "1",
    "last_id": 283784254
}

🔴500服务器错误