/dbo/v1/shipment
POST
/dbo/v1/shipment
接口描述
创建发货计划
请求参数body
参数名
类型
描述
必填
account_oid
string
maxLength: 127 DBO帐户
必填
ref_id
string
maxLength: 255 托运人提供的id
必填
sales_channel
string
maxLength: 255
必填
order_id
string
maxLength: 255 Sales channel specific order ID
必填
oid
string
ID of an existing address object
必填
street1
string
maxLength: 511 First line of address
必填
street2
string
maxLength: 511 Second line of address
必填
city
string
maxLength: 511 City the address is located in
必填
state
string
maxLength: 511 State of province the address is located in
必填
postal_code
string
maxLength: 32 ZIP or postal code the address is located in
必填
country
string
maxLength: 63 ISO 3166 country code for the country the address is located in
必填
carrier_facility
string
maxLength: 127 Specific designations if address is carrier facility
必填
name
string
maxLength: 511 Name of the person
必填
company
string
maxLength: 511 Name of the organization
必填
phone
string
maxLength: 32 Phone number to reach the person or company
必填
email
string
示例：string
必填
residential
boolean
default: false Whether or not this address would be considered residential
必填
federal_tax_id
string
maxLength: 255 Federal tax identifier of the person or company
必填
state_tax_id
string
maxLength: 255 State tax identifier of the person or company
必填
soft_verify
array
数据列表 Enum: [ zip4, delivery ]
必填
hard_verify
array
数据列表 Enum: [ zip4, delivery ]
必填
oid
string
ID of an existing address object
必填
street1
string
maxLength: 511
必填
street2
string
示例：string
必填
city
string
示例：string
必填
state
string
示例：string
必填
postal_code
string
示例：string
必填
country
string
示例：string
必填
carrier_facility
string
示例：string
必填
name
string
示例：string
必填
company
string
示例：string
必填
phone
string
示例：string
必填
email
string
示例：string
必填
residential
boolean
示例：false
必填
federal_tax_id
string
示例：string
必填
state_tax_id
string
示例：string
必填
soft_verify
array
数据列表
必填
hard_verify
array
数据列表
必填
oid
string
示例：string
必填
street1
string
示例：string
必填
street2
string
示例：string
必填
city
string
示例：string
必填
state
string
示例：string
必填
postal_code
string
示例：string
必填
country
string
示例：string
必填
carrier_facility
string
示例：string
必填
name
string
示例：string
必填
company
string
示例：string
必填
phone
string
示例：string
必填
email
string
示例：string
必填
residential
boolean
示例：false
必填
federal_tax_id
string
示例：string
必填
state_tax_id
string
示例：string
必填
soft_verify
array
数据列表
必填
hard_verify
array
数据列表
必填
oid
string
示例：string
必填
street1
string
示例：string
必填
street2
string
示例：string
必填
city
string
示例：string
必填
state
string
示例：string
必填
postal_code
string
示例：string
必填
country
string
示例：string
必填
carrier_facility
string
示例：string
必填
name
string
示例：string
必填
company
string
示例：string
必填
phone
string
示例：string
必填
email
string
示例：string
必填
residential
boolean
示例：false
必填
federal_tax_id
string
示例：string
必填
state_tax_id
string
示例：string
必填
soft_verify
array
数据列表
必填
hard_verify
array
数据列表
必填
oid
string
ID of existing parcel object
必填
length
number
示例：0 maximum: 9999999.99 minimum: 0.01
必填
width
number
示例：0
必填
height
number
示例：0
必填
unit
string
示例：mm Enum: [ mm, cm, me, in, ft ]
必填
value
number
maximum: 9999999.999 minimum: 0.01
必填
unit
string
示例：g Enum: [ g, kg, oz, lb ]
必填
irregular
boolean
不规则大小的包裹
必填
oid
string
ID of existing customs object
必填
contents_type
string
Type of shipment declared to customs Enum: [ documents, gift, merchandise, returned_goods, sample, other ]
必填
content
string
maxLength: 1023 Content of text
必填
language
string
IETF language tag Enum: [ en, zh ]
必填
customs_certify
boolean
Electronically certify the customs information
必填
customs_signer
string
Person or organization signing for the shipment
必填
return_non_delivery
string
Return or abandon undeliverable shipment Enum: [ return, abandon ]
必填
restriction_type
string
Special customs restriction Enum: [ none, other, quarantine, inspection ]
必填
restriction_comment
string
Additional comment if restriction_type is not none
必填
quantity
number
exclusiveMinimum: 0 Number of items to declare with customs
必填
oid
string
ID of existing product object
必填
content
string
maxLength: 1023 Content of text
必填
language
string
Enum: [ en, zh ]
必填
amount
number
minimum: 0
必填
currency
string
Enum: [ USD, RMB ]
必填
product_id
string
SKU/UPC or some other product specific identifier
必填
value
number
maximum: 9999999.999 minimum: 0.01
必填
unit
string
Enum: [ g, kg, oz, lb ]
必填
length
number
maximum: 9999999.99 minimum: 0.01
必填
width
number
maximum: 9999999.99 minimum: 0.01
必填
height
number
maximum: 9999999.99 minimum: 0.01
必填
unit
string
Enum: [ mm, cm, me, in, ft ]
必填
hs_tariff_code
string
Harmonized Tariff Schedule product code
必填
origin_country
string
Enum: [ CN, US ]
必填
services
array
如果设置，则按成本顺序遍历服务集，并以最低的成本购买第一个可用的服务
必填
payload
string
maxLength: 1023 不透明的数据有效载荷附加在这批货物上
必填