API门户

仓库管理系统门户

创建运单

接口URL

/shipment/createLabel

请求方式

POST

请求Body参数

参数名	示例值	参数类型	是否必填	参数描述
sellerOrderNumber	TESTORDER-001	String	是	销售订单号
serviceCode	–	String	是	系统服务渠道代码
poZipCode	–	String	是	发货仓（交邮）地址邮编（5位），仅适用于部分 USPS 渠道
shipFrom（发件人信息对象）
shipFrom.code	–	String	否	发件地址代码
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	–	String	否	地址2
shipFrom.postalCode	91748	String	是	邮编
shipFrom.phone	0000000000	String	是	电话号码
shipFrom.phoneExtension	0000	String	否	电话号码分机号
shipFrom.isResidential	false	Boolean	是	是否为住宅地址（true/false）
shipTo（收件人信息对象）
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	–	String	是	地址2
shipTo.postalCode	91748	String	是	邮编
shipTo.phone	0000000000	String	是	电话号码
shipTo.phoneExtension	0000000000	String	否	电话号码分机号
shipTo.isResidential	true	Boolean	是	是否为住宅地址
packages（包裹信息数组）
length	10	Number	是	包裹长
width	10	Number	是	包裹宽
height	10	Number	是	包裹高
weight	14	Number	是	包裹重量
quantity	1	Number	是	包裹数量
declaredValue	100	Number	否	包裹保险价值（USD）
reference1	REF01	String	否	包裹参考号1
reference2	–	String	否	包裹参考号2
products（产品信息数组，仅用于国际订单）
description	product name	String	是	产品名称
declaredValue	10	Number	是	产品申报价值
hsCode	96000000	String	是	海关编码
originCountry	CN	String	是	原产国代码（2位）
quantity	10	Number	是	产品数量
weight	10	Number	否	产品重量
options（订单服务选项）
dimensionUnitCode	IN	String	是	尺寸单位（IN 英寸）
weightUnitCode	LBS	String	是	重量单位（LBS 磅）
packageType	customPackage	String	否	包装类型，默认为自有包装
shipDate	2022-05-14	String	否	发货日期（格式：YYYY-MM-DD）
deliveryConfirmation	signature	String	否	签收方式（none / signature / adultSignature）
isReturnLabel	false	Boolean	否	是否为退货单
isDG	false	Boolean	否	是否为危险品
isUniqueSellerOrderNumber	false	Boolean	否	是否强制唯一销售单号

请求示例

{
  "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
  },
  "message": "success"
}