货件列表（第三版）

请求参数

Header 参数

Client-Id

string

用户识别号。

必需

Api-Key

string

API-密钥。

必需

Body 参数application/json

dir

string

可选

分类方向：

asc — 从小到大，

desc — 从大到小。

filter

object (object)

过滤器。

必需

delivery_method_id

array[integer <int64>]

可选

快递方式ID。按照运输方式筛选。可以使用方法 /v1/delivery-method/list获取。

fbpFilter

string

可选

从合作伙伴仓库（FBP）发货时的货件筛选器：

ALL — 响应中将显示所有符合其他筛选器条件的货件；

ONLY — 仅显示FBP货件；

WITHOUT — 显示除FBP外的所有货件。

默认值为 ALL。

order_id

integer <int64>

订单ID。

可选

provider_id

array[integer <int64>]

可选

快递服务ID。按照运输方式筛选。可以使用方法 /v1/delivery-method/list获取。

since

string <date-time>

必需

应收到货件清单时间段的开始日期。

UTC模式: ГГГГ-ММ-ДДTЧЧ:ММ:ССZ.

例子: 2019-08-24T14:15:22Z.

string <date-time>

必需

应收到货件清单时间段的结束日期。

UTC模式： ГГГГ-ММ-ДДTЧЧ:ММ:ССZ.

例子： 2019-08-24T14:15:22Z.

status

string

可选

货件运输状态：

awaiting_registration — 等待注册，

acceptance_in_progress — 正在验收，

awaiting_approve — 等待确认，

awaiting_packaging — 等待包装，

awaiting_deliver — 等待装运，

arbitration — 仲裁，

client_arbitration — 快递客户仲裁，

delivering — 运输中，

driver_pickup — 司机处，

delivered — 已送达，

cancelled — 已取消，

not_accepted — 分拣中心未接受，

sent_by_seller – 由卖家发送。

warehouse_id

array[string <int64>]

可选

仓库ID。可以使用方法 /v1/warehouse/list获取。

last_changed_status_date

object (object)

可选

货件最后一次更改过状态的时期。

limit

integer <int64>

必需

响应中值的数量：

最大值 — 1000,

最小值 — 1。

offset

integer <int64>

必需

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

with

object (object)

可选

要添加到响应的附加字段。

analytics_data

boolean

可选

将分析数据添加到响应中。

barcodes

boolean

可选

将货件条形码添加到响应中。

financial_data

boolean

可选

将财务数据添加到响应中。

legal_info

boolean

可选

将法律信息添加到响应中。

translit

boolean

完成返回值的拼写。

可选

示例

{
    "dir": "ASC",
    "filter": {
        "delivery_method_id": [
            "string"
        ],
        "fbpFilter": "string",
        "last_changed_status_date": {
            "from": "2023-11-03T11:47:39.878Z",
            "to": "2023-11-03T11:47:39.878Z"
        },
        "order_id": 0,
        "provider_id": [
            "string"
        ],
        "since": "2023-11-03T11:47:39.878Z",
        "status": "awaiting_packaging",
        "to": "2023-11-03T11:47:39.878Z",
        "warehouse_id": [
            "string"
        ]
    },
    "limit": 0,
    "offset": 0,
    "with": {
        "analytics_data": true,
        "barcodes": true,
        "financial_data": true,
        "legal_info": false,
        "translit": true
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

货件列表

Body

result

object (object)

货运数组。

可选

has_next

boolean

可选

响应中未返回整个货运数组的标志:

true — 必须提出含其他值 offset的新请求，以获得其他货运信息；

false — 响应中返回了在请求中提出的整个用于过滤的货运数组。

postings

array[object (object) {25}]

货运信息。

可选

示例

{
    "result": {
        "postings": [
            {
                "posting_number": "05708065-0029-1",
                "order_id": 680420041,
                "order_number": "05708065-0029",
                "status": "awaiting_deliver",
                "substatus": "posting_awaiting_passport_data",
                "delivery_method": {
                    "id": 21321684811000,
                    "name": "Ozon独立物流, 克拉斯诺戈尔斯克",
                    "warehouse_id": 21321684811000,
                    "warehouse": "Steam Toys Nahabino",
                    "tpl_provider_id": 24,
                    "tpl_provider": "Ozon物流"
                },
                "tracking_number": "",
                "tpl_integration_type": "ozon",
                "in_process_at": "2022-05-13T07:07:32Z",
                "shipment_date": "2022-05-13T10:00:00Z",
                "delivering_date": null,
                "optional": {
                    "products_with_possible_mandatory_mark": [
                        0
                    ]
                },
                "cancellation": {
                    "cancel_reason_id": 0,
                    "cancel_reason": "",
                    "cancellation_type": "",
                    "cancelled_after_ship": false,
                    "affect_cancellation_rating": false,
                    "cancellation_initiator": ""
                },
                "customer": null,
                "products": [
                    {
                        "price": "1390.000000",
                        "currency_code": "RUB",
                        "offer_id": "205953",
                        "name": " Electronic designer PinLab Positronic",
                        "sku": 358924380,
                        "quantity": 1
                    }
                ],
                "addressee": null,
                "barcodes": null,
                "analytics_data": null,
                "financial_data": null,
                "is_express": false,
                "legal_info": {
                    "company_name": "string",
                    "inn": "string",
                    "kpp": "string"
                },
                "requirements": {
                    "products_requiring_gtd": [],
                    "products_requiring_country": [],
                    "products_requiring_mandatory_mark": []
                },
                "tariffication": [
                    {
                        "current_tariff_rate": 0,
                        "current_tariff_type": "",
                        "current_tariff_charge": "",
                        "current_tariff_charge_currency_code": "",
                        "next_tariff_rate": 0,
                        "next_tariff_type": "",
                        "next_tariff_charge": "",
                        "next_tariff_starts_at": "2023-11-13T08:05:57.657Z",
                        "next_tariff_charge_currency_code": ""
                    }
                ]
            }
        ],
        "has_next": true
    }
}

🟠400请求有误

🟠403禁止访问

🟠404记录不存在

🟠409409

🔴500服务器错误