1、 接口说明

接口名称 编辑订单
频率 实时
Method POST
Type JSON
URI /oms/v1/Order/editOrderByApi

2、 接口请求

2.1、请求参数
Field 类型 是否必填 描述
userId string Y 下单客户ID (若userId为空，则ileId、sign必填)
ileId string Y ileId
sign string Y Sign
data object Y 订单信息
orderNumber string Y 订单号（运单号、尾程派送单号均可）
custRef string N 客户编号
packs string Y 订单内包裹数量
weight string Y 订单重量， 单位：KG
cbm string Y 订单总体积，单位：立方米
battery string Y 是否带电：0-不带电、1-带电、2-纯电
amazon_shipment_ids string Y 亚马逊编码
amazon_po string Y 亚马逊编码
currency string Y 币种(默认为：USD)
fbaWarehouseCode string N FBA仓库代码，渠道为FBA时字段必填
shipper object Y 发货人
postcode string Y 发件人邮编
email string Y 发件人邮箱
country string Y 发件人国家
company string Y 发件人公司
name string Y 发件人姓名
state string Y 发件人省份
city string Y 发件人城市
address string Y 发件人详细地址
phone string Y 发件人电话
consignee object Y 收件人
email string N 收件人邮箱
name string Y 收件人姓名
postcode string Y 收件人邮编（收件人邮编不可编辑）
state string Y 收件人州
suburb string Y 收件人城市/区
address string Y 收件人详细地址
phone string Y 收件人电话
items object Y 订单中的物品信息
type string N 包裹中的物品类型
nameZh string Y 包裹中的物品中文名称
name string Y 包裹中的物品名称
hs string N 包裹中的商品hscode
qty string Y 包裹中的物品数量
price string Y 包裹中的物品价值，单位：USD
parcelList object N 包裹尺重信息，非必填；若填写，则列表数据量 需与 packs(订单内包裹数量) 保持一致
barcode string Y 包裹条码号
parcelWidth number Y 货物入库宽度， 单位：CM
parcelHeight number Y 货物入库高度， 单位：CM
parcelLength number Y 货物入库长度， 单位：CM
parcelWeight number Y 货物入库重量， 单位：KG
2.2、请求报文
{
    "ileId":"your_ileId",
    "sign":"your_sign",
    "userId": "your_userId",
    "data": {
        "orderNumber": "3674U3000534",
        "amazon_po": "",
        "amazon_shipment_ids": "",
        "cbm": "0.13",
        "weight": "20",
        "packs": "1",
        "cust_ref": "test00x",
        "consignee": {
            "address": "test consignee address",
            "company": "b803, 521 Harris street",
            "email": "",
            "name": "Tenny1",
            "phone": "123456789",
            "postcode": "2017",
            "state": "NSW",
            "suburb": "WATERLOO"
        },
        "shipper": {
            "postcode": "200120",
            "email": "",
            "country": "CN",
            "company": "",
            "name": "jack1",
            "state": "zcx",
            "city": "zxc",
            "address": "zxc",
            "phone": "123456789"
        },
        "items": [
            {
                "hs": "123",
                "name": "item1",
                "nameZh": "中",
                "price": "3",
                "qty": "1",
                "type": "B"
            },
            {
                "hs": "456",
                "name": "item2",
                "nameZh": "中",
                "price": "3",
                "qty": "1",
                "type": "B"
            }
        ],
        "parcelList": [
            {
                "barcode": "test202408260001-1",
                "parcelWidth": 2.0,
                "parcelHeight": 2.0,
                "parcelLength": 6.0,
                "parcelWeight": 5.0
            }
        ]
    }
}

3、 接口响应

3.1、公共响应参数
Field 类型 最大长度 是否必填 描述
body object - Y
code integer(int32) - Y
msg string - Y
3.1.1、响应状态
状态码 说明
200 订单编辑成功
401 Unauthorized
403 Forbidden
404 Not Found
500 系统异常
3.2、响应报文
{
    "body": "订单编辑成功",
    "code": 200,
    "msg": "订单编辑成功"
}
作者：ZYL  创建时间：2024-08-28 09:46
最后编辑：conghui  更新时间：2025-12-16 17:30