eb_trade/add
目录 |
1.接口说明
1.1接口描述
新增一张电商订单
1.2适用版本
支持U8V12.0 及更高版本
2.使用场景
电商集成
3.接口调用说明
3.1请求说明
| url | https://api.yonyouup.com/api/eb_trade/add |
| 格式 | JSON |
| https请求方式 | POST |
| 编码类型 | UTF-8 |
3.2url参数说明
| 参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| from_account | string | 是 | 调用方id |
| to_account | string | 是 | 提供方id |
| app_key | string | 是 | 应用编码 |
| token | string | 是 | api调用唯一识别码 |
| tradeid | string | 是 | 交易唯一识别码,tradeid与biz_id只能传入一个 |
| ds_sequence | number | 否 | 数据源序号(默认取应用的第一个数据源) |
| biz_id | string | 是 | 上游id,需要保证biz_id与ERP主键唯一对应关系,tradeid与biz_id只能传入一个 |
| sync | number | 否 | 0=异步新增(默认);1=同步新增; |
3.3请求体参数说明
| 参数 | 类型 | 参数路径 | 是否必填 | 描述 |
|---|---|---|---|---|
| cShopCode | string | 是 | 店铺编码 | |
| tid | string | 是 | 交易编号 | |
| title | string | 是 | 交易标题 | |
| buyer_nick | string | 是 | 买家会员号 | |
| receiver_name | string | 否 | 收货人的姓名 | |
| receiver_state | string | 否 | 收货人的所在省份 | |
| receiver_city | string | 否 | 收货人的所在城市 | |
| receiver_district | string | 否 | 收货人的所在地区 | |
| receiver_address | string | 否 | 收货人的详细地址 | |
| receiver_zip | string | 否 | 收货的人邮编 | |
| receiver_mobile | string | 否 | 收货人的手机号码 | |
| isInvoice | number | 否 | 是否开票(0=不开票;1=开票) | |
| receiver_phone | string | 否 | 收货人的电话号码 | |
| buyer_email | string | 否 | 买家邮件地址 | |
| seller_memo | string | 否 | 卖家备注 | |
| created | date | 是 | 交易时间 | |
| pay_time | date | 否 | 付款时间 | |
| promotion | string | 否 | 交易促销信息 | |
| buyer_message | string | 否 | 买家留言 | |
| trade_memo | string | 否 | 交易备注 | |
| invoice_name | string | 否 | 发票抬头 | |
| cInvoiceCode | string | 否 | 发票号 | |
| cExpressCoCode | string | 否 | 快递公司编码 | |
| cExpressCoName | string | 否 | 快递公司名称 | |
| cExpressCode | string | 否 | 快递单号 | |
| cDepCode | string | 否 | 部门编码 | |
| cDepName | string | 否 | 部门 | |
| cPersonName | string | 否 | 业务员 | |
| cSTName | string | 否 | 销售类型 | |
| cSSName | string | 否 | 结算方式 | |
| cShipMode | string | 否 | 发货模式 | |
| define1 | string | 否 | 表头自定义项1 | |
| define2 | string | 否 | 表头自定义项2 | |
| define3 | string | 否 | 表头自定义项3 | |
| define4 | date | 否 | 表头自定义项4 | |
| define5 | number | 否 | 表头自定义项5 | |
| define6 | date | 否 | 表头自定义项6 | |
| define7 | number | 否 | 表头自定义项7 | |
| define8 | string | 否 | 表头自定义项8 | |
| define9 | string | 否 | 表头自定义项9 | |
| define10 | string | 否 | 表头自定义项10 | |
| define11 | string | 否 | 表头自定义项11 | |
| define12 | string | 否 | 表头自定义项12 | |
| define13 | string | 否 | 表头自定义项13 | |
| define14 | string | 否 | 表头自定义项14 | |
| define15 | number | 否 | 表头自定义项15 | |
| define16 | number | 否 | 表头自定义项16 | |
| title | string | entry | 是 | 商品标题 |
| num_iid | string | entry | 是 | 商品数字ID |
| outer_iid | string | entry | 是 | 商家外部编码 |
| sku_id | string | entry | 否 | 商品Sku的id |
| outer_sku_id | string | entry | 否 | 外部网店自己定义的Sku编号 |
| sku_properties_name | string | entry | 否 | SKU值 |
| cItemCode | string | entry | 是 | 商品编码 |
| cItemName | string | entry | 是 | 商品名称 |
| price | number | entry | 是 | 商品价格 |
| num | number | entry | 是 | 购买数量 |
| discount_fee | number | entry | 否 | 订单优惠金额 |
| adjust_fee | number | entry | 否 | 手工调整金额 |
| post_fee | number | entry | 否 | 运费 |
| cWhCode | string | entry | 否 | 发货仓库 |
| isDiscount | number | entry | 否 | 是否折扣(0=非折扣;1=折扣) |
| isPostFee | number | entry | 否 | 是否运费(0=非运费;1=运费) |
| cDefine22 | string | entry | 否 | 表体自定义项1 |
| cDefine23 | string | entry | 否 | 表体自定义项2 |
| cDefine24 | string | entry | 否 | 表体自定义项3 |
| cDefine25 | string | entry | 否 | 表体自定义项4 |
| cDefine26 | number | entry | 否 | 表体自定义项5 |
| cDefine27 | number | entry | 否 | 表体自定义项6 |
| cDefine28 | string | entry | 否 | 表体自定义项7 |
| cDefine29 | string | entry | 否 | 表体自定义项8 |
| cDefine30 | string | entry | 否 | 表体自定义项9 |
| cDefine31 | string | entry | 否 | 表体自定义项10 |
| cDefine32 | string | entry | 否 | 表体自定义项11 |
| cDefine33 | string | entry | 否 | 表体自定义项12 |
| cDefine34 | number | entry | 否 | 表体自定义项13 |
| cDefine35 | number | entry | 否 | 表体自定义项14 |
| cDefine36 | date | entry | 否 | 表体自定义项15 |
| cDefine37 | date | entry | 否 | 表体自定义项16 |
| isGift | number | entry | 否 | 是否赠品(0=非赠品;1=赠品) |
3.4请求示例
POST https://api.yonyouup.com/api/eb_trade/add?from_account=openapi_dev&to_account=openapi_ent&app_key=opa6fdd4bea98b95ad7&token=843d03f66e6544e19707ccec11030296&biz_id=0971&ds_sequence=1
POST 内容:
{
"eb_trade":{
"cShopCode":"01",
"tid":"984470431496938",
"buyer_nick":"加菲猫m",
"receiver_name":"陈洁",
"receiver_state":"浙江省",
"receiver_city":"杭州市",
"receiver_district":"拱墅区",
"receiver_address":"北清路68号用友软件园",
"receiver_zip":"310011",
"receiver_mobile":"*35057*6665",
"isInvoice":"1",
"buyer_email":"13505716665@139.com",
"created":"2014-12-0400:00:00",
"pay_time":"2014-12-0500:00:00",
"invoice_name":"陈洁",
"cDepCode":"0304",
"cPersonName":"何彤",
"cSTName":"电子商务",
"cSSName":"银行转账",
"cShipMode":"EnterpriseDeliver",
"entry":{
"num_iid":"39890984132",
"sku_id":"72971108530",
"outer_sku_id":"11010612",
"sku_properties_name":"颜色分类:黄色",
"cItemCode":"000000U1010001",
"cItemName":"一体化机",
"price":"799",
"num":"1",
"discount_fee":"405",
"cWhCode":"50"
}
}
}
3.5返回参数说明
| 参数说明 | 类型 | 描述 |
|---|---|---|
| errcode | string | 错误码,0 为正常。 |
| errmsg | string | 错误信息。 |
| id | string | 新增成功后返回店铺编码及订单号。 |
| tradeid | string | 新增成功后返回交易唯一识别码 |
3.6正确返回示例
JSON示例:
{
"tradeid": "158f3f05730711e591c702004c4f4f50",
"ping_after": "3",
"url": "https://api.yonyouup.com/result?requestid=158f3f05730711e591c702004c4f4f50"
}
上述 api 请求返回信息表示建议客户端 3 秒钟后向 https://api.yonyouup.com/result?requestid=158f3f05730711e591c702004c4f4f50 发送 GET 请求获取真正的 api 调用结果,结果格式如下:
{
"errcode" : "0",
"errmsg" : "",
"id" : "883",
"tradeid" : "158f3f05730711e591c702004c4f4f50"
}
3.7错误返回示例
application/json;charset=UTF-8
{
"errcode" : "30021",
"errmsg" : "此应用未上线"
}