创建运单

创建运单

请求方法：POST

接口路径： createShipment

请求参数：

1、Header 请求参数（用于token校验）:

参数名	示例值
token	dd98b364e0c0c2f5e7da0683044e9e9b

2、Body 请求参数：

参数名	描述	是否必填	数据类型	字段长度
referenceNo	客户自定义单号，唯一	是	String	30
productCode	服务编码 取Service Code的值 如：JPDLY	是	String	10
weight	包裹重量，单位：KG 精确到3位小数	是	Number	8
length	包裹长度，单位：cm	是	Number	8
width	包裹宽度，单位：cm	是	Number	8
height	包裹高度，单位：cm	是	Number	8
remark	包裹派送备注	否	String	100
receiver	收件人信息	是	Object
company	收件人公司	否	String	100
fullname	收件人全名	是	String	50
phone	收件人电话	是	String	20
email	收件人email	否	String	50
country	收件人国家	是	String	50
province	收件人省/州	是	String	100
city	收件人城市	是	String	100
address	收件人详细地址	是	String	200
postCode	收件人邮编	是	String	10
sender	发件人信息	是	Object
company	发件人公司	否	String	100
fullname	发件人	是	String	50
phone	发件人电话	是	String	20
email	发件人email	否	String	50
country	发件人国家	是	String	50
province	发件人省/州	否	String	100
city	发件人城市	是	String	100
address	发件人详细地址	是	String	200
postCode	发件人邮编	是	String	10
itemList	包裹物品明细	是	Array[itemList]
sku	SKU编码	是	String	30
goodsName	包裹商品品名	是	String	100
composition	商品材质 商品成分英文描述	否	String	100
weaveType	织造方式 织造方式/方法英文描述	否	String	200
fullDescEn	销售描述	是	String	1000
hsCode	HS CODE	是	String	10
quantity	数量	是	Number	10
itemWeight	重量，单位：kg 精确到3位小数	是	Number	7
itemValue	商品价值	是	String	10
currency	货币单位	是	String	5
sellingUrl	商品销售链接	是	String	1000
imageUrl	商品图片链接	是	String	500

请求示例：

{
    "referenceNo": "JP230107090",
    "productCode": "JPDLY",
    "weight": 0.9,
    "length": 55,
    "width": 40,
    "height": 10,
    "remark": "守衛室に入れてください",
    "receiver": {
        "company": "",
        "fullname": "涼太京雉",
        "phone": "097-7560-0001",
        "email": "kamdota@gmail.com",
        "country": "日本",
        "province": "倉敷市",
        "city": "岡山県",
        "address": "玉島長尾412",
        "postCode": "7000045"
    },
    "sender": {
        "company": "TEST COMPANY",
        "fullname": "John smith",
        "phone": "090-8293-5630",
        "email": "test@ksb-lgs.com",
        "country": "China",
        "province": "guangdong",
        "city": "guangzhou",
        "address": "388 Guangyuanzhong Road",
        "postCode": "5988508"
    },
    "itemList": [
        {
            "sku": "pok1238123",
            "goodsName": "GO Plus",
            "composition":"100% Polyester",
            "weaveType":"plain",
            "fullDescEn": "pokemon",
            "hsCode": "672931200",
            "quantity": "1",
            "itemWeight": "1.193",
            "itemValue": "13390",
            "currency": "JPY",
            "sellingUrl": "https://www.amazon.co.jp/gp/aw/d/B0CLYCCG1N",
            "imageUrl": "https://m.media-amazon.com/images/I/61MVcnn+3oL._AC_SX679_.jpg"
        },
        {
            "sku": "bro971273",
            "goodsName": "Brook ポケモンGO用 ポケットオートキャッチ",
            "composition":"100% Polyester",
            "weaveType":"jacquard",
            "fullDescEn": "Watchic Plus Pocket Auto Catch Watchic Plus",
            "hsCode": "672931300",
            "quantity": "1",
            "itemWeight": "2.818",
            "itemValue": "21590",
            "currency": "JPY",
            "sellingUrl": "https://www.amazon.co.jp/gp/aw/d/B0B6ZH711X",
            "imageUrl": "https://m.media-amazon.com/images/I/71-EL5pB8hL._AC_SX679_.jpg"
        }
    ]
}

响应参数

1、参数说明

参数名	字段解释	类型
success	接口请求成功或者失败 成功：true,失败：false	boolean
code	接口返回成功/失败代码 详情可以查看错误代码列表	Integer
message	接口调用结果详情	String
requestId	接口调用ID，每次返回为唯一值	String
result
trackingNo	包裹物流单号	String
referenceNo	请求时传入的参考号	String
productCode	服务代码	String
labelUrl	包裹面单地址	String

响应示例

{
    "success": true,
    "code": 200,
    "message": "success",
    "requestId": "3a84b8f304f5faafc444ba9ec996961c",
    "result": {
        "trackingNo": "163395270080",
        "referenceNo": "JP230107090",
        "productCode": "JPDLY",
        "labelUrl": "https://api.ksb-lgs.com/labels/163395270080/3a84b8f304f5faafc444ba9ec996961c-JP230107025.pdf"
    }
}