商品接口最佳实践

更新时间:
复制为 MD 格式

本文介绍LinkedMall API V2.0商品类接口对接最佳实践。

一、概述

LinkedMall API为分销商提供了一系列商品相关接口和消息,分销商可通过合理调用各接口和商品消息消费,实现商品的同步、查询等功能。

本文档旨在规范接口调用的流程并提示相关注意事项,以协助分销商避免不合理调用接口导致的问题,从而提升系统的稳定性和可靠性。文档通过四个典型场景阐明如何正确使用接口。

重要

分销商在系统设计和调用接口时,还应充分考虑各接口QPS限制,详情请参考LinkedMall API V2.0 接口QPS限制说明

二、典型场景说明

场景1:商品同步并回流

说明

商品同步是指将商品信息从一个系统同步到另一个系统,并将同步结果回流。通常用于系统间的数据初始化或不定期更新。

典型业务场景

典型业务场景

场景说明

相关接口

相关消息

首次获取全量商品(商品初始化)

分销商完成入驻和店铺开通后,渠道商将为分销商完成商品铺货。

铺货完成后,分销商可通过调用查询商品池选品列表接口逐页获取全量商品。

说明
  • 由于数据量可能较大,请采用分页查询的方式进行递归调用。

  • 首次调用时获取第1页数据及总记录数total,根据total计算总页数,然后依次调用接口获取后续页数据,直至获取到所有商品信息。

查询选品池商品列表

业务正常运维阶段的增量商品获取(不定期更新)

完成Kafka消息对接后,建议分销商及时消费商品创建消息获取增量商品。

商品创建消息

业务正常运维阶段的商品信息更新(不定期更新)

完成Kafka消息对接后,建议分销商及时消费商品各类消息,以完成商品信息、状态等更新。

商品类信息

商品按页查询

分销商自建商品管理后台中,如需按页查询商品,可调用查询商品池选品列表接口指定查询页获取商品信息。

查询选品池商品列表

注意事项

  • 确保调用接口时的参数完整性和准确性,避免因参数错误导致数据缺失。

  • 应及时消费商品各类消息,以正确获得增量商品及商品状态等更新。


场景2:搜索接口同步商品并回流

说明

通过搜索接口同步商品信息并回流,适用于根据特定条件动态获取商品数据的场景。

说明
  • LinkedMall分销商控制台提供了商品筛选和商品出库、入库功能,分销商也可以通过控制台进行操作,请参考控制台说明文档分销商选品

  • 如分销商自建商品管理后台需集成商品筛选和商品出库、入库功能,请参考下文典型业务场景中的内容。

重要

商品出库、入库功能,目前仅开放给已加白(202511日(含)后入驻的)分销商。未加白(202511日前入驻的)的分销商可忽略此功能和商品信息中的商品出入库状态字段inGroup。详情请咨询LinkedMall技术支持小二。

典型业务场景

典型业务场景

场景说明

相关接口

相关消息

按条件筛选或搜索指定商品

商品搜索接口提供与分销商控制台商品管理模块一致的筛选与搜索能力。

分销商如有自建商品管理后台,可调用接口实现筛选或搜索符合接口入参条件的商品。

说明

非按条件筛选或搜索商品场景时的商品分页查询,建议使用查询商品池选品列表接口。

搜索选品池商品

按条件筛选或搜索指定商品后完成商品出库、入库

  1. 调用商品搜索接口,筛选符合条件的待出库或待入库的商品

  2. 调用商品出库或入库接口完成商品出库或入库操作

说明

分销商在LinkedMall分销商控制台进行出库、入库操作后,如需同步商品出入库状态,请及时消费商品出库消息和商品入库消息

搜索选品池商品

选品池商品出库

选品池商品入库

商品出库消息

商品入库消息

注意事项

  • 搜索条件的准确性对结果至关重要,确保搜索参数的合理性和完整性。

  • 目前,商品出入库功能及消息等,仅适用于已加白(202511日(含)后入驻的)出入库功能的分销商,请参考下表。

    功能

    加白分销伙伴

    未加白分销伙伴

    优化后的商品消息发送策略

    遵循新策略(参考下一张表格)

    全量发送和消费

    商品出库、入库接口

    需对接或在控制台操作出入库

    出入库操作不生效

    商品出库、入库消息

    需及时消费

    需忽略

    商品出入库状态inGroup字段

    需关注或处理

    需忽略

  • LinkedMall系统针对已入库和未入库(已出库)的商品采用不同的商品消息发送和策略。详情请参考下表。

    重要

    商品出库、入库功能,目前仅开放给部分已加白(202511日(含)后入驻的)分销商。未加白(202511日前入驻的)的分销商的全类商品消息均会发送(可忽略下表)。详情请咨询LinkedMall技术支持小二。

    消息

    未入库商品是否发送

    已入库商品是否发送

    商品创建消息

    商品删除消息

    商品编辑消息

    商品状态变更消息

    商品入库消息

    商品出库消息

    商品建议零售价变更消息

    Sku创建消息

    Sku删除消息

    Sku价格变更消息

    Sku编辑消息

    Sku状态变更消息


场景3:购物车商品列表展示场景

说明

电商业务通常需要配置购物车模块。当买家加购商品后,商品进入购物车商品列表。

典型业务场景

典型业务场景

场景说明

相关接口

相关消息

购物车商品列表信息展示

当买家进入购物车查看商品列表时,需要购物车呈现所加购的商品的可售状态等,此时分销商可调用批量查询选品池SKU销售信息接口批量查询商品的SKU销售信息。

说明
  • 接口支持1-10SKU销售信息的批量查询。如分销商购物车支持加购数量大于10,需要多次调用接口,实现全量查询。

  • 如需按买家收货地址查询对应区域是否可售,需传入divisionCode字段。

批量查询选品池SKU销售信息

注意事项

  • 确保购物车中的SKUID准确无误,避免查询到错误的商品信息。

  • 如需按买家收货地址查询对应区域是否可售,需在调用接口时传入divisionCode字段。


场景4:商详展示和导购展示场景

说明

商详与导购场景是指业务根据用户的需求推荐商品,通常需要查询商品详情和售卖信息。

典型业务场景

典型业务场景

场景说明

相关接口

相关消息

导购场景下的商品状态等信息查询

电商业务中的导购场景如首页瀑布流等,通常需要在加载商品前获取商品可售状态等信息,分销商可调用查询选品池商品销售信息接口进行查询

批量查询选品池商品销售信息

商详展示

  • 商详页中展示商品详情时可调用查询选品池商品详情接口获取商品信息。

    说明

    因接口QPS限制,分销商需结合自身业务流量考虑商详数据拉取方式。如商详流量较大,建议分销商C端从自己的数据库中获取,商品信息的更新入库建议依赖(及时)消费商品各类消息。

  • 在商详页中,买家未选择SKU或商品规格时,当买家指定或修改收货地址后,需查询对应区域商品是否可售,可调用查询选品池商品销售信息接口进行查询。

    说明

    调用该接口时,应传入divisionCode参数以正确获得买家收货地址对应区域的商品可售状态。

  • 在商详页中,买家已选择SKU或商品规格时,当买家指定或修改收货地址后,需查询对应区域商品SKU是否可售,可调用批量查询选品池SKU销售信息接口进行查询。

    说明
    • 调用接口时,应传入divisionCode参数以正确获得买家收货地址对应区域的商品SKU可售状态。

    • 应商详一般仅支持选择单个SKU,因此分销商在调用接口时传入单个SKUID即可。

查询选品池商品详情

查询选品池商品销售信息

批量查询选品池SKU销售信息

商品类信息

注意事项

  • 导购场景中,商品推荐的准确性依赖于商品详情和售卖信息的完整性,确保接口调用时参数正确。

  • 如需查询商品在指定区域是否可售,调用接口时需传入divisionCode参数。

三、商品接口及消息介绍

请参考商品接口说明及商品消息说明。

四、商品域部分重要字段和结构体说明

字段或结构体名

说明

存在结构体

关联接口或消息

valueAlias

SKU和商品规格值别名。当valueAlias有值时,请使用该字段对客展示 SKU和商品规格;valueAlias字段无值时才使用value字段值展示SKU和商品规格。

ProductSpecValue

SkuSpec

ProductNotifyPropertyValue

查询选品池商品详情

查询选品池商品列表

商品编辑消息

Sku创建消息

商品创建消息

title

SKU标题。建议分销商取 SkuSpec 结构体中的 value 值或 valueAlias 值(当 valueAlias 有值时不使用value 值)拼接 SKU 标题对客展示。不建议直接使用本字段作为 SKU 标题对客展示

Sku

EditableSku

查询选品池商品详情

查询选品池商品列表

Sku创建消息

商品创建消息

Sku编辑消息

skuAlias

SKU备注说明。作为SKU的补充说明,可补充在拼接完成的SKU标题后展示。

Sku

查询选品池商品详情

查询选品池商品列表

Sku创建消息

商品创建消息

LimitRule

商品限购规则

-

商品创建消息

查询选品池商品详情

查询选品池商品列表

查询选品池商品销售信息

批量查询选品池商品销售信息

ProductExtendProperty

商品扩展属性。包含了商品购买倍数、品牌Logo、商品导购标题等扩展属性内容。

-

查询选品池商品详情

查询选品池商品列表

商品编辑消息

商品创建消息