创建运单

接口URL

/shipment/createLabel

请求方式

POST

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
sellerOrderNumber	TESTORDER-001	String	是	销售订单号
userTag	TEST	String	否	用户标签，可选
serviceCode	-	String	是	系统服务渠道代码
orderType	1	Number	否	订单类型， 1.快递单，2.LTL Freight订单。默认值为1 快递可不传，LTL Freight订单需传
trackingManifestType	-	int	否	枚举值：1和2，默认1.当值为1时仅创建记录无其它预上网，当值2时可有多条预上网记录，仅用于个别USPS渠道，渠道是否支持详询客户经理
shipFrom	-	Object	是	发件地址信息
shipFrom.code	-	Object	否	发件地址代码
shipFrom.name	TEST	String	是	公司名或发件人
shipFrom.attentionName	TEST	String	否	发件人名称
shipFrom.countryCode	US	String	是	国家2位简写代码
shipFrom.stateCode	CA	String	是	州2位简写代码
shipFrom.city	rowland height	String	是	城市
shipFrom.addressLine1	test	String	是	地址1
shipFrom.addressLine2	-	Object	否	地址2
shipFrom.postalCode	91748	String	是	邮编
shipFrom.phone	0000000000	String	是	电话号码
shipFrom.phoneExtension	0000	String	否	电话号码分机号
shipFrom.isResidential	-	-	是	是否住宅地址，true或者false
shipTo	-	Object	是	-
shipTo.name	TEST	String	是	公司名或收件人
shipTo.attentionName	TEST	String	否	收件人名称
shipTo.countryCode	US	String	是	国家2位简写代码
shipTo.stateCode	CA	String	是	州2位简写代码
shipTo.city	rowland height	String	是	城市
shipTo.addressLine1	test	String	是	地址1
shipTo.addressLine2	-	Object	是	地址2
shipTo.postalCode	91748	String	是	邮编
shipTo.phone	0000000000	String	是	电话号码
shipTo.phoneExtension	0000000000	String	否	电话号码分机号
shipTo.isResidential	true	Boolean	是	是否住宅地址，true或者false
packages	-	Object Array	是	包裹列表
packages.length	10	Number	是	包裹长
packages.width	10	Number	是	包裹宽
packages.height	10	Number	是	包裹高
packages.weight	14	Number	是	包裹重量(单个包裹)
packages.quantity	1	Number	是	包裹数量,LTL Freight单时为托数
packages.quantityUnitPcs	1	Number	是	LTL单每托箱数,仅对LTL Freight单有效
packages.declaredValue	100	Number	否	包裹保险价值USD(单个包裹）
packages.reference1	REF01	String	否
packages.reference2	-	Object	否	包裹参考号2
packages.dangerousGoods	-	Object Array	否	根据渠道实际要求传输
packages.dangerousGoods.adrClass	4.2	string	是	ADR Class is mandatory, but can be left empty for limited quantities (LQ) and excepted quantities (EQ).
packages.dangerousGoods.unNumber	1380	int	是
packages.dangerousGoods.properShippingName	test	string	是	The Proper Shipping Name (PSN) is that portion of the ADR entry most accurately describing the goods in.
packages.dangerousGoods.tunnelCode	E	string	是	B/E
packages.dangerousGoods.grossWeight	100	Number	是
packages.dangerousGoods.numberOfPieces	10	Number	是
packages.dangerousGoods.packageType	IBC	Number	是	Official ADR Packaging code
packages.dangerousGoods.limitedQuantity	true	bool	是	true/false
products	-	Object Array	否	Invoice产品申报列表,当为国际运单时需要填写
products.description	product name	String	是	产品申报名称
products.declaredValue	10	Number	是	产品申报价值
products.declaredValueClass	1	Number	否	申报价值金额类别：1.单价 2.总价. 默认为1单价
products.hsCode	96000000	String	是	产品海关编码
products.originCountry	CN	String	是	产品原产地国家两位简写编码
products.quantity	10	Number	是	产品数量
products.weight	10	Number	否	产品重量
options	-	Object	是	订单服务选项
options.dimensionUnitCode	IN	String	是	包裹尺寸单位, 值为IN （英寸）
options.weightUnitCode	LBS	String	是	包裹重量单位，值为LBS （磅）
options.packageType	customPackage	String	否	包装类型，默认为自有包裹包装，暂无其它值
options.shipDate	2022-05-14	String	否	快递单发货日期，LTL Freight单提货日期必填，格式：2022-01-01
options.deliveryConfirmation	signature	String	否	签名服务方式，无签收：none，普通签收：signature ,成人签收：adultSignature
options.isReturnLabel	false	Boolean	否	是否退货单，默认为false
options.isDG	false	Boolean	否	是否危险品，默认为false
options.isUniqueSellerOrderNumber	false	String	否	是否限定销售订单号为唯一，如不唯一即已存在单号则返回失败。默认为false不限定单号
orderInsurance	订单保险	Object	否	渠道按订单购买保险，仅支持可按订单总购买保险时有效，请咨询客户经理
orderInsurance.amount	1000	Number	否	订单保险总额
orderInsurance.currencyCode	EUR	String	否	币种，如EUR，USD等，不同渠道支持可能不同，请咨询客户经理
accessorialServices	[“DLG”]	String数组	否	LTL Freight订单特殊要求额外服务，枚举值：DLG (Delivery Lift Gate), DAP (Delivery Appointment),DSU (Delivery Self Unload),SUL (Delivery Side Unloading),PLG (Pickup Lift Gate),PLG (Pickup Side Loading),DBC (Drop Off By Consignor)
additionalInformations	[{“code”:"",“value”:""}]	Object数组	否	Freight订单附加信息
code	EKAER_NUMBER	string	否	识别码，DHL Freight: “EKAER_FREE”,“EKAER_NUMBER”,“SENT_REF”,“SENT_CARKEY”,“UIT_FREE”,“UIT_NUMBER”
value	E23022311111111	string	否	值

请求示例

{
    "sellerOrderNumber": "TESTORDER-001",
    "shipFrom": {
        "code": "",
        "name": "TEST",
        "attentionName": "TEST",
        "countryCode": "US",
        "stateCode": "CA",
        "city": "rowland height",
        "addressLine1": "test",
        "addressLine2": "",
        "postalCode": "91748",
        "phone": "0000000000",
        "phoneExtension": "0000"
    },
    "shipTo": {
        "name": "TEST",
        "attentionName": "TEST",
        "countryCode": "US",
        "stateCode": "CA",
        "city": "rowland height",
        "addressLine1": "test",
        "addressLine2": "",
        "postalCode": "91748",
        "phone": "0000000000",
        "phoneExtension": "0000000000",
        "isResidential": true
    },
    "packages": [
        {
            "length": 10,
            "width": 10,
            "height": 10,
            "weight": 14,
            "quantity": 1,
            "reference1": "REF01"
        }
    ],
    "options": {
        "dimensionUnitCode": "IN",
        "weightUnitCode": "LBS"
    }
}

返回示例

{
    "code": 200,
    "data": {
        "masterTrackingNumber": "1Z005780000000000",   //主单号
        "ShipmentNo": "shipment_c26h06ron0mddh2186p0",
        "carrierCode": "UPS",
        "serviceCode": "UPSGround",   //渠道代码
        "totalCharge": 10.02,   //运费价格
        "currencyCode": "USD",
        "chargeItems": null,
        "labelUrl": "https://pdf_url",
        "labelFileType": "pdf",
        "trackingNumbers": [   //运单号列表
            "1Z005780000000000"
        ],
        "sellerOrderNumber": "TESTORDER-001",
        "fileDatas": null   //仅国际渠道时返回Invoice数据使用
    },
    "message": "success"
}