OMS接口文档

OMS接口文档


原单导入

<p><strong>简要描述:</strong> </p> <ul> <li>原单表体 (一张原单由一个表头和一个或多个表体组成) 为保证兼容原有逻辑,传入的参数的类型都传String型</li> </ul> <p><strong>请求URL:</strong> </p> <ul> <li><code>https://omsapi.yonyoucloud.com/dst-web/api/billoperation/apiaction?access_token=</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST </li> </ul> <p><strong>参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">billnum</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>单据编码 =ec_tradevouch</td> </tr> <tr> <td style="text-align: left;">action</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>操作类型 =tradeimport</td> </tr> <tr> <td style="text-align: left;">externalData</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>导入数据是json格式,详细格式请参照请求示例,其中OrderInfo节点表示表体信息,表体信息可以是多条</td> </tr> <tr> <td style="text-align: left;">item</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>新版返回格式,data返回成功失败list ,如需新版返回格式,请传入NewMessage</td> </tr> </tbody> </table> <p><strong>导入数据详情(externalData详细信息):</strong> <strong>表头</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">说明</th> <th style="text-align: left;">类型</th> <th>必选</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">advance_paytime</td> <td style="text-align: left;">预付定金时间</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">plat</td> <td style="text-align: left;">平台</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">store_id</td> <td style="text-align: left;">门店id(友零售调用必输)</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">storeorder_id</td> <td style="text-align: left;">门店订单id(友零售调用必输)</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">shopcode</td> <td style="text-align: left;">店铺编码</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">tid</td> <td style="text-align: left;">交易编号</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">buyer_nick</td> <td style="text-align: left;">买家昵称</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">receiver_name</td> <td style="text-align: left;">收货人姓名</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">receiver_mobile</td> <td style="text-align: left;">收货手机号</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">receiver_phone</td> <td style="text-align: left;">收货电话</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">receiver_country</td> <td style="text-align: left;">国籍</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">receiver_state</td> <td style="text-align: left;">收货人所在省</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">receiver_city</td> <td style="text-align: left;">收货人所在城市</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">receiver_district</td> <td style="text-align: left;">收货人所在地区</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">receiver_town</td> <td style="text-align: left;">收货人所在乡镇/街道</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">receiver_address</td> <td style="text-align: left;">收货详细地址</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">receiver_zip</td> <td style="text-align: left;">邮编</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">created</td> <td style="text-align: left;">下单时间</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">pay_time</td> <td style="text-align: left;">付款的时间(交易类型为在线支付非空,交易类型为货到付款可空)</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">consign_time</td> <td style="text-align: left;">卖家发货时间</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">order_status</td> <td style="text-align: left;">线上交易状态 (可选 waiting_buyer_to_pay (待付款) buyers_have_paid (待发货) sellers_have_been_shipped (已发货) sellers_have_been_shipped (部分发货) trade_closed (交易关闭)trade_refunding (退款中) trade_finished (交易完成)</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">线上交易状态 待付款 待发货 已发货 交易完成</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">type</td> <td style="text-align: left;">交易类型(&quot;在线支付&quot;,&quot;货到付款&quot;,&quot;门店支付&quot;)</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">buyer_message</td> <td style="text-align: left;">买家留言</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">seller_memo</td> <td style="text-align: left;">卖家备注</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">shipping_type</td> <td style="text-align: left;">物流方式(&quot;物流发货&quot;,&quot;自提&quot;)</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">post_fee</td> <td style="text-align: left;">运费</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">coupon_point</td> <td style="text-align: left;">积分抵扣额</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">coupon_ticket</td> <td style="text-align: left;">优惠券抵扣额</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">coupon_card</td> <td style="text-align: left;">礼品卡抵扣额</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">post_fee</td> <td style="text-align: left;">运费</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">invoice_kind</td> <td style="text-align: left;">发票类型(发票抬头非空,则发票类型非空 可选1-”纸质普票”、2-”纸质专票”、3-”电子普票”、4-”电子专票”)</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">invoice_name</td> <td style="text-align: left;">发票抬头</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">receiveInvoiceMail</td> <td style="text-align: left;">接收发票邮箱</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">taxpayer_ident</td> <td style="text-align: left;">购买方税号</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">registered_address</td> <td style="text-align: left;">购方注册地址</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">registered_phone</td> <td style="text-align: left;">购方注册电话</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">deposit_bank</td> <td style="text-align: left;">购方开户银行</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">bank_account</td> <td style="text-align: left;">购方银行账户</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">applier_nick</td> <td style="text-align: left;">分销商昵称</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">isPromotion</td> <td style="text-align: left;">是否参与促销 (是-否)</td> <td style="text-align: left;">String</td> <td>否</td> </tr> </tbody> </table> <p>|tradeVouchCustomItem_define1~30|表头自定义项|String|否 <strong>表体</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">说明</th> <th style="text-align: left;">类型</th> <th>必选</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">shopcode</td> <td style="text-align: left;">店铺</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">tid</td> <td style="text-align: left;">交易编号</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">oid</td> <td style="text-align: left;">子订单id</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">num_iid</td> <td style="text-align: left;">线上商品编码(线上商品编码和商品SKU编码不可同时为空)</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">sku_id</td> <td style="text-align: left;">线上商品SKU</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">ebskuid</td> <td style="text-align: left;">商品SKUID</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">itemcode</td> <td style="text-align: left;">商品SKU编码(线上商品编码和商品SKU编码不可同时为空)</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">warehouseCode</td> <td style="text-align: left;">仓库编码(需要oms匹配仓库的可以不传)</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">warehouseErpCode</td> <td style="text-align: left;">仓库ERP编码(原则同上,可不传,若需传入,与仓库编码传其一即可)</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">num</td> <td style="text-align: left;">购买数量(整数 &gt;0)</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">price</td> <td style="text-align: left;">商品价格</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">total_fee</td> <td style="text-align: left;">商品金额</td> <td style="text-align: left;">String</td> <td>是</td> </tr> <tr> <td style="text-align: left;">discount_fee</td> <td style="text-align: left;">优惠金额</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">adjust_fee</td> <td style="text-align: left;">手工调整金额</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">payment</td> <td style="text-align: left;">实收金额</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">sub_order_tax_fee</td> <td style="text-align: left;">关税</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">tradeVouchDetailCustomItem_define1~30</td> <td style="text-align: left;">表头自定义项</td> <td style="text-align: left;">String</td> <td>否</td> </tr> </tbody> </table> <p><strong>促销信息表体</strong></p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">说明</th> <th style="text-align: left;">类型</th> <th>必选</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">promotion_details_id</td> <td style="text-align: left;">交易的主订单或子订单号</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">promotion_name</td> <td style="text-align: left;">优惠信息的名称</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">discount_fee</td> <td style="text-align: left;">优惠金额</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">gift_item_name</td> <td style="text-align: left;">满就送商品时所送商品的名称</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">gift_item_id</td> <td style="text-align: left;">赠品的宝贝id</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">gift_item_num</td> <td style="text-align: left;">满就送礼物的礼物数量</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">promotion_desc</td> <td style="text-align: left;">优惠活动的描述</td> <td style="text-align: left;">String</td> <td>否</td> </tr> <tr> <td style="text-align: left;">promotion_id</td> <td style="text-align: left;">优惠id</td> <td style="text-align: left;">String</td> <td>否</td> </tr> </tbody> </table> <p><strong>请求示例</strong> 旧版返回格式的请求报文</p> <pre><code> { "action": "tradeimport", "externalData": "[{\"buyer_message\":\"留言\",\"receiver_city\":\"金华市\",\"created\":\"2020-04-10 11:11:33\",\"receiver_district\":\"义乌市\",\"OrderInfo\":[{\"shopcode\":\"002\",\"price\":\"199\",\"num\":\"1\",\"total_fee\":\"199\",\"num_iid\":\"2053500000112484\",\"sku_id\":\"2053500000112484\",\"payment\":\"199\",\"tid\":\"JY202004103000937001713464004\",\"discount_fee\":\"0\"}],\"type\":\"在线支付\",\"receiver_mobile\":\"17774250881\",\"tid\":\"JY202004103000937001713464004\",\"pay_time\":\"2020-04-10 11:11:54\",\"receiver_state\":\"浙江省\",\"buyer_nick\":\"200227937\",\"shopcode\":\"店铺编码\",\"receiver_zip\":\"\",\"receiver_name\":\"龚XX\",\"receiver_address\":\"人民法院\",\"status\":\"buyers_have_paid\"}]", "partParam": { "orgCode": "组织编码" }, "billnum": "ec_tradevouch" }</code></pre> <p>新版返回格式的请求报文</p> <pre><code> {     "action": "tradeimport",     "externalData": "[{\"buyer_message\":\"留言\",\"receiver_city\":\"金华市\",\"created\":\"2020-04-10 11:11:33\",\"receiver_district\":\"义乌市\",\"OrderInfo\":[{\"shopcode\":\"002\",\"price\":\"199\",\"num\":\"1\",\"total_fee\":\"199\",\"num_iid\":\"2053500000112484\",\"sku_id\":\"2053500000112484\",\"payment\":\"199\",\"tid\":\"JY202004103000937001713464004\",\"discount_fee\":\"0\"}],\"type\":\"在线支付\",\"receiver_mobile\":\"17774250881\",\"tid\":\"JY202004103000937001713464004\",\"pay_time\":\"2020-04-10 11:11:54\",\"receiver_state\":\"浙江省\",\"buyer_nick\":\"200227937\",\"shopcode\":\"店铺编码\",\"receiver_zip\":\"\",\"receiver_name\":\"龚XX\",\"receiver_address\":\"人民法院\",\"status\":\"buyers_have_paid\"}]",     "partParam": {         "orgCode": "组织编码"     },     "item":"NewMessage",     "billnum": "ec_tradevouch" } </code></pre> <p><strong>返回示例</strong></p> <p>旧版返回格式的返回示例</p> <pre><code>{"code":200,"message":"导入原单成功 \r\n 导入失败0单 \r\n","data":"{\"1692286593290496\":\"JY202004103000937001713464004\"}"}</code></pre> <p>新版返回格式的返回示例</p> <pre><code>{     "code": 200,     "message": "导入原单成功 \r\n 导入失败1单 \r\n店铺编码不存在或没有做门店对照:\r\n[关键字=店铺编码(门店id):店铺编码,交易编号(零售单号):JY202004103000937001713464004] \r\n",     "data": "{\"successList\":{\"JY202004103000937001713464888\":\"12345678(成功保存的原单id))\"},\"failedList\":{\"JY202004103000937001713464004\":\"店铺编码不存在或没有做门店对照\"}}" }</code></pre> <p><strong>返回参数说明</strong> data: 1391017505034496为oms系统中生成的原单id,JY202004103000937001713464004为传入单据的tid</p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">string</td> <td>200:成功;其他:失败</td> </tr> <tr> <td style="text-align: left;">message</td> <td style="text-align: left;">string</td> <td>错误消息</td> </tr> </tbody> </table> <p><strong>备注</strong> </p> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML