文档中心 > 开放业务&解决方案

同城零售标准方案篇

更新时间:2021/10/25 访问次数:3319

标准接入方案

场景,商家有自己的erp系统,通过系统把商品、库存数据传到同城后台,方便快捷

 

需要对接的接口

类目 商品,库存需要接口对接

采购价(接口和同城后台二选一) 营销活动(接口和同城后台二选一)

 

商品对接

商家通过ERP对接共享库存提供商品发品接口把商品信息发布到同城零售商家后台,商家补充共享库存所需必备属性后,发布商品到天猫超市商品后台,天猫超市商品运营小二审核后把商品发布到天猫超市。

库存对接

商家通过ERP对接共享库存提供库存发布接口把库存信息实时同步到天猫超市,注意,库存信息一定要准确,否则很容易造成超卖。

采购价报价

商家通过ERP对接共享库存提供的采购价报价接口把采购价实时同步到天猫超市,采购价为商家向天猫超市提报的结算报价。同个商品多条采购价已最新时间的采购价结算。

营销活动对接

商家通过ERP对接共享库存提供的营销活动同步接口把营销活动实时同步到天猫超市,天猫超市运营可参考该营销活动进行营销玩法设置。

正逆向单据对接

商家使用同城零售提供的拣打系统(轻仓),需要感知订单打包出库与订单退仓入库,商家可接受共享库存提供的正逆向单据消息,获取订单打包出库与订单退仓入库消息,实时处理自己ERP内部库存数据并通过共享库存库存接口同步到天猫超市。

注意:正逆向单据中存在商品的数量信息,正向订单存在商品售价。

 

 

标准方案接入文档 

 

接口会有限流,如果出现的话需要进行重试。

{"code":7,"msg":"App Call Limited","sub_code":"accesscontrol.limited-by-api-access-count","sub_msg":"This ban will last for 1 more seconds","request_id":"5fnn7so2yhut"}
建议:可以识别这个参数进行重试 :sub_code 或者 sub_msg 的内容

 接口文档

1.1 API总览

商家类目

商家类目新增

alibaba.wdk.sku.category.add

TOP

商家类目修改

alibaba.wdk.sku.category.update

TOP

商家类目删除

alibaba.wdk.sku.category.delete

TOP

商家类目查询

alibaba.wdk.sku.category.query

TOP

商品

商品图片上传

alibaba.wdk.picture.upload

TOP

新增商品

alibaba.wdk.sku.add

TOP

更新商品

alibaba.wdk.sku.update

TOP

查询商品

alibaba.wdk.sku.query

TOP

采购

创建或更新采购价

alibaba.newretail.purchase.price.save

TOP

销售库存

库存同步

alibaba.wdk.stock.publish

TOP

交易订单

猫超订单数据变更消息通知

alibaba_wdkorder_OrderStatusPush

TMC

猫超商户订单拉取详情

alibaba.wdkorder.sharestock.order.get

TOP

订单履约状态变更消息

alibaba_wdkorder_OrderFulfillPush

TMC

商户订单履约数据获取

alibaba.wdkorder.sharestock.fulfill.get

TOP

营销活动

创建特价活动

alibaba.retail.marketing.itemdiscount.activity.create

TOP

更新特价活动

alibaba.retail.marketing.itemdiscount.activity.update

TOP

删除特价活动

alibaba.retail.marketing.itemdiscount.activity.delete

TOP

特价活动添加/更新商品

alibaba.retail.marketing.itemdiscount.activity.sku.add

TOP

将参加活动的商品从特价活动中删除

alibaba.retail.marketing.itemdiscount.activity.sku.delete

TOP


 

1.2 商家类目接口

商家类目新增 alibaba.wdk.sku.category.add

商家类目修改 alibaba.wdk.sku.category.update

商家类目删除 alibaba.wdk.sku.category.delete

商家类目查询 alibaba.wdk.sku.category.query

查询和删除接口无特殊参数,不再重复描述

API入参


字段名称

类型

是否必填

示例

字段说明

param

CategoryDo

必须

 

类目新增请求模型

└ code

String

必须

02082123

类目编码(商品类目编码)

└ name

String

必须

水果

类目名称

└ parent_code

String

可选 

1001

父类目编码(第一级类目此参数不需要传,二级类目后此参数必传)最多四级类目

└ leaf

Boolean

必须

false

是否是叶子节点(叶子类目则不允许再添加子类目,非叶子类目不允许添加商品,

默认传false)实例:true/false

└ desc

String

可选

测试类目

描述

└ sort_order

Number

可选

100

类目排序值

 status

Number

可选

0

状态(0:正常;1:禁用,禁用后已有的商品不影响,不能新建新商品)update接口使用

查询和删除接口无特殊参数,不再重复描述

API出参

名称

参数类型/SDK类型

是否必须

示例值

描述

result

ApiResult

必须

请参见子字段

调用结果

└ success

Boolean

必须

true

接口返回成功标志实例:成功:true 失败:false

└ err_code

String

必须

ILLEGAL_PAR

AMETERS

错误码(只有有异常才有值) 建议商家记录日志:提供错误信息阿里侧查询

└ err_msg

String

必须

code不能为空

错误信息(只有有异常才有值) 建议商家记录日志:提供错误信息阿里侧查询

└ model

String

必须

02082123

调用成功时的返回类目code


商品图片上传     alibaba.wdk.picture.upload
1.3商品图片参数 

图片需要转成二进制流

接口中返回的图片URL地址,在商品资料接口上传入。

API入参

字段名称

参数类型/SDK类型

是否必须

示例值

描述

picture_category_id

Number

必须

11

图片分类ID,设置具体某个分类ID或设置0上传到默认分类,只能传入一个分类

img

byte[]

必须

图片内容

图片二进制文件流,不能为空,允许png、jpg、gif图片格式,3M以内

img_input_title

String

必须

Bule.jpg

包括后缀名的图片标题,不能为空,如Bule.jpg,有些卖家希望图片上传后取图片文件的默认名

title

String

可选

图片名称

图片标题,如果为空,传的图片标题就取去掉后缀名的image_input_title,超过50字符长度会截取50字符,重名会在标题末尾加"(1)";标题末尾已经有"(数字)"了,则数字加1

API出参

字段名称

参数类型/SDK类型

是否必须

示例值

描述

result

ApiResult

必须

 

apiresult

└ success

Boolean

必须

false

成功:true  失败: false

└ model

PictureDo

必须

 

model

   └ picture_id

Number

必须

1833207071248664000

图片ID

   └ picture_category_id

Number

必须

0

图片分类ID

   └ picture_path

String

必须

i3/2680068332/O1CN01VEwIc

Y2BQ6gW9kbd4_!!2680068332.jpg

返回的是相对路径

   └ title

String

可选

123

图片标题

   └ sizes

Number

必须

31817

图片大小,bite单位

   └ status

String

必须

0

图片状态,0代表没有被冻结,1代表被冻结,2代表排查通过

   └ deleted

String

必须

0

图片的删除标志为: 0代表没有删除 , 1代表删除, 2代表免费用户使用

   └ created

String

必须

2021-03-11 18:23:47

图片的创建时间

   └ modified

String

必须

2021-03-11 18:23:47

图片的修改时间

   └ pixel

String

必须

1024x768

图片相素,格式:长x宽,如1024x768

   └ full_url

String

必须

https://img.alicdn.com/imgextra/i3/

2680068332/O1CN01VEwIcY2BQ6gW9kbd4_

!!2680068332.jpg

完整的路径

└ err_code

String

必须

isv.upload-error

错误code (异常情况返回)建议商家记录日志:提供错误信息阿里侧查询

└ err_msg

String

必须

上传图片错误

错误原因 (异常情况返回) 建议商家记录日志:提供错误信息阿里侧查询

 

 

1.4门店商品接口

商家通过ERP对接共享零售提供商品发品接口把商品信息发布到同城零售商家后台,商家补充共享库存所需必备属性后,发布商品到天猫超市商品后台,天猫超市商品运营小二审核后把商品发布到天猫超市

商品接口和类目是搭配使用的,接商品必须接类目

新增商品   alibaba.wdk.sku.add 

更新商品   alibaba.wdk.sku.update

查询商品   alibaba.wdk.sku.query

字段名称 参数类型/SDK类型 是否必须 示例值 描述
param_list SkuDo[] 必须 商品列表(最大列表长度:20):20个商品明细
└ barcodes String 必须 693132017440 条码,支持一品多码,多个条码以半角逗号分隔;商品最小规格条码
└ brand_name String 必须 帝皇鲜 品牌名称;支持商家ERP自定义
└ height String 可选 3 高度(高)单位:厘米;
└ length String 可选 10 长度(深);
└ width String 可选 3 宽度(宽);
└ tax_rate String 必须 0.13 销项税率;跟财务场景相关按照国家标准税率:0.13;0.09;0.06
└ inventory_unit String 必须 库存单位; 商品单位库介绍:https://hema.open.taobao.com/doc?docId=108436&docType=1
└ producer_place String 必须 中国|辽宁省|大连市 产地,商品生产地点的描述,用于APP和电子价签展示,如果是可售,则必填;商品地址库:https://hema.open.taobao.com/doc?docId=108437&docType=1 按照实例格式传,如果没有维护可默认传:见产品外包装
└ sku_code String 必须 1.901E+11 商品唯一编码(仅支持数字形式,不支持字母或特殊字符)商品编码sku
└ sku_name String 必须 小龙虾 30-40g/只 称重 商品名称,对商品直观的描述,通常包含了品牌、规格等信息
└ weight String 必须 30 单个商品重量 单位为克/g,必须为整数
└ ou_code String 必须 TCCSMD 仓编码(仓编码和门店编码值相同)商家在阿里侧店仓编码TCCSMD
└ import_flag Number 必须 0 是否进口,是否进口;原产地非中国,都填是 1:是  0:否(默认为0)
└ sale_unit String 必须 销售单位;商品销售时的单位;标品建议与库存单位保持一致。
└ storage String 必须 常温 存储条件;填常温、冷藏、热链、鲜活
└ sku_price String 必须 9.9 门店商品售价(同字段sale_price),单位:元;优先使用本字段
└ period Number 必须 450 商品的保质期天数必须为整数,不能为空,不能传0
└   merchant_cat_code String 必须 10086 商家后台类目编码,优先使用本字段。(创建商家类目接口的类目编码 code )
└  sku_pic_urls String 必须 https://img.alicdn.com/imgextra/i3/ 在app上显示的商品图片cdn地址(同字段main_pic_urls和detail_pic_urls),https开头,多个图片用英文逗号切割。第一张图片会作为主图;优先使用本字段
└ rich_text String 必须 <p><img align=\"absmiddle\" src=\"https://img.alicdn.com 文描
└ delivery_storage String 必传 常温 配送条件;填常温、冷藏; 这个指拣货之后到消费者手中需要的配送条件
└ product_identity String 必须 123 产品聚合码,程序会把聚合码相同的sku聚合到一起;比如衣服有大中小号3中sku,通过聚合码聚合到一起;该字段在同城零售发布场景才能使用;20字符以内
└ biz_type String 必须 shareStore 业务类型:txd淘鲜达,elm饿了么,shareStore共享库存,同城零售商家统一值shareStore

 channel_props

ChannelProp[] 必须 以下为本次新增参数 渠道属性,
  └channel_type String 必须 shareStore 渠道类型:txd淘鲜达,shareStore共享库存,同城零售商家统一值shareStore
   └props PropField[] 必须 渠道对应的属性,为key-value键值对形式,
     └value String 必须 1 可售状态:1代表可售 0 代表不可售
     └key String 必须 ONE_HOUR_STATUS 渠道属性key, 取值为"ONE_HOUR_STATUS" 小时达 ;"WAVE_ARRIVE_STATUS" 波次达 ;

 

 

 


API出参(add和update)

 

名称

参数类型/SDK类型

是否必须

示例值

描述

result

ApiResults

必须

请参见子字段信息

调用结果

└ err_code

String

必须

ILLEGAL_PARAMETERS

错误码  建议商家记录日志:提供错误信息阿里侧查询

└ err_msg

String

必须

请参见子字段信息

错误信息 建议商家记录日志:提供错误信息阿里侧查询

└ success

Boolean

必须

true

接口返回成功标志 成功:true 失败:false

└ models

ApiResult[]

必须

请参见子字段信息

models

   └ err_code

String

必须

ILLEGAL_PARAMETERS

错误编码  建议商家记录日志:提供错误信息阿里侧查询

   └ err_msg

String

必须

门店商品已存在

错误信息 建议商家记录日志:提供错误信息阿里侧查询

   └ success

Boolean

必须

true

单个商品新增是否成功  成功:true 失败:false

   └ model

String

必须

190100200014

skuCode商品编码

 

 

 

 

 

1.5库存接口

商通过ERP对接共享库存提供库存发布接口把库存信息实时同步到天猫超市。注意:库存信息要准确,否则很容易造成超卖风险。

销售库存发布:alibaba.wdk.stock.publish  

注:billNo 、 orderNo  两个流水参数 支持字母和数字,不支持特殊字条,长度:至少18位以上50位以内,全局必须唯一

单次请求list明细是20条商品


billNo建议:门店编码+时间戳+随机数

orderNo建议:门店编码+时间戳+随机数+商品编码

 

API入参

名称

参数类型/SDK类型

是否必须

示例值

描述

batch_stock_publish_dto

BatchStockPublishDto

可选

批量参数

└ update_type

Number

必须

1

更新类型,全量1,增量2

(全量:覆盖模式;

增量:阿里侧加减库存)

└ bill_no

String

必须

TCCSMD20210311171253

(控制幂等),理解为一次请求提交 建议:门店编码+时间戳+随机数

└ bill_type

Number

必须

9064

外部单据类型,开放技术支持统一分配(固定值)-待阿里侧提供

└ publish_source

String

必须

TCCSSJ

商家编码(TCCSSJ)

└ warehouse_code

String

必须

TCCSMD

仓编码(必须传对值,否则猫超识别不到库存(商家在阿里侧店仓编码TCCSMD)

└ shop_code

String

必须

TCCSMD

门店店编码(商家在阿里侧店仓编码TCCSMD)

└ channel_source_id

String

必须

308097002

渠道店编号

(阿里侧提供配置表)

└ operator

String

必须

system

操作者

└ channel_source_type

Number

必须

4

渠道店类型;可使用默认值4

└ stock_publish_dtos

StockPublishDto[]

必须

子参数列表(20条商品明细)

   └ sku_code

String

必须

266523627

商品编码sku

   └ quantity

String

必须

6

更新数量,矢量(支持正负值)

   └ order_no

String

必须

TCCSMD021031117

12266523627

(保证商品库存同步幂等性的唯一性的字符串)

建议:门店编码+时间戳+随机数+商品编码 保证唯一:

在阿里侧店仓编码TCCSMD

   └ order_type

String

必须

900300001

订单类型,参见订单类型约束https://hema.open.taobao.com/doc?docId=109119&docType=1

 

   └ order_desc

String

可选

库调

传默认值:库调,可传标识

└ un_batched_order_stock_subtracted

Boolean

可选

false

 

是否已扣除未批次数,用于全量发布  实例值:true /false

传默认值:false

API出参

       

名称

参数类型/SDK类型

是否必须

示例值

描述

is_success

Boolean

必须

FALSE

success

msg_code

String

可选

"isv.invalid-parameter"

错误时返回,建议记录错误信息反馈阿里侧查询

message

String

可选

"参数错误"

错误时返回,建议记录错误信息反馈阿里侧查询


创建或更新采购价 alibaba.newretail.purchase.price.save( 共享零售 采购价上传接口 )
1.6采购价接口

商家通过ERP对接共享库存提供的采购价报价接口把采购价实时同步到天猫超市。

采购价为商家向天猫超市提报的结算报价,同个商品多条采购价已最新时间的采购价结算。。

 

接口参数介绍(PS:接口其它可选参数不传)

名称

参数类型/SDK

类型

是否必须

示例值

描述

save_purchase_price_request

SavePurchasePriceRequest

必须

 

接口入参

└ marketing_type

Number

必须

6

2-经销,3-代销,6-寄售,默认为【6-寄售】共享零售传 6

└ ou_code

String

必须

TCCSMD

仓编码 侧店仓编码TCCSMD

└ sku_code

String

必须

26653627

商品编码sku

└ purchase_price_with_tax

Number

必须

2200

含税采购价格,单位【分】

└ price_type

Number

必须

3

1-基准价格,3-区间价格

当价格为基准价格时 传 :1。当为区间价格时传 :3  ,区间生效时间必传

└ effective_start_time

Number

可选

1613987769907

区间价格生效时间(时间戳参数),当采购价是区间采购价时必传

└ effective_end_time

Number

可选

1613988769907

区间价格生效时间(时间戳参数),当采购价是区间采购价时必传

└ out_id

String

必须

TCCSMD02M20210311172603

幂等ID:门店编码+时间戳 

 

 

名称

参数类型/SDK类型

是否必须

示例值

描述

result

TopBaseResult

 

 

调用结果对象

└ success

Boolean

必须

true

表示调用是否成功 成功:true 失败:false

└ return_code

String

必须

SUCCESS

返回码

└ return_msg

String

必须

成功

返回码说明


1.7正逆向单据回流 

消息服务订阅介绍:https://open.taobao.com/doc.htm?docId=101663&docType=1

猫超订单数据变更消息通知

alibaba_wdkorder_OrderStatusPush

猫超商户订单拉取详情

alibaba.wdkorder.sharestock.order.get

订单履约状态变更消息

alibaba_wdkorder_OrderFulfillPush

商户订单履约数据获取

alibaba.wdkorder.sharestock.fulfill.get

说明:此交易订单接口表达:商家门店商品售卖的数据明细。

      订单履约接口表达:订单在REX平台履约实际拣打出货数量、时间、退仓数量、时间关键信息。

       整体交易接口围绕订单和库存进出业务处理。

1.8正向交易

猫超订单数据变更消息通知正向单消息       alibaba_wdkorder_OrderStatusPush

消息体内容如下介绍

名称

类型

是否必须

描述

示例值

tb_order_id

Number

必须

主站主订单ID

9812418714110

order_status

String

可选

订单状态(只有已支付PAID一种状态)

PAID

merchant_code

String

必须

商户编码

1919CSSJ

 

猫超商户订单拉取正向子订单明细查询       alibaba.wdkorder.sharestock.order.get

 

API入参

名称

参数类型/SDK类型

是否必须

示例值

描述

tb_order_id

Number

必须

1485556812737126400

淘系主订单

API出参

名称

参数类型/SDK类型

是否必须

示例值

描述

result

MaochaoOrderQueryResult

必须

 

调用结果

└ return_code

String

必须

HM02008888888001

返回码

└ return_msg

String

必须

成功

返回码说明

└ success

Boolean

必须

true

是否调用成功 成功:true 失败:false

└ sub_order_list

MaochaoWdkOrderDTO[]

必须

 

子订单列表

   └ order_status

String

必须

PAID_DONE

子订单状态:枚举值:

CREATED(1, "已创建"),

PAID_DONE(2, "已付款"),

ACCEPT_ORDER(3, "已接单"),

PICK_ORDER(4, "已拣货"),

SHIPPED(5, "已发货"),

TRADE_SUCCESS(6, "交易成功"),

TRADE_CLOSE(-1, "交易关闭"),

   └ buy_amount_stock

String

必须

1.0

库存单位购买数量

   └ store_id

String

必须

TCCS02M

门店编码商家在阿里侧门店编码 TCCS02M

   └ sale_unit

String

必须

销售单位

   └ stock_unit

String

必须

库存单位

   └ sell_unit

String

 

非标品售卖单位

   └ ns_quantity

String

 

非标品购买数量

   └ quantity

Number

必须

1

标品购买数量

   └ merchant_code

String

必须

TCHRWJ

商家编码

   └ tb_order_id

Number

必须

1485556812737126400

淘系主订单

   └ biz_order_id

Number

必须

5000393668468741000

五道口主订单ID

   └ auction_id

String

必须

10101020000043

商品ID

   └ auction_price

Number

必须

32900

商品价格,分

   └ auction_title

String

必须

拜耳拜宠爽

商品名称

   └ biz_sub_order_id

Number

必须

5000393668468741000

五道口子订单ID

   └ tb_sub_order_id

Number

必须

1485556812737126400

淘系子订单

   └ pay_time

String

必须

2021-01-03 15:02:09

订单支付时间

   └ shop_id

String

必须

407251173

渠道店ID

 attributes

Json

必须

{"purchase_price": "21400"}

采购价(单位/分)


1.9订单履约 

订单履约状态变更消息   alibaba_wdkorder_OrderFulfillPush

履约状态变更会触发消息推送,商家接收消息要控制履约单号防止重复入库

消息字段列表

名称

类型

是否必须

描述

示例值

fulfill_status

String

必须

履约状态

PACKAGED—打包完成

SHIPPING:揽收

ENTER_WAREHOUSE_SUCCESS:退仓完成

SHIPPED;TIMEOUT-SHIPPED;RESHIPPED 三种状态都代表配送妥投完成

merchant_code

String

必须

商家编号

1919CSSJ

fulfill_order_id

String

必须

履约单ID

152173192713234


猫超商户订单履约数据获取查询   alibaba.wdkorder.sharestock.fulfill.get 

说明:同城零售 商户订单数据回流 用户库存扣减等商户业务

API入参

名称

参数类型/SDK类型

是否必须

示例值

描述

fulfill_order_id

String

必须

152173192713234

履约主单号

API出参

名称

参数类型/SDK类型

是否必须

示例值

描述

result

MaochaoOrderFulfillQueryResult

必须

调用结果

└ success

Boolean

必须

是否调用成功

└ return_code

String

必须

HM02008888888001

返回码

└ return_msg

String

必须

成功

返回码说明

└ fulfill_order_list

MaochaoWdkOrderFulfillDTO[]

必须

 

子订单履约数据列表

   └ tb_order_id

Number

必须

1485556812737126400

淘系主订单

   └ biz_order_id

Number

必须

5000151241240

五道口主订单ID

   └ merchant_code

String

必须

1919CSSJ

商家编码

   └ store_id

String

必须

ERPCSMD

门店编码

   └ pick_amount_stock

String

必须

1

库存单位拣货数量

   └ attributes

Json

必须

{"signTime": "2020-04-25 00:00:00"}

履约单扩展属性

packageFinishTime:打包完时间

signTime:妥投时间

   └ fulfill_status

String

必须

PACKAGED

履约子单状态;

见表格下面枚举

   └ tb_sub_order_id

Number

必须

1485556812737126400

淘系子订单

   └ biz_sub_order_id

Number

必须

5000151241241

五道口子订单ID

   └ shop_id

String

必须

100124241811

渠道店ID

   └ enter_warehouse_stock_quantity

String

可选

1

库存单位实际退货数量(逆向退仓时才有)


ACCEPTED("已接单", "ACCEPTED"),履约子单明细中状态 fulfill_status 枚举值如下:

    OPERATOR_ACCEPTED("人工接单", "OPERATOR_ACCEPTED"),

    ACCEPTING("接单中", "ACCEPTING"),

    ROUTING("路由中", "ROUTING"),

    ROUTED("已路由", "ROUTED"),

    ROUTE_ERROR("路由失败", "ROUTE_ERROR"),

    WAIT_BATCH("待合批", "WAIT_BATCH"),

    BATCHING("合批中", "BATCHING"),

    BATCHED("已合批", "BATCHED"),

    BATCH_ERROR("合批失败", "BATCH_ERROR"),

    EXECUTING("已下发", "EXECUTING"),

    CANCELED("取消", "CANCELED"),

    REJECTED("拒单", "REJECTED"),

    OPERATOR_REJECTED("自动拒单", "OPERATOR_REJECTED"),

    AUTO_REJECTED("自动拒单", "AUTO_REJECTED"),

    PRESALE_STOCK_OUT("预售缺货出", "PRESALE_STOCK_OUT"),

    WAREHOUSE_SENT("仓已下发", "WAREHOUSE_SENT"),

    PICK_FINISH("拣货完成","PICK_FINISH"),

    PACKAGE_FINISH("打包完成","PACKAGE_FINISH"),

    DELIVERY_DOCK_SENT("配送已下发", "DELIVERY_DOCK_SENT"),

    SIGN_SUCCESS("配送已妥投", "SIGN_SUCCESS"),

    SIGN_ERROR("配送异常","SIGN_ERROR"),

    SIGN_REFUSE("配送拒收","SIGN_REFUSE"),

    SHIP("揽收","SHIP"),

SUCCESS("成功", "SUCCESS"),

    SUSPENDED("挂起", "SUSPENDED"),

    ERROR("失败", "ERROR"),

    CLOSED("关闭", "CLOSED");

 

1.9.1营销接口

商家通过ERP对接共享库存提供的营销活动同步接口把营销活动同步到天猫超市,天猫超市运营可参考该营销活动进行营销玩法设置

1.活动接口参数定义

创建活动:alibaba.retail.marketing.itemdiscount.activity.create                   

更新活动:alibaba.retail.marketing.itemdiscount.activity.update                  

删除活动:alibaba.retail.marketing.itemdiscount.activity.delete  

 

特价活动API入参介绍(create、update、delete

名称

参数类型/SDK类型

是否必须

示例值

描述

param

ItemDiscountActivityOperateRequest

必须

 

创建活动参数

└ activity_name

String

必须

测试特价活动

活动名称

└ creator_id

String

必须

HL123

活动创建者ID

└ creator_name

String

必须

小黄

活动创建者name

└ description

String

必须

特价活动很火热

活动描述

└ terminals

Number []

必须

1

活动终端:1-APP,2-POS;最大列表长度:999,默认传1

└ store_ids

String []

必须

TCCSMD02M

活动生效的门店;最大列表长度:100个。
在阿里侧店仓编码TCCSMD02M

└ out_act_id

String

可选

123

外部活动ID(商家自定义);最大长度:50

└ discount_type

Number

必须

1

特价类型,1-减钱,2-一口价,3-打折

└ start_time

Number

必须

1615197163489

活动开始时间(时间戳)

└ end_time

Number

必须

1617875563000

活动结束时间 (时间戳)

└ member_crowd_code

String []

可选

oldApp

活动人群编码;最大列表长度:999 ;暂不支持

└ act_id

Number

必须

123123

活动 ID(create 不

传,update 和

delete必传)

特价活动API出参介绍

名称

参数类型/SDK类型

是否必须

示例值

描述

result

OctopusOpenResult

必须

result

操作结果

└ data

Number

必须

1294955

活动ID(act_id)

└ error_code

String

必须

PARAM_ERROR

错误码 建议商家记录日志:提供错误信息阿里侧查询

└ success

Boolean

必须

true

操作是否成功 成功:true 失败:false

└ error_message

String

必须

参数错误

错误描述 建议商家记录日志:提供错误信息阿里侧查询

  

2.活动商品接口定义

添加和更新活动商品:alibaba.retail.marketing.itemdiscount.activity.sku.add                   

删除活动商品信息:alibaba.retail.marketing.itemdiscount.activity.sku.delete  

活动商品API入参介绍(add、delete

名称

参数类型/SDK类型

是否必须

示例值

描述

param

ItemDiscountActivityElementOperateRequest

必须

 

添加活动商品参数

└ sku_elements

SkuActivityElementDto[]

必须

 

商品元素信息;最大列表长度:50

   └ sku_code

String

必须

200912002

商品编码

   └ fix_price_money

Number

可选

100

一口价金额【分】标红参数 选其中一个值传入即可

   └ discount_rate

Number

可选

900

打折金额【1000位底数】,900代表9折

   └ decrease_money

Number

可选

100

减钱金额【分】

   └ limit

LimitDto

可选

 

限购配置信息

      └ total_limit_cnt

Number

可选

1

活动总限购

      └ daily_total_limit_cnt

Number

可选

2

活动每日限购

      └ user_total_limit_cnt

Number

可选

3

用户总限购

      └ user_daily_limit_cnt

Number

可选

4

用户每日限购

└ act_id

Number

必须

1278915

操作活动的ID

└ creator_id

String

必须

hl123

操作人ID

└ creator_name

String

必须

小黄

操作人Name

活动商品API出参介绍(add、delete

名称

参数类型/SDK类型

是否必须

示例值

描述

result

OctopusOpenResult

必须

result

操作结果

└ data

Number

可选

123

活动ID

└ success

Boolean

必须

true

是否成功 成功:true  失败:false

└ error_message

String

必须

参数错误

错误描述 建议商家记录日志:提供错误信息阿里侧查询

└ error_code

String

必须

PARAM_ERROR

错误描述 建议商家记录日志:提供错误信息阿里侧查询

FAQ

关于此文档暂时还没有FAQ
返回
顶部