order-list

查询订单(terminus.pur.order.list)

业务场景：

用于查询创建的Shippergrid订单

系统入参：

参数名称	类型	是否必填	说明
channelCode	String	是	请传入固定参数【SHIPPER_GRID】，参考请求示例

业务入参

PurchaseOrderListRequest

参数名称	类型	是否必填	说明
purchaseOrderCode	List	否	订单号数组查询。
thirdOrderCodes	List	否	三方订单号数组查询。
updateAtStart	Long	否	按更新时间查询范围的开始时间，毫秒级时间戳。
updateAtEnd	Long	否	按更新时间查询范围的结束时间，毫秒级时间戳。
createAtStart	Long	否	按创建时间查询范围的开始时间，毫秒级时间戳。
createAtEnd	Long	否	按创建时间查询范围的结束时间，毫秒级时间戳。
pageNum	Integer	否	页码，默认值为 1。
pageSize	Integer	否	页大小，默认值为 40。

请求示例

 public static void main(String[] args) {
        String appKey = "28cd819d0305402bb02e7d01091160c8";
        String secret = "xj1CnrTho1Bc1YSxaZa8ghdqRxwn079prFHqkjGXzdO64TQuy4aIzs06qv5htyXk";
        String url = "https://channelhub-uat.shippergrid.com/terminus/channelhub/api";
        ChannelClient client = new DefaultChannelClient( url, appKey, secret);
        PurchaseOrderListRequest request = new PurchaseOrderListRequest();
        //必填字段
        request.setChannelCode(OpenChannel.SHIPPER_GRID);
        request.setThirdOrderCodes(Collections.singletonList("OB20250508565966"));
        request.setPageNum(1);
        request.setPageSize(1);
        PurchaseOrderListResponse channelResult = client.execute(request);
        System.out.println(JSON.toJSONString(channelResult));
    }

响应出参

PurchaseOrderListResponse

参数名称	类型	是否必填	说明
totalCount	Integer	否	总数量，默认值为 0。
hasNext	boolean	否	是否有下一页，默认值为 `false`。
orderList	List	否	订单列表，包含多个 `Order` 对象。

Order

参数名称	类型	是否必填	说明
purchaseOrderCode	String	是	订单号。
thirdOrderCode	String	是	三方订单号。
shipperAddress	ShipperAddress	是	收件人地址，包含多个字段。
items	List	是	订单明细，包含多个 `OrderItem` 对象。
status	String	是	订单状态。 WAIT_PROCESS（待处理）、WAIT_PAYMENT（待支付）、WAIT_PRINT_LABEL（待打单）、WAIT_SHIPMENT（待发货）、 IN_TRANSIT（已发货）、DELIVERED（已签收）CANCELLED（已取消）
feeList	List	否	费用明细，包含多个 `Fee` 对象。outboundFee出库费、storageFee仓储费、shipFee尾程物流费单位均为美元
packages	List	否	包裹明细，包含多个 `Package` 对象。

ShipperAddress

参数名称	类型	是否必填	说明
state	String	是	州或省。
city	String	是	城市。
region	String	否	区（非必填）。
countryCode	String	是	国家代码。
contacter	String	是	收件人名。

成功响应示例

{
    "code": 200,
    "hasNext": false,
    "headerContent": {
        "traceId": "2025-05-12-10-07-21-817000000-0eb1a32f-a4b0-443c-890f-a5cfa71d0b38",
        "sign": "a9b79ee58f185c05c46484e80c5f15dd91d7dd82b8c9857ce0be583a0dde1e67",
        "methodName": "terminus.pur.order.list",
        "appKey": "28cd819d0305402bb02e7d01091160c8",
        "Accept-Language": "zh_CN",
        "version": "1.0.0",
        "channelCode": "SHIPPER_GRID",
        "timestamp": "1747015641845"
    },
    "message": "success",
    "orderList": [
        {
            "feeList": [
                {
                    "outboundFee": 0.750000,
                    "shipFee": 0.000000
                }
            ],
            "packages": [
                {
                    "labelUrl": "https://mg-static.erda.cloud/millgrid/order_label/SHIP_ENGINE_LABEL_9400150899563001119319252730963704832.pdf",
                    "status": "CANCELLED",
                    "trackingNumber": "9400150899563001119310"
                }
            ],
            "purchaseOrderCode": "TEST4688401070580004",
            "shipperAddress": {
                "city": "Culver City",
                "contacter": "buyer open sandbox",
                "countryCode": "US",
                "phone": "1234567890",
                "state": "California",
                "streetAddress1": "5800 Bristol Pkwy Ste 100"
            },
            "status": "CANCELLED",
            "thirdOrderCode": "OB20250508565966"
        }
    ],
    "requestId": "2025-05-12-10-07-21-817000000-0eb1a32f-a4b0-443c-890f-a5cfa71d0b38",
    "requestUrl": "https://channelhub-uat.shippergrid.com/terminus/channelhub/api",
    "success": true,
    "totalCount": 1
}

异常响应示例

{
    "code":300,
    "data":null,
    "message":"系统异常",
    "success":false
}

查询订单(terminus.pur.order.list)​

查询订单(terminus.pur.order.list)