文档
测试

/dbo/v1/shipments

POST
/dbo/v1/shipments

接口描述

获取指定时间范围内的发货列表。

请求参数body

参数名
类型
描述
必填
account_oid
string
maxLength: 127 账户id
必填
start_datetime
string
开始时间 示例:2020-04-10T03:44:20.593Z
必填
end_datetime
string
结束时间 示例:2020-04-10T03:44:20.593Z
必填
page_no
number
minimum: 0 页码
必填
page_size
number
maximum: 100 minimum: 1 页大小
必填
purchased
boolean
是否已采购 示例:false
必填

响应说明 / 示例

{ "has_more": true, "shipment_list": [ { "oid": "string", "created_datetime": "2020-04-10T03:44:20.695Z", "updated_datetime": "2020-04-10T03:44:20.695Z", "account_oid": "string", "state": "error", "ref_id": "string", "order_info": { "sales_channel": "string", "order_id": "string" }, "to_address": { "street1": "string", "street2": "string", "city": "string", "state": "string", "postal_code": "string", "country": "string", "carrier_facility": "string", "name": "string", "company": "string", "phone": "string", "email": "string", "residential": true, "federal_tax_id": "string", "state_tax_id": "string", "oid": "string", "created_datetime": "2020-04-10T03:44:20.695Z", "updated_datetime": "2020-04-10T03:44:20.695Z" }, "from_address": { "street1": "string", "street2": "string", "city": "string", "state": "string", "postal_code": "string", "country": "string", "carrier_facility": "string", "name": "string", "company": "string", "phone": "string", "email": "string", "residential": true, "federal_tax_id": "string", "state_tax_id": "string", "oid": "string", "created_datetime": "2020-04-10T03:44:20.695Z", "updated_datetime": "2020-04-10T03:44:20.695Z" }, "return_address": { "street1": "string", "street2": "string", "city": "string", "state": "string", "postal_code": "string", "country": "string", "carrier_facility": "string", "name": "string", "company": "string", "phone": "string", "email": "string", "residential": true, "federal_tax_id": "string", "state_tax_id": "string", "oid": "string", "created_datetime": "2020-04-10T03:44:20.695Z", "updated_datetime": "2020-04-10T03:44:20.695Z" }, "buyer_address": { "street1": "string", "street2": "string", "city": "string", "state": "string", "postal_code": "string", "country": "string", "carrier_facility": "string", "name": "string", "company": "string", "phone": "string", "email": "string", "residential": true, "federal_tax_id": "string", "state_tax_id": "string", "oid": "string", "created_datetime": "2020-04-10T03:44:20.695Z", "updated_datetime": "2020-04-10T03:44:20.695Z" }, "parcel": { "dimension": { "length": 0, "width": 0, "height": 0, "unit": "mm" }, "weight": { "value": 0, "unit": "g" }, "irregular": true, "oid": "string", "created_datetime": "2020-04-10T03:44:20.695Z", "updated_datetime": "2020-04-10T03:44:20.695Z" }, "customs": { "contents_type": "documents", "contents_explanation": { "content": "string", "language": "en" }, "customs_certify": true, "customs_signer": "string", "return_non_delivery": "return", "restriction_type": "none", "restriction_comment": "string", "oid": "string", "created_datetime": "2020-04-10T03:44:20.695Z", "updated_datetime": "2020-04-10T03:44:20.695Z" }, "items": [ { "quantity": 0, "product": { "description": { "content": "string", "language": "en" }, "value": { "amount": 0, "currency": "USD" }, "product_id": "string", "weight": { "value": 0, "unit": "g" }, "dimension": { "length": 0, "width": 0, "height": 0, "unit": "mm" }, "hs_tariff_code": "string", "origin_country": "CN", "oid": "string", "created_datetime": "2020-04-10T03:44:20.695Z", "updated_datetime": "2020-04-10T03:44:20.695Z" } } ], "rates": [ { "carrier": "Opene", "service": "Opene Parcel ExpeditedChinaUS", "carrier_account_id": "string", "is_selected": true, "is_purchased": true, "rate": { "amount": 0, "currency": "USD" }, "error": "string" } ], "purchased_rate": { "carrier": "Opene", "service": "Opene Parcel ExpeditedChinaUS", "carrier_account_id": "string", "is_selected": true, "is_purchased": true, "rate": { "amount": 0, "currency": "USD" }, "error": "string" }, "tracker": { "carrier": "string", "tracking_code": "string" }, "postage_label": { "pdf_url": "string" }, "fees": [ { "fee_type": "L", "amount": { "amount": 0, "currency": "USD" }, "held": true, "released": true, "charged": true, "refunded": true } ], "reason": "string", "payload": "string" } ] }