创建订单

提供批量创建订单的能力，支持将外部平台的订单信息同步至西月系统，适用于线上线下各类订单的集中管理，确保订单数据的准确对接和高效处理。

适用场景

电商平台订单同步至西月系统进行后续处理（如发货、物流跟踪）

线下门店订单录入系统，统一管理库存和配送

批量导入历史订单数据，进行数据分析和统计

多平台订单汇总，实现一体化订单管理流程

接口类型

POST

请求频率限制

默认频率：以平台配额为准
额外限制：请求间隔15秒

请求说明

请求URL

正式环境：https://www.westmonth.com/openapi/order/upload
测试环境：https://testing.westmonth.com/openapi/order/upload

请求参数

Header参数

参数名	类型	必填	示例值	说明
Authorization	string	是	authorization	身份验证Token
Content-Type	string	是	application/json	建议固定传此值

Body参数

根字段

参数名	类型	必填	默认值	可选值	说明
orders	array	是	-	-	订单集合，最多20单
uID	string	否	-	-	西月客户uid（ERP合作伙伴必填）
cancelOrders	array	否	-	-	防止重复下单，取消之前未支付订单（平台订单号）

orders数组字段

参数名	类型	必填	默认值	可选值	说明
products	array	是	-	-	产品数据
sellerOrderNo	string	是	-	-	平台订单号
deliveryRegionCode	string	是	-	通过接口获取：/openapi/productCategory/getDeliveryRegions	发货区域编码
deliveryMode	string	是	-	快递配送、第三方物流自提、个人自提	发货模式
countryCode	string	是	-	标准国家二字码，网上可查	国家二字码
zone	string	否	-	标准省、州名称，网上可查	省、州名称(快递配送必填)
city	string	否	-	标准城市名称，网上可查	城市名称(快递配送必填)
county	string	否	-	标准县区、乡镇名称，网上可查	县区、乡镇名称(快递配送必填)
zipcode	string	否	-	-	邮编(快递配送必填)
address1	string	否	-	-	详细地址1(快递配送必填)
address2	string	否	-	-	详细地址2
receiver	string	否	-	-	收件人姓名(快递配送必填)
email	string	否	-	-	邮箱
telephone	string	否	-	-	手机号(快递配送必填)
callingCode	integer	否	-	-	手机区域号
expressUrl	string	否	-	-	面单url(第三方物流自提必填，必须以pdf结尾)
otherFiles	array	否	-	-	其他附件(一维数组，里面传文件url)
barcodes	array	否	-	-	条形码(一维数组，里面传文件url)
logisticsCompany	string	否	-	-	物流公司编码(第三方物流自提必填
shipmentNo	string	否	-	-	物流单号(第三方物流自提必填
platformID	string	否	-	调用接口获取：/openapi/platform/list	平台ID(俄罗斯订单必填，ERP合作伙伴选填)
shopName	string	否	-	-	店铺名称(ERP合作伙伴选填)
node	string	否	-	-	线下备注(ERP合作伙伴选填)
labels	string	否	-	1:线上（本土店）、2:线下（跨境店）	下单类型(俄罗斯订单必填)
isPurchase	string	否	-	false=否、true=是	是否急采
comment	string	否	-	-	买家备注
remark	string	否	-	-	卖家备注
rawData	object	否	-	-	外部单原始数据(ERP合作伙伴选填)
freightOperatorCode	string	否	-	-	指定尾程服务商编码(ERP合作伙伴选填)
fixedDesignatedWarehouseID	array	否	-	通过接口获取：/openapi/depot/list	指定仓库ID(ERP合作伙伴选填，一维数组)

products数组字段

参数名	类型	必填	默认值	可选值	说明
quantity	integer	是	-	-	下单数量
productSku	array	是	-	-	商品SKU

rawData对象字段

参数名	类型	必填	默认值	可选值	说明
shopNumber	string	否	-	-	店铺编号
shopAccountNumber	string	否	-	-	店铺账号
shopName	string	否	-	-	店铺名称（有值会覆盖外层shopName）
shopAddress	string	否	-	-	店铺站点
orderAmount	string	否	-	-	订单金额（人民币）
commodityAmount	string	否	-	-	商品金额
platformFreight	string	否	-	-	平台运费
caid	string	否	-	-	店铺名称
sellerFlag	string	否	-	1:red、2:yellow、3:green、4:blue、5:purple	旗帜
products	array	否	-	-	商品数组信息

products数组字段

参数名	类型	必填	默认值	可选值	说明
product_sku	string	否	-	-	商品SKU
price	string	否	-	-	商品价格
quantity	string	否	-	-	数量
subtotal	number	否	-	-	小计

响应字段说明

成功响应（HTTP 200）

根字段

字段	类型	说明
code	integer	业务状态码（0表示成功）
msg	string	提示信息（成功时为空）
data	object	业务数据

data对象字段

字段	类型	说明
normalData	array	成功数据（已创建订单）
abnormalData	array	异常数据（不会创建订单）

normalData对象字段

字段	类型	说明
sellerOrderNo	string	平台订单号
orderNoXy	string	西月选品网订单号
total	number	订单金额
status	string	订单状态（paid：已支付，unpaid：未支付）

abnormalData对象字段

字段	类型	说明
sellerOrderNo	string	平台订单号
reason	string	异常原因

调用示例

URL请求

请求示例

{
    "orders": [
        {
            "products": [
                {
                    "quantity": 3,
                    "productSku": "E标nHs322yx01-20g"
                }
            ],
            "telephone": "18965213578",
            "receiver": "Stacie R. Sheppard",
            "deliveryRegionCode": "CN",
            "deliveryMode": "快递配送",
            "countryCode": "US",
            "zone": "Alabama",
            "city": "Sylacauga",
            "zipcode": "35150",
            "address1": ", Alabama, Talladega, Sylacauga"
        }
    ]
}

成功返回示例

{
    "code": 0,
    "data": {
        "normalData": [
            {
                "sellerOrderNo": "576722608781890541",
                "orderNoXy": "aOP2505070949450",
                "total": 64,
                "status": "unpaid"
            }
        ],
        "abnormalData": []
    },
    "msg": "请求成功"
}

失败返回示例

{
    "code": 0,
    "data": {
        "normalData": [],
        "abnormalData": [
            {
                "sellerOrderNo": "",
                "reason": "省、州名称:Alabama1异常"
            }
        ]
    },
    "msg": "请求成功"
}

错误处理

公共错误码

HTTP status code	错误码	错误信息	描述

reason错误说明

说明	解决方案
省、州名称:{zone}异常	输入正确的省、州名称

常见问题

Q1：平台订单号是否唯一，能否重复提交？

A：不会判断唯一性，可以传一样的平台订单号。不过后续查订单状态就要用西月订单号。

如果想保证唯一，下单接口的cancelOrders字段，带上平台订单号。

Q2：平台订单号是否限制字符数？以及格式限制？

A：不超过64字符，只允许英文+数字。

版本历史

版本	日期	修改说明
v1.0	2025-01-01	初始版本

application/json

Bodyapplication/json

示例

{
    "code": 0,
    "data": {
        "normalData": [
            {
                "sellerOrderNo": "576722608781890541",
                "orderNoXy": "aOP2505070949450",
                "total": 64,
                "status": "unpaid"
            }
        ],
        "abnormalData": []
    },
    "msg": "请求成功"
}

创建订单

创建订单

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Body参数

products数组字段

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

reason错误说明

常见问题

Q1：平台订单号是否唯一，能否重复提交？

Q2：平台订单号是否限制字符数？以及格式限制？

版本历史

请求参数

请求示例代码

返回响应

创建订单

创建订单#

适用场景#

接口类型#

请求频率限制#

请求说明#

请求参数#

Header参数#

Body参数#

products数组 字段#

响应字段说明#

调用示例#

URL请求#

请求示例#

成功返回示例#

失败返回示例#

错误处理#

reason错误说明#

常见问题#

Q1：平台订单号是否唯一，能否重复提交？#

Q2：平台订单号是否限制字符数？以及格式限制？#

版本历史#

请求参数

请求示例代码

返回响应

创建订单

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Body参数

products数组字段

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

reason错误说明

常见问题

Q1：平台订单号是否唯一，能否重复提交？

Q2：平台订单号是否限制字符数？以及格式限制？

版本历史