技术支持

首页 / API推送订阅

开发者必读

订单管理

入库单管理

资源中心

获取AppToken和AppKey

1.为了用户接收消息时验证请求合法性，其中AppToken用于标识用户需具有唯一性，AppKey用于生成请求签名。完成注册后，在OMS系统的个人中心中获取AppToken和Appkey

数据接收

通过post方式，数据按照key ,value形式发送给订阅者。

签名规则

1.成待签名数据：待签名数据传输的参数Message的值与用户的AppKey的值与发送时间连接而成，举例说明如下:比如: Message=…, AppKey=12345,SendTime=2016-07-27 13:10:10则…123452016-07-27 13:10:10就是待签名数据生成签名：将待签名数据进行MD5加密，即生成了签名。

PHP签名demo

C#签名demo

JAVA签名demo

更新日志

版本	最后修改日期	修改内容
1.5	2020/7/1	库存变更推送删除字段 originalQty targetQty unsellableQty sellableQty stockingQty type 库存变更推送新增字段 adjustment_qty
1.4	2019/9/24	增加商品信息更新推送
1.3	2017/5/24	BackOrder(订单异常推送)增加error_code字段
1.2	2017/5/8	入库单推送节点更改；当入库单状态变为上架完成后推送；增加Java签名方法demo。
1.1	2017/1/4	增加订单退件入库接口；增加订单异常推送接口；增加库存变更推送接口；订单推送接口增加订单商品的S/N码和IMEI码。
1.0	2016/7/26	创建服务以及功能接口定义

接入指南

接入API对接平台开发，开发者需要按照如下步骤完成：

注册OMS账号。

OMS地址： https://oms.goodcang.com，请自行注册用户，并登陆系统。

账号登录OMS后，在菜单栏进入【系统设置】-【开发者中心】，即在页面中填写接收URL地址，点击保存设置即可。

WSDL地址

测试线：https://uat-oms.eminxing.com/default/svc/wsdl

正式线：https://oms.goodcang.net/default/svc/wsdl

service地址(curl数据)

测试线：https://uat-oms.eminxing.com /default/svc/web-service

正式线：https://oms.goodcang.net /default/svc/web-service

公共数据包头设计

发送的数据

属性	类型	是否必填	说明
AppToken	String	Required	用户令牌
Sign	String	Required	签名字符串
MessageType	String	Required	数据类型
Message	String	Required	业务级参数（格式json）
MessageId	String	Required	消息id
SendTime	Datetime	Required	发送时间

响应数据

属性	类型	是否必填	说明	备注
Status	String	Required	是否成功	接收状态(成功: SUCCESS, 失败: FAILED)
ErrorMessage	String	Required	错误信息

SendOrder（订单推送）

推送条件：
1、当订单获取跟踪号后推送。
2、当订单在订单系统状态是签出后推送。
3、（返回成功或者失败状态码时将停止推送，因网络异常原因会继续推送，推送周期5分钟一次）

SendOrderRequest 请求信息

属性	类型	是否必填	说明	备注
order_code	string(32)	Required	订单号	必填,唯一
reference_no	string(32)	Optional	参考号	客户的订单
order_status	int	Required	订单状态	必填,对应枚举 0：未出库; 1：已出库
tracking_number	string(50)	Required	跟踪号
sm_code	string(64)	Required	物流产品Code
add_time	Datetime	Required	创建时间	北京时间
sc_id	Int	Required	渠道id
warehouse_id	Int	Required	仓库id
outStock_time	Datetime	Optional	签出时间	北京时间
so_weight	decimal(10,3)	Required	预估重量
order_weight	decimal(10,3)	Required	计费重量
so_shipping_fee	decimal(10,2)	Required	运输费
outStock_time	Datetime	Optional	签出时间	北京时间
item	Object	Optional	订单明细
fee_details	Object	Optional	费用明细
orderBoxInfo	Object	Optional	箱子明细	一票多箱
property_label	string(50)	Optional	平台模式：SFP	SFP

item

属性	类型	是否必填	说明	备注
product_barcode	string(32)	Required	商品编码	必填,唯一
product_sku	string	Required	客户商品编码
qty	Int	Required	商品数量
fba_product_code	string	Optional	FBA商品编码
transaction_id	string	Optional	ebay订单交易号
snItem	Object	Optional	S/N码明细

fee_details

属性	类型	是否必填	说明
totalFee	float	Required	总费用
SHIPPING	float	Required	运输费
OPF	float	Required	操作费用
FSC	float	Required	燃油附加费
DT	float	Required	关税
RSF	float	Required	挂号
OTF	float	Required	其它费用
currency_code	string	Required	订单费用币种

snItem

属性	类型	是否必填	说明	备注
sn	string	Optional	S/N码
imei	string	Optional	IMEI

orderBoxInfo

属性	类型	是否必填	说明
box_no	string(32)	Required	箱号
ob_qty	Int	Required	数量
ob_length	decimal(10,2)	Required	长
ob_width	decimal(10,2)	Required	宽
ob_height	decimal(10,2)	Required	高
ob_weight	decimal(10,2)	Required	重量
tracking_number	string(64)	Required	跟踪号
product_barcode	string(64)	Required	产品代码

Message json格式

响应数据

成功格式: {"Status":"SUCCESS","ErrorMessage":""}

错误格式: {"Status":"FAILED","ErrorMessage":"同步失败"}

ReturnOrder（订单退件入库）

推送条件：
1、退件类型为服务商退件，客户退件，未预报退件处理完成或销毁推送数据
2、（返回成功或者失败状态码时将停止推送，因网络异常原因会继续推送，推送周期10分钟一次）

ReturnOrderRequest 请求信息

属性	类型	是否必填	说明	备注
order_code	string(32)	Required	订单号	必填,唯一
asro_code	string(32)	Required	售后单号	必填,唯一
tracking_no	string(50)	Required	跟踪号
warehouse	string(64)	Required	退件收货仓
return_type	string(64)	Required	退件类型
customer_code	string(64)	Required	客户代码
complete_time	Datetime	Required	处理完成时间
received_time	Datetime	Required	退件收货时间
item	Object	Optional	退件商品明细

item

属性	类型	是否必填	说明	备注
product_barcode	string(64)	Required	商品编码	必填,没有则为空
product_sku	string(64)	Required	客户商品编码	必填,没有则为空
cass_auth_type	int(1)	Required	是否授权	0：未授权，1：已授权
pi_sellable	Int	Required	良品数量	必填，无则为0
pi_unsellable	Int	Required	不良	必填，无则为0
destruction_qty	Int	Required	销毁数量	必填，无则为0
sellable_data	obj	Optional	良品明细	未授权才有数据
unsellable_data	obj	Optional	不良品明细	未授权才有数据
destruction_data	obj	Optional	销毁明细	未授权才有数据

sellable_data | unsellable_data | destruction_data

pas_code	string(64)	Required	售后码	没有则为空
product_sku	string(64)	Required	新商品编码	换标后的SKU，没有则为空
custom_product_barcode	string(50)	Required	新客户商品编码	换标后的客户SKU，没有则为空
customized_sku	string(50)	Optional	第三方商品编码	未预报退件中仓库输入的第三方商品编码
processing_instruction	int	Optional	处理指令	-1-未处理，2-销毁，3-重新上架，1-超期销毁

fee_details参数

参数名	数据类型	说明
shipping_fee	float	运输费
operating_fee	float	操作费用
fuel_surcharge	float	燃油附加费
other_fee	float	其它费用
currency_code	string	币别

Message json格式

响应数据

成功格式: {"Status":"SUCCESS","ErrorMessage":""}

错误格式: {"Status":"FAILED","ErrorMessage":"同步失败"}

BackOrder（订单异常推送）

推送条件：
当订单发生地址错误等问题不能正常获取跟踪号时，仓库用户操作【回退订单】。（返回成功或者失败状态码时将停止推送，因网络异常原因会继续推送，推送周期5分钟一次）

BackOrderRequest 请求信息

属性	类型	是否必填	说明	备注
order_code	string(32)	Required	订单号	必填,唯一
reference_no	string(32)	Optional	参考号	客户的订单
tracking_number	string(50)	Optional	跟踪号
sm_code	string(64)	Required	物流产品Code
error_code	string(35)	Required	错误代码
error_message	String(1000)	Required	错误信息
error_time	Datetime	Required	错误发生时间	北京时间

Message json格式

响应数据

成功格式: {"Status":"SUCCESS","ErrorMessage":""}

错误格式: {"Status":"FAILED","ErrorMessage":"同步失败"}

SendSKUUpdateInformation（商品信息更新推送）

推送条件：
当商品的实收材积或者货物属性发生变更
关税税率、海外仓是否可存、头程类型字段改变触发推送

SendSKUUpdateInformationRequest 请求信息

属性	类型	是否必填	说明
customer_code	string(20)	Required	客户编码
product_barcode	string(50)	Required	商品编码
product_sku	string(40)	Required	SKU
product_length	decimal(10,2)	Required	商品长
product_width	decimal(10,2)	Required	商品宽
product_height	decimal(10,2)	Required	商品高
product_weight	decimal(10,3)	Required	商品重量
type_of_goods	tinyint(1)	Required	包裹类型 0:包裹,1:信封
contain_battery	tinyint(1)	Required	货物属性 0:普货,1:含电池,2:纯电池,3:纺织品,4:易碎品
declared_value_cn	decimal(10,2)	Optional	出口申报单价
export_country	string	Optional	出口国
declared_name_cn	string	Optional	中文申报品名
remark	string	Optional	审核备注
cargo_type	string	Optional	货型
clearcountry	[object]	Optional	清关备注 clearcountry 对象参照下面说明

clearcountry

import_country	string	Optional	进口国
declared_name_en	string	Optional	英文申报品名
vat_tax_rate	string	Optional	关税税率字段改变触发推送
additional_tax_rate	string	Optional	附加关税税率
declared_value	decimal(10,2)	Optional	进口国申报单价
is_send	int	Optional	海外仓是否可存字段改变触发推送（0不可存 1可存）
head_type	int	Optional	头程类型字段改变触发推送（0 谷仓头程 1 卖家直发）
remark	string	Optional	备注

Message json格式

响应数据

成功格式: {"Status":"SUCCESS","ErrorMessage":""}

错误格式: {"Status":"FAILED","ErrorMessage":"同步失败"}

SendReceiving（入库单推送）

推送条件：
1、入库单状态变成上架完成后推送。
2、（返回成功或者失败状态码时将停止推送，因网络异常原因会继续推送，推送周期5分钟一次）

SendReceivingRequest 请求信息

属性	类型	是否必填	说明	备注
receiving_code	string(32)	Required	入库单号	必填,唯一
reference_no	string(32)	Optional	参考号
receiving_status	tinyint	Required	状态Int,必填. 对应枚举 1：已入库
warehouse_code	string(32)	Required	仓库编码
warehouse_id	Int	Required	仓库id
addTime	Datetime	Required	创建时间	北京时间
updateTime	Datetime	Required	更新时间	北京时间
receiving_type	tinyint	Required	入库单类型	0标准 3中转(易渡代发) 4原标 5FBA
receivingDetail	Object[]	Required	入库明细

receivingDetail

属性	类型	是否必填	说明	备注
product_barcode	string(32)	Required	商品编码	必填,唯一
product_sku	string	Required	客户商品编码
box_no	String(32)	Required	箱号编码
reference_box_no	String	Optional	参考箱号
deliveryQty	Int	Required	送货数量
receiptQty	Int	Required	收货数量
putawayQty	Int	Required	上架数量
unsellableQty	Int	Required	不良品数量
sellableQty	Int	Required	良品数量

Message json格式

响应数据

成功格式: {"Status":"SUCCESS","ErrorMessage":""}

错误格式: {"Status":"FAILED","ErrorMessage":"同步失败"}

SendTakeStock（盘点单推送）

推送条件：
1、当盘点单确认之后推送。
2、（返回成功或者失败状态码时将停止推送，因网络异常原因会继续推送，推送周期5分钟一次）

SendTakeStockRequest 请求信息

takeStockProduct_no	string(32)	Required	盘点单号	主键
customer_code	string(32)	Required	客户编码
warehouse_code	string(32)	Required	仓库编码
product_sku	string(32)	Required	Sku条码
product_barcode	string(32)	Required	商品编码
orgin_quantity	int	Required	系统数量
physicalInventoryQty	int	Required	实盘数量
update_time	string	Required	更新时间

Message json格式

响应数据

成功格式: {"Status":"SUCCESS","ErrorMessage":""}

错误格式: {"Status":"FAILED","ErrorMessage":"同步失败"}

StockChange（库存变更推送）

推送条件：
当库存发生调整和因为标记问题件发生的库存的异动。（推送时间周期5分钟一次）

StockChangeRequest 请求信息

属性	类型	是否必填	说明	备注
Transation_code	string(32)	Required	操作单号	必填
product_barcode	string(32)	Required	商品编码	必填,唯一
product_sku	string	Required	客户商品编码	必填
adjustment_qty	int	Required	差异数量	必填，扣减数量时为负数
transaction_time	Datetime	Required	操作时间	必填
warehouse_code	string	Required	仓库编码	必填
inventory_change_type	int	Required	变更类型	必填。1库存调整; 2冻结; 3移库位（良品转不良品/不良品转良品）

Message json格式

响应数据

成功格式: {"Status":"SUCCESS","ErrorMessage":""}

错误格式: {"Status":"FAILED","ErrorMessage":"同步失败"}

StockChangeRecord（库存动态推送）

推送条件：
当库存发生变动时，实时推送变动信息。

StockChangeRecordRequest 请求信息

属性	类型	是否必填	说明	备注
transaction_code	string	Required	操作单号	产生库存变更的操作对应的单号
reference_no	string	Optional	参考号	产生库存变更操作对应的参考号，如果参考号为空，则此字段返回值为操作单号
inventory_operation_type	int	Required	操作类型	1:调出下架，2:调入上架，3:盘点，4:订单签出，5:库存调整，6:售后上架，7:入库上架，8：增值完成
product_barcode	string	Required	商品编码	带客户代码的商品编码
product_sku	string	Required	SKU编码	不带客户编码的商品编码
warehouse_code	string	Required	仓库代码	仓库代码
warehouse_name	string	Required	仓库名称	仓库名称
inventory_change_type	int	Required	变动类型	变动类型（1:新增，2:减少）
adjustment_qty	int	Required	变动量	变动数量
remark	string	Optional	备注	操作的备注信息
transaction_time	string	Required	操作时间	操作的发生时间

Message json格式

响应数据

成功格式: {"Status":"SUCCESS","ErrorMessage":""}

错误格式: {"Status":"FAILED","ErrorMessage":"同步失败"}