通行证列表 - Ozon Seller API

请求参数

Header 参数

Client-Id

string

用户识别号。

必需

Api-Key

string

API-密钥。

必需

Body 参数application/json

cursor

string

可选

用于获取下一批数据的指针。

filter

object (object)

筛选器。

可选

arrival_pass_ids

array[string <int64>]

按通行证ID筛选。

可选

arrival_reason

string

可选

按入场目的筛选：

FBS_DELIVERY — 发运。

FBS_RETURN — 运出退货。

如果未指定此参数，则考虑两种目的。

指定的原因必须在通行证的原因列表中。

dropoff_point_ids

array[string <int64>]

按发运点筛选。

可选

only_active_passes

boolean

可选

true, 以获取仅活跃的通行证申请。

warehouse_ids

array[string <int64>]

可选

按卖家仓库筛选。可以使用方法 /v1/warehouse/list获取。

limit

integer <int32>

必需

响应中记录数量的限制。

默认值为1000。最大值为1000。

示例

{
    "cursor": "string",
    "filter": {
        "arrival_pass_ids": [
            "string"
        ],
        "arrival_reason": "string",
        "dropoff_point_ids": [
            "string"
        ],
        "only_active_passes": true,
        "warehouse_ids": [
            "string"
        ]
    },
    "limit": 0
}

示例代码

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/v1/pass/list' \
--header 'Client-Id;' \
--header 'Api-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cursor": "string",
    "filter": {
        "arrival_pass_ids": [
            "string"
        ],
        "arrival_reason": "string",
        "dropoff_point_ids": [
            "string"
        ],
        "only_active_passes": true,
        "warehouse_ids": [
            "string"
        ]
    },
    "limit": 0
}'

返回响应

🟢200成功

application/json

通行证列表

Body

arrival_passes

array[object (object) {10}]

运输通行证列表。

可选

arrival_pass_id

integer <int64>

通行证ID。

可选

arrival_reasons

array[string]

入场目的。

可选

arrival_time

string <date-time>

可选

入场日期和时间，UTC格式。

driver_name

string

司机的姓名。

可选

driver_phone

string

司机的电话号码。

可选

dropoff_point_id

integer <int64>

发运点ID。

可选

is_active

boolean

可选

如果申请是活跃的，则为true。

vehicle_license_plate

string

车辆牌照号码。

可选

vehicle_model

string

车辆型号。

可选

warehouse_id

integer <int64>

卖家仓库ID。

可选

cursor

string

可选

用于获取下一批数据的指针。
如果此参数为空，则没有更多数据。

示例

{
    "arrival_passes": [
        {
            "arrival_pass_id": 0,
            "arrival_reasons": [
                "string"
            ],
            "arrival_time": "2019-08-24T14:15:22Z",
            "driver_name": "string",
            "driver_phone": "string",
            "dropoff_point_id": 0,
            "is_active": true,
            "vehicle_license_plate": "string",
            "vehicle_model": "string",
            "warehouse_id": 0
        }
    ],
    "cursor": "string"
}

🔴500服务器错误