货件列表（第三版）

请求参数

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。

可选

fbpFilter

string

可选

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

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

only — 仅显示FBP货件；

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

默认值为 all。

FBP方案仅适用于中国卖家。

order_id

integer <int64>

订单ID。

可选

provider_id

array[integer <int64>]

快递服务ID。

可选

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[integer <int64>]

仓库ID。

可选

limit

integer <int64>

可选

响应中值的数量：

最大值 — 1000,

最小值 — 1。

offset

integer <int64>

可选

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

with

object (object)

可选

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

analytics_data

boolean

可选

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

barcodes

boolean

可选

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

financial_data

boolean

可选

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

translit

boolean

完成返回值的拼写。

可选

示例

{
  "dir": "ASC",
  "filter": {
    "since": "2021-11-01T00:00:00.000Z",
    "status": "awaiting_packaging",
    "to": "2021-12-01T23:59:59.000Z"
  },
  "limit": 100,
  "offset": 0,
  "translit": true,
  "with": {
    "analytics_data": true,
    "financial_data": 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) {21}]

货运信息。

可选

示例

{
  "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,
        "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,
            "mandatory_mark": []
          }
        ],
        "addressee": null,
        "barcodes": null,
        "analytics_data": null,
        "financial_data": null,
        "is_express": false,
        "requirements": {
          "products_requiring_gtd": [],
          "products_requiring_country": [],
          "products_requiring_mandatory_mark": []
        }
      }
    ],
    "has_next": true
  }
}

🟠400参数错误

🟠403访问拒绝

🟠404无响应

🟠409请求冲突

🔴500服务器内部错误