API文档
使用手册
API文档
使用手册
  • 简介
  • 使用说明
  • 订单API

    • 创建订单
    • 取消订单
    • 生成ScanForm单据
    • 获取Fba仓
    • 获取用户信息
    • 获取订单信息列表数据
    • 获取面单
    • 费用试算
    • 推送订单物流轨迹协议
    • 根据物流单号获取面单信息
  • 运营API

    • 运营
    • 运营api

创建订单

场景说明

创建订单接口针对于创建订单、同步问题件、取消订单重新创建、查询订单信息场景做了适配,仅支持以下场景且幂等逻辑仅支持50个小时! 1.创建订单(参考号在我们系统不存在或者都是已取消状态) 2.同步问题件(请求参数幂等,第二次重复调用创单接口时,走同步问题件的逻辑) 3.取消订单-重新创建(请求参数不幂等时,且当前参考号订单状态为问题件时,先取消参考号原有的问题件,再走重新创建的逻辑) 4.查询订单信息(请求参数幂等,且当前参考号订单状态为预报走查询详情逻辑)

接口名

{域名}/api/svc/createOrder

请求方式

POST

Header请求头

参数名是否必填类型说明
Authorization是string授权码:访问授权 Token

请求参数

参数名二级参数名是否必填类型说明
reference_no-是string参考号(客户单号),长度不得超过35位
sm_code-是string物流产品代码, 可咨询服务商或使用getUserInfo查询
remark否string订单备注信息 长度不得超过35位
oa_firstname是string收件人姓名 长度不能小于3位,并且长度不能大于35位
oa_company否string收件人公司 长度不得超过35位
oa_street_address1是string收件人地址1 长度不得超过35位
oa_street_address2否string收件人地址2 长度不得超过35位
oa_postcode是string收件人邮编 5-4格式邮编,邮编长度最短5位数,最长10位数
oa_state是string收件人州 需要填写两位简称,只能为大写二字编码
oa_city是string收件人城市 长度最短1位数,最长30位数
oa_country是string收件人国家 要求固定值US
oa_telphone是string收件人电话 10-15位之间
is_more_box是integer包裹类型:固定值,请传1
signature_service否string签名服务:是否需要签名服务:ASS为 成人签名 ,DSS 为直接签名 ISS 为间接签名,不需要可以不传该字段
pick_up否integer是否提货 1:是,0:否,不传默认为否, 传1(是)需要物流产品支持,物流产品不支持传1(是)也无效
weight_unit_type否integer包裹单位类型: 1-英制(INCH/LBS) 2-公制(CM/KG) 默认为2
label_custom_type否String自定义面单打印类型: 1为都打印 2为打印参考号 3为仅仅打印备注 默认为1
mailing_date否string发货日期 格式为yyyy-MM-dd
label_image_format否string面单格式: PDF、ZPL(打印机格式) 默认为PDF
has_ups_label_cropped否stringUPS面单是否裁剪,true为裁剪,false为不裁剪 不传默认为true
generate_gx_event否string是否生成gx预报轨迹 不传默认为true
box_list是array包裹信息
-box_listbox_length是number长 最多支持两位小数, '超过两位小数则截取前两位小数'
-box_listbox_width是number宽 最多支持两位小数, '超过两位小数则截取前两位小数'
-box_listbox_height是number高 最多支持两位小数, '超过两位小数则截取前两位小数'
-box_listbox_actual_weight是number重量 最多支持三位小数
-box_listsku否stringsku, 如果sku没有填,则取订单备注信息的值
-box_listcn_name否string中文名称
-box_listeng_name否string英文名称
-box_listapply_company否string申报单位
-box_listapply_number否number申报数量
-box_listapply_unit_price否number申报单价
-box_listapply_unit_weight否number申报单重
-box_listgood_detail否string配货信息
-box_listcustoms_code否string海关编码
-box_listsale_url否string销售链接
-box_listcn_material否string中文材质
-box_listeng_material否string英文材质
-box_listproduce_country否string生产国家
-box_listremark否string包裹备注
shipper_address是object发件人信息, 发件人信息必须与我司备案信息完全一致, 发件人信息与发件人编码同时存在时,以发件人信息为准
-shipper_addressshipper_name是string发件人姓名,长度最短3位数,最长35位数
-shipper_addressshipper_company否string发件人公司, 长度最长35位数
-shipper_addressshipper_telphone是string发件人电话, 10-15位之间
-shipper_addressshipper_country是string发件人国家, 要求固定值US
-shipper_addressshipper_state_province是string发件人州, 只能为大写二字编码
-shipper_addressshipper_city是string发件人城市, 长度最短1位数,最长30位数
-shipper_addressshipper_address1是string发件人地址1,长度不得超过35位
-shipper_addressshipper_address2否string发件人地址2,长度不得超过35位
-shipper_addressshipper_postal_code是string发件人邮编, 长度最短5位数,最长10位数
shipper_code是string发件人编码, 发件人信息与发件人编码同时存在时,以发件人信息为准
return_address否object退件地址信息
-return_addressstreet_address是string退件信息-街道地址
-return_addresssecondary_address是string退件信息-街道地址2
-return_addresszip_code_and_plus4是string退件信息-邮政编码-扩展邮编,如果有扩展邮编则用 - 拼接在后面,比如:75115-2500
-return_addresscity是string退件信息-城市
-return_addressstate是string退件信息-州
-return_addressfirst_name是string退件信息-联系人名字
-return_addresslast_name否string退件信息-联系人姓氏
-return_addressphone否string退件信息-联系人电话

输入示例(body)


{
    "reference_no": "string",
    "sm_code": "string",
    "remark": "string",
    "oa_firstname": "string",
    "oa_company": "string",
    "oa_street_address1": "string",
    "oa_street_address2": "string",
    "oa_postcode": "string",
    "oa_state": "string",
    "oa_city": "string",
    "oa_country": "string",
    "oa_telphone": "string",
    "is_more_box": 1,
    "signature_service": "string",
    "weight_unit_type": 2,
    "label_custom_type": "1",
    "mailing_date": "2025-06-17",
    "label_image_format": "PDF",
    "has_ups_label_cropped": "false",
    "generate_gx_event": "false",
    "box_list": [
        {
            "box_length": 0,
            "box_width": 0,
            "box_height": 0,
            "box_actual_weight": 0,
            "sku": "111",
            "cn_name": "",
            "eng_name": "",
            "apply_company": "",
             "apply_number": 0,
             "apply_unit_price": 0,
             "apply_unit_weight": 0,
             "good_detail": "",
             "customs_code": "",
             "sale_url": "",
             "cn_material": "",
             "eng_material": "",
             "produce_country": "",
             "remark": ""
        }
    ],
    "shipper_address": {
        "shipper_name": "string",
        "shipper_company": "string",
        "shipper_telphone": "string",
        "shipper_country": "string",
        "shipper_state_province": "string",
        "shipper_city": "string",
        "shipper_address1": "string",
        "shipper_address2": "string",
        "shipper_postal_code": "string"
    },
    "return_address": {
        "street_address": "string",
        "secondary_address": "string",
        "zip_code_and_plus4": "string",
        "city": "string",
        "state": "string",
        "first_name": "string",
        "last_name": "string",
        "phone": "string"
  },
    "shipper_code": "string"
}


返回参数

参数名二级参数名是否必填类型说明
code-是string响应码,200-成功
result-是object响应结果
msg-是string响应消息
-resultorder_code是string响应结果
-resultfee是array费用信息
-result.feeft_code是string费用英文名称
-result.feeamount是string金额
-result.feecurrency_code是string币种
-result.feeft_name是string费用中文名称
-resultfee_detail是array费用详情
-result.fee_detailft_code是string费用英文名称
-result.fee_detailamount是string金额
-result.fee_detailtracking_number是string物流单号
-result.fee_detailbox_code是string箱号
-result.fee_detailcurrency_code是string币种
-result.fee_detailft_name是string费用中文名称
-resultlabels是array面单信息, 为空时代表没有生产物流信息,需要异步获取
-result.labelstracking_number是string物流单号
-result.labelstracking_number2否string物流单号 UPS MI时产品返回USPS单号,其余产品不返回
-result.labelslabel_url是string面单URL链接
-result.labelscontext是string创建订单面单格式为ZPL时,才会返回该值
-result.labelsfile_type是string面单类型
-resultmerge_label是string合并面单

输出示例

{
    "code": 200,
    "result": {
        "order_code": "XXXXXX",
        "fee": [
            {
                "ft_code": "shipping",
                "amount": "4.00",
                "currency_code": "USD",
                "ft_name": "运费"
            },
            {
                "ft_code": "FSC",
                "amount": "0.04",
                "currency_code": "USD",
                "ft_name": "燃油附加费"
            }
        ],
        "fee_detail": [
            {
                "ft_code": "shipping",
                "amount": "1.00",
                "tracking_number": "XXXX",
                "box_code": "XXXXXX-1",
                "currency_code": "USD",
                "ft_name": "运费"
            },
            {
                "ft_code": "FSC",
                "amount": "0.01",
                "tracking_number": "XXXX",
                "box_code": "XXXXXX-1",
                "currency_code": "USD",
                "ft_name": "燃油附加费"
            },
            {
                "ft_code": "shipping",
                "amount": "1.00",
                "tracking_number": "XXXX",
                "box_code": "XXXXXX-2",
                "currency_code": "USD",
                "ft_name": "运费"
            },
            {
                "ft_code": "FSC",
                "amount": "0.01",
                "tracking_number": "XXXX",
                "box_code": "XXXXXX-2",
                "currency_code": "USD",
                "ft_name": "燃油附加费"
            },
            {
                "ft_code": "shipping",
                "amount": "1.00",
                "tracking_number": "XXXX",
                "box_code": "XXXXXX-3",
                "currency_code": "USD",
                "ft_name": "运费"
            },
            {
                "ft_code": "FSC",
                "amount": "0.01",
                "tracking_number": "XXXX",
                "box_code": "XXXXXX-3",
                "currency_code": "USD",
                "ft_name": "燃油附加费"
            },
            {
                "ft_code": "shipping",
                "amount": "1.00",
                "tracking_number": "",
                "box_code": "XXXXXX-4",
                "currency_code": "USD",
                "ft_name": "运费"
            },
            {
                "ft_code": "FSC",
                "amount": "0.01",
                "tracking_number": "",
                "box_code": "XXXXXX-4",
                "currency_code": "USD",
                "ft_name": "燃油附加费"
            }
        ],
        "labels": [
            {
                "tracking_number": "XXXX",
                "tracking_number2": "XXXX",
                "label_url": "http://XXXX.pdf",
                "file_type": "pdf",
                "context": ""
            },
            {
                "tracking_number": "XXXX",
                "tracking_number2": "XXXX",
                "label_url": "http://XXXX.pdf",
                "file_type": "pdf",
                "context": ""
            },
            {
                "tracking_number": "XXXX",
                "tracking_number2": "XXXX",
                "label_url": "http://XXXX.pdf",
                "file_type": "pdf",
                 "context": ""
            },
            {
                "tracking_number": "XXXX",
                "tracking_number2": "XXXX",
                "label_url": "http://XXXX.pdf",
                "file_type": "pdf",
                "context": ""
            }
        ],
        "merge_label": "http://XXXX.pdf"
    },
    "msg": "Success"
}
最近更新:: 2025/9/4 16:25
Contributors: lizhi, xiangzhijia
下一页
取消订单