文档中心 > API类目 > 淘天物流API

qimen.taobao.logistics.clearance.entryorder.create (清关作业单创建)

淘天下发清关作业单给清关服务商

公共参数

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
request	Request	可选			请求
└ orderCode String 必须 QG8877623 清关作业单号 relatedOrders RelatedOrder [] 可选关联单据信息 └ extendProps Map 可选扩展属性 └ orderCode String 可选 TC0005 关联的单据编号 └ orderType String 可选 FIRST_LEG 关联的单据类型 └ orderType String 必须 TOB_CLEARANCE 作业单类型标识 └ ownerCode String 必须 AX766232 货主编码 └ ownerName String 可选富勒斯海外旗舰店货主名称 └ resourceCode String 必须 STA 清关资源编码 └ superviseType String 可选保税电商监管方式,跨境一线进境、大贸非保入区的时候这个字段的值是“保税电商“,其他单据类型时这个字段的值是“保税间货物” └ entryPort String 可选上海吴淞进境口岸 └ tradeRegion String 可选美国美国 basicInfo BasicInfo 可选运输基本信息 └ fromCustomsArea String 可选西雅图起运仓关区 └ fromLocation String 可选西雅图起运港（始发机场） └ fromRegion String 可选美国起运国/地区 └ fromWarehouse String 可选仓A 起运仓 └ toCustomsArea String 可选上海吴淞目的仓关区 └ toLocation String 可选上海目的港（到达机场） └ toRegion String 可选中国目的国/地区 └ toWarehouse String 可选仓01 目的仓 └ isSameWarehouse String 可选 0 转出与转入仓是否为同一个仓(0=不是同一个仓;1=是同一个仓),在保税区内转移时,本字段必填 └ loadingTypePortToWH String 可选 FTL 港到仓装车方式(FTL=整车),一线进境补货必填 └ extendProps Map 可选扩展属性 loadInfo LoadInfo 可选装箱信息 containerTypes ContainerType [] 可选柜型与数量 └ qty String 可选 20 数量 └ extendProps Map 可选扩展属性 └ containerType String 可选 20GP 柜型（20GP、40GP、40HQ、20RF、40RF） └ loadingType String 可选 FCL 装箱方式（FCL=整箱、LCL=拼箱） └ productDesc String 可选 lipstick 货品描述（请填写英文品名，如lipstick, paper diaper…） └ productType String 可选 TEMPERATURE 货品类型（NORMAL=普通品、DANGER=危险品、TEMPERATURE=温控品） └ temperature String 可选 -5 商品温度要求（℃） └ extendProps Map 可选扩展属性 carrierInfo CarrierInfo 可选承运信息 └ mblNo String 可选 BOL112 主提单号 └ hblNo String 可选 BOL112-1 分提单号 └ transportMode String 可选 OCEAN 运输方式（AIR=空运、OCEAN=海运、RAILWAY=铁路、TRUCK=陆运） └ carrierName String 可选 ABC 承运商 └ shippingName String 可选通达船名 └ flightNo String 可选 101 航次 └ flightDate String 可选 2023-12-16 航班日期（YYYY-DD-MM） └ expectArrivePortDate String 可选 2023-12-16 期望到港时间（YYYY-MM-DD） └ expectArriveWarehouseDate String 可选 2023-12-16 期望到仓时间（YYYY-MM-DD）,保税区间转入、保税区内转入时必填 └ containerCodes String [] 可选 A11-2 集装箱编号集装箱编号列表 └ extendProps Map 可选扩展属性 packageInfo PackageInfo 可选包装信息 packageDetails PackageDetail [] 可选包装明细 └ height String 可选 100 高度（厘米） └ length String 可选 200 长度（厘米） └ overlayTray String 可选 0 是否叠托（1=是、0=否） └ packageType String 可选 1 包装单位（1=托盘、2=装箱） └ qty Number 可选 1 数量 └ trayType String 可选 1 托盘材质（1=塑料、2=木质（IPPC）、3=木质（无IPPC）、4=纸质） └ width String 可选 200 宽度（厘米） └ extendProps Map 可选扩展属性 └ totalVolume String 可选 1 总体积（立方米） └ totalWeight String 可选 2 总重量（KG） └ extendProps Map 可选扩展属性 └ totalPrice String 可选 2708 单据头上的货物的总体货值 └ currency String 可选 USD 单据头上的币种 items Item [] 可选商品明细 └ expiryDate String 可选 2026-03-05 失效日期（YYYY-MM-DD） └ itemCode String 可选 752877229 商品编码 └ itemName String 可选唇膏商品名称 └ originRegion String 可选 US 原产国编码 └ produceCode String 可选 EX123 生产批号 └ productDate String 可选 2023-03-06 生产日期（YYYY-MM-DD） └ purchasePrice String 可选 6.77 采购单价 └ qty String 可选 20 数量 └ totalPrice String 可选 135.4 总价 └ extendProps Map 可选扩展属性 └ weight String 可选 0.5 合计重量 (kg） └ volume String 可选 0.5 合计体积 (立方米） └ currency String 可选 USD 币种 itemPackages ItemPackage [] 可选商品包装详情 └ itemCode String 可选 752877229 商品编码 └ itemQuantity Number 可选 20 数量 └ boxNo String 可选 B01 箱号 └ palletNo String 可选 P01 托盘编号 └ itemPackageLineNo String 可选 LI0010 装箱明细行号 └ extendProps Map 可选扩展属性 attachments Attachment [] 可选目的地清关申报文件 └ name String 可选供海关查验装箱明细文件文件名称 └ url String 可选 https://a.demo.com/a.xlsx URL，有效期：1年 └ attachmentType String 可选 PIC 附件类型（PIC=箱单/发票/合同、PACK=供海关查验装箱明细文件、ESIGN=卖方电子章文件、MSDS=MSDS文件、BOL=提单文件、OTHER=其他附件） └ fileType String 可选 pdf 文件类型 └ extendProps Map 可选扩展属性 shipperInfo ShipperInfo 可选发货人（发货人将展示在提单上） └ address String 可选永寿街9号详细地址 └ area String 可选余杭区区 └ city String 可选杭州市市 └ companyName String 可选富勒斯公司公司名称 └ country String 可选中国国家 └ email String 可选 a@demo.com 邮箱 └ name String 可选张三姓名 └ phone String 可选 58867727 电话 └ province String 可选浙江省省 └ socialCreditCode String 可选 90822X1093 统一社会信用代码 └ zipCode String 可选 100086 邮编 └ extendProps Map 可选扩展属性 consigneeInfo ConsigneeInfo 可选收货人（收货人将展示在提单上） └ address String 可选永寿街9号详细地址 └ area String 可选余杭区区 └ city String 可选杭州市市 └ companyName String 可选杜瓦公司公司名称 └ country String 可选中国国家 └ email String 可选 a@demo.com 邮箱 └ name String 可选李四姓名 └ phone String 可选 58867727 电话 └ province String 可选浙江省省 └ socialCreditCode String 可选 90822X1093 统一社会信用代码 └ zipCode String 可选 100086 邮编 └ extendProps Map 可选扩展属性 supplierInfo SupplierInfo 可选供应商 └ address String 可选永寿街9号详细地址 └ area String 可选余杭区区 └ city String 可选杭州市市 └ companyName String 可选拉威尔公司公司名称 └ country String 可选中国国家 └ email String 可选 a@demo.com 邮箱 └ name String 可选孙七姓名 └ phone String 可选 58867727 电话 └ province String 可选浙江省省 └ socialCreditCode String 可选 90822X1093 统一社会信用代码 └ zipCode String 可选 100086 邮编 └ extendProps Map 可选扩展属性 bookingPartyInfo BookingPartyInfo 可选商家联系人信息（物流状态和费用确认通知会发送到商家联系人邮箱，可支持填入多个邮箱） └ name String 可选赵六姓名 └ phone String 可选 58867727 电话 └ emails String [] 可选 d@demo.com 邮箱邮箱列表 └ extendProps Map 可选扩展属性 notifierInfo NotifierInfo 可选通知人（通知人将展示在提单上） └ address String 可选永寿街9号详细地址 └ area String 可选余杭区区 └ city String 可选杭州市市 └ companyName String 可选瓦格纳公司公司名称 └ country String 可选中国国家 └ email String 可选 a@demo.com 邮箱 └ name String 可选王五姓名 └ phone String 可选 58867727 电话 └ province String 可选浙江省省 └ socialCreditCode String 可选 90822X1093 统一社会信用代码 └ zipCode String 可选 100086 邮编 └ extendProps Map 可选扩展属性 └ extendProps Map 可选扩展属性

响应参数

名称	类型	示例值	描述
response	Response		返回
└ success Boolean false 是否成功，true-成功; false-失败 └ biz_error_code String E0001 错误编码 └ biz_error_msg String invalid app key 错误描述 └ retry Boolean false 是否可重试 true-可重试 └ outerOrderCode String EXT11234 服务商系统的清关作业单号

请求示例

{"request":{"orderType":"TOB_CLEARANCE","superviseType":"保税电商","tradeRegion":"美国","attachments":[{"attachmentType":"PIC","name":"供海关查验装箱明细文件","extendProps":"","url":"https://a.demo.com/a.xlsx","fileType":"pdf"}],"ownerCode":"AX766232","totalPrice":"2708","loadInfo":{"productDesc":"lipstick","temperature":"-5","extendProps":"","loadingType":"FCL","productType":"TEMPERATURE","containerTypes":[{"containerType":"20GP","qty":"20","extendProps":""}]},"shipperInfo":{"area":"余杭区","country":"中国","zipCode":"100086","address":"永寿街9号","province":"浙江省","city":"杭州市","phone":"58867727","companyName":"富勒斯公司","name":"张三","extendProps":"","socialCreditCode":"90822X1093","email":"a@demo.com"},"basicInfo":{"toWarehouse":"仓01","isSameWarehouse":"0","toRegion":"中国","loadingTypePortToWH":"FTL","fromCustomsArea":"西雅图","fromWarehouse":"仓A","extendProps":"","fromLocation":"西雅图","toCustomsArea":"上海吴淞","fromRegion":"美国","toLocation":"上海"},"supplierInfo":{"area":"余杭区","country":"中国","zipCode":"100086","address":"永寿街9号","province":"浙江省","city":"杭州市","phone":"58867727","companyName":"拉威尔公司","name":"孙七","extendProps":"","socialCreditCode":"90822X1093","email":"a@demo.com"},"carrierInfo":{"expectArrivePortDate":"2023-12-16","flightNo":"101","hblNo":"BOL112-1","carrierName":"ABC","shippingName":"通达","flightDate":"2023-12-16","mblNo":"BOL112","containerCodes":["A11-2\t集装箱编号"],"transportMode":"OCEAN","extendProps":"","expectArriveWarehouseDate":"2023-12-16"},"ownerName":"富勒斯海外旗舰店","resourceCode":"STA","bookingPartyInfo":{"emails":["d@demo.com\t邮箱"],"phone":"58867727","name":"赵六","extendProps":""},"notifierInfo":{"area":"余杭区","country":"中国","zipCode":"100086","address":"永寿街9号","province":"浙江省","city":"杭州市","phone":"58867727","companyName":"瓦格纳公司","name":"王五","extendProps":"","socialCreditCode":"90822X1093","email":"a@demo.com"},"consigneeInfo":{"area":"余杭区","country":"中国","zipCode":"100086","address":"永寿街9号","province":"浙江省","city":"杭州市","phone":"58867727","companyName":"杜瓦公司","name":"李四","extendProps":"","socialCreditCode":"90822X1093","email":"a@demo.com"},"itemPackages":[{"itemQuantity":20,"boxNo":"B01","itemCode":"752877229","itemPackageLineNo":"LI0010","extendProps":"","palletNo":"P01"}],"entryPort":"上海吴淞","extendProps":"","orderCode":"QG8877623","relatedOrders":[{"orderType":"FIRST_LEG","extendProps":"","orderCode":"TC0005"}],"currency":"USD","packageInfo":{"packageDetails":[{"trayType":"1","overlayTray":"0","qty":1,"length":"200","width":"200","extendProps":"","packageType":"1","height":"100"}],"totalVolume":"1","totalWeight":"2","extendProps":""},"items":[{"totalPrice":"135.4","originRegion":"US","itemCode":"752877229","weight":"0.5","purchasePrice":"6.77","productDate":"2023-03-06","expiryDate":"2026-03-05","volume":"0.5","produceCode":"EX123","itemName":"唇膏","qty":"20","extendProps":"","currency":"USD"}]}}

响应示例

{
    "response":{
        "success":false,
        "biz_error_code":"E0001",
        "biz_error_msg":"invalid app key",
        "retry":false,
        "outerOrderCode":"EXT11234"
    }
}

验签示例

{"response":{"biz_error_msg":"Illegal request","success":"不等于true","biz_error_code":"sign-check-failure"}}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

开放平台

淘天物流API

qimen.taobao.logistics.clearance.entryorder.create (清关作业单创建)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ