1、 API Description

Function Edit Order
Frequency Real-time
Method POST
Type JSON
URI /oms/v1/Order/editOrderByApi

2、 API Request

2.1、Request Parameters
Field Type Required Description
userId string Y Customer ID
(If userId is empty, both ileId and sign are required)
ileId string Y ileId
sign string Y Sign
data object Y Oder information
orderNumber string Y Order code
(Both conCode and refCode are acceptable）
custRef string N Customer reference
packs string Y Number of packages in the order
weight string Y Order total weight (Unit: KG)
cbm string Y Order total volume (Unit: CBM)
battery string Y Battery status:
0 - no battery
1 - with battery
2 - pure battery
amazon_shipment_ids string Y Amazon shipment code
amazon_po string Y Amazon PO number
currency string Y Currency (Default: USD)
fbaWarehouseCode string N FBA warehouse code
(required when channel is “FBA”）
shipper object Y Shipper information
postcode string Y Shipper’s postcode
email string Y Shipper’s email
country string Y Shipper’s country
company string Y Shipper’s company
name string Y Shipper’s name
state string Y Shipper’s province
city string Y Shipper’s city
address string Y Shipper’s detailed address
phone string Y Shipper’s phone number
consignee object Y Consignee information
email string N Consignee’s email
name string Y Consignee’s name
postcode string Y Consignee’s postal code（cannot be edited）
state string Y Consignee’s state
suburb string Y Consignee’s city/district
address string Y Consignee’s detailed address
phone string Y Consignee’s phone number
items object Y Information about items in the order
type string N Type of the items
nameZh string Y Item name in Chinese
name string Y Item name in English
hs string N HS code of the items
qty string Y Quantity of the items
price string Y Unit price of the items (Unit: USD)
parcelList object N Information about package dimensions and weight (optional)
(If filled in, must match the number of packs)
barcode string Y Package barcode number
parcelWidth number Y Package width when entering the warehouse (Unit: CM)
parcelHeight number Y Package height when entering the warehouse (Unit: CM)
parcelLength number Y Package length when entering the warehouse (Unit: CM)
parcelWeight number Y Package weight when entering the warehouse (Unit: KG)
2.2、Request Message Example
{
    "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、 API Response

3.1、Common Response Parameters
Field Type Max Length Required Description
body object - Y
code integer(int32) - Y
msg string - Y
3.1.1、Response Status
Status Code Description
200 Order edit successful
401 Unauthorized
403 Forbidden
404 Not Found
500 System error
3.2、Success Response Example
{
    "body": "Order edit successful",
    "code": 200,
    "msg": "Order edit successful"
}
作者：conghui  创建时间：2024-09-12 15:42
最后编辑：conghui  更新时间：2025-12-16 17:30