权限点是商家对应用进行授权的依据,每一个权限点关联了一个系列的 Open API。通过这些 Open API,应用可以访问或编辑商店的数据。

这篇文档列出了平台目前已有的权限点以及它关联的接口。你可以实际需要决定在商家安装或更新应用时向商家申请哪些权限。例如,一个应用在使用过程中需要查询商家的订单信息,那么在安装时,就需要向商家请求获得 read_orders 的权限。

商家授权后,SHOPLINE 会返回包含 权限点 信息的访问令牌,应用携带访问令牌进行请求时,只有符合 权限点 范围的接口能够成功返回。

AccessScope

note

需要注意,部分 AccessScope 需要开通特定业务后才能够使用,在未开通业务权限之前申请权限,将可能出现以下报错:the app has no qualification。 需要开通特定业务的 AccessScope 包括:

  • write_payment_gateways:需要开通支付应用业务
  • read_fulfillment_service&write_fulfillment_service:需要开通履约应用业务
  • read_subscription_contracts&write_subscription_contracts:需要开通订阅电商业务

read_product_variant_images

权限点描述: 查询变体图片组合
相关接口: 查询变体图片组合
私有应用是否可用: 是

write_product_sizechart

权限点描述: 编辑商品尺码信息
相关接口: 批量删除尺码创建尺码更新尺码
私有应用是否可用: 是

read_assigned_fulfillment_orders

权限点描述: 发货单、履约单、物流信息跟踪等
相关接口: 获取指定履约单查询发货单数量获取订单下的所有履约单获取履约单下的所有发货单获取订单下的所有发货单获取订单下的指定发货单履约应用请求取消发货履约单列表查询查询履约发货物流事件
私有应用是否可用: 是

read_markets

权限点描述: 市场的基本信息
相关接口: 查询市场列表通过ID查询市场资源
私有应用是否可用: 是

write_checkouts

权限点描述: 编辑税务配置信息
相关接口: 查询计税渠道修改计税渠道配置删除计税渠道配置
私有应用是否可用: 是

read_store_staff

权限点描述: 基于店铺维度查询用户信息(仅支持Enterprise店铺调用)。
相关接口: staffMembers
私有应用是否可用: 是

read_page

权限点描述: 查询页面、自定义页面信息
相关接口: 统计自定义页面页数获取自定义页面列表查询页面详情信息
私有应用是否可用: 是

read_orders

权限点描述: 查看订单、交易、发货、弃单和结账
相关接口: 查询弃单查询店铺结算货币查询订单风险欺诈列表查询订单指定的风险欺诈弃单数量查询订单数量查询查询交易单列表查询订单查询订单ID关联的所有退款单查询订单指定的退款单
私有应用是否可用: 是

read_themes

权限点描述: 查询主题、主题文件及主题资产
相关接口: 查询主题资产列表查询主题资产详情
私有应用是否可用: 是

read_marketing_event

权限点描述: 营销事件的信息
相关接口: 查询单个营销事件查询营销事件数量查询营销事件列表
私有应用是否可用: 是

read_discounts

权限点描述: 查询折扣代码和促销策略信息
相关接口: appDiscountType
私有应用是否可用: 是

write_discounts

权限点描述: 编辑折扣代码和促销策略信息
相关接口: discountAutomaticDoniUpdate
私有应用是否可用: 是

read_payment

权限点描述: 查询账单、账户余额等
相关接口: 查询店铺账户余额查询店铺提款记录查询账单记录查询单一提款记录
私有应用是否可用: 是

read_content

权限点描述: 查询主题、文章‎‎、‎‎博客‎‎、‎‎评论‎‎、重定向处理记录信息
相关接口: 查询博客集合列表查询所有文章作者列表查询博客文章数量查询博客集合数量查询单个博客集合批量获取主题列表查询一个主题通过评论id查询评论获取评论的数量查询评论列表查询博客文章详情查询博客文章列表
私有应用是否可用: 是

write_fulfillment_service

权限点描述: 编辑履约服务信息
相关接口: 创建履约服务地点创建履约服务修改履约服务删除履约服务
私有应用是否可用: 是

read_publications

权限点描述: 查询在APP中发布的一组商品
相关接口: publications
私有应用是否可用: 是

read_draft_orders

权限点描述: 查看商家代表客户创建的订单
相关接口: 草稿单数量查询查询草稿单
私有应用是否可用: 是

read_store_information

权限点描述: 查询当前账户语言、店铺信息
相关接口: 查询店铺支付渠道查询店铺信息
私有应用是否可用: 是

read_fulfillment_service

权限点描述: 用于履约服务商相关接口的权限调用
相关接口: 履约服务详情履约服务列表
私有应用是否可用: 是

read_inventory

权限点描述: 查询库存地点、库存内商品信息
相关接口: 批量查询库存状态获取单个库存对象批量查询库存对象
私有应用是否可用: 是

write_files

权限点描述: 编辑店铺内容维护的多媒体资源
相关接口: 创建文件更新文件删除文件
私有应用是否可用: 是

write_product_listings

权限点描述: 编辑商品列表
相关接口: 从销售渠道中移除分类查询销售渠道指定分类的商品ID从销售渠道中移除商品添加商品到销售渠道添加分类到销售渠道
私有应用是否可用: 是

read_translation

权限点描述: 查询 UGC 语料等
相关接口: translatableResources
私有应用是否可用: 是

write_publications

权限点描述: 管理 APP 发布的一组商品
相关接口: publishablePublishToCurrentChannel
私有应用是否可用: 是

read_customers

权限点描述: ‎查询客户、客户地址、订单历史记录和客户组‎
相关接口: companyCredit
私有应用是否可用: 是

read_shipping

权限点描述: 查询承运商信息、地点税费等
相关接口: 查询库存地址查询所有到店取货信息查询所有本地配送信息查询店铺已配置税费的国家数量查询指定国家的税费信息查询店铺所有的税费信息查询某个国家下所有州省的数量查询指定国家下所有的州省信息查询州省信息获取承运商列表获取指定承运商服务
私有应用是否可用: 是

write_subscription_contracts

权限点描述: 管理支付工具、订阅合同等
相关接口: 跳过下一个账单订阅合同创建后立即创建订单修改下一个账单时间取消订阅合同编辑订阅合同信息
私有应用是否可用: 否

read_shop_policy

权限点描述: 店铺政策信息
相关接口: 查询店铺政策
私有应用是否可用: 是

read_files

权限点描述: 查询店铺内容维护的多媒体资源
相关接口: 查看单个文件批量查询文件
私有应用是否可用: 是

write_selling_plan_group

权限点描述: 编辑销售计划组
相关接口: 添加商品到销售计划组从销售计划组解绑商品删除销售计划组创建销售计划组更新销售计划组
私有应用是否可用: 否

write_price_rules

权限点描述: 编辑价格规则的配置信息
相关接口: 删除现有价格规则更新现有价格规则
私有应用是否可用: 是

write_page

权限点描述: 编辑页面、自定义页面信息
相关接口: 删除自定义页面增加自定义页面更新自定义页面
私有应用是否可用: 是

write_themes

权限点描述: 编辑主题、主题文件及主题资产
相关接口: 创建/修改主题资产删除主题资产创建主题批量创建/修改资产内容
私有应用是否可用: 是

read_subscription_contracts

权限点描述: 查询支付工具、订阅合同等
相关接口: 查询订阅合同详情查询订阅合同列表
私有应用是否可用: 否

write_script_tags

权限点描述: 编辑店面或订单状态页面中的 JavaScript 代码‎
相关接口: scriptTagCreate
私有应用是否可用: 是

write_orders

权限点描述: 编辑订单、交易、发货、弃单和结账
相关接口: 更新运单号更新支付单查询支付设置删除订单相关的所有风险欺诈新增订单风险欺诈删除订单指定的风险欺诈更新订单风险欺诈订单退款试算订单退款创建支付单订单发货取消发货订单归档取消订单归档启动编辑设置商品数量新增自定义商品提交编辑结果订单中新增商品新增商品行折扣删除商品行折扣创建订单更新订单取消订单删除订单弃单归档
私有应用是否可用: 是

write_markets

权限点描述: 编辑市场的基本信息
相关接口: 更新市场币种汇率
私有应用是否可用: 是

read_bulkoperation

权限点描述: 查询批量任务的状态
相关接口: 查询当前店铺的活跃任务
私有应用是否可用: 是

write_draft_orders

权限点描述: 编辑商家代表客户创建的订单
相关接口: 发送invoice链接删除草稿单创建草稿单编辑草稿单完成草稿单
私有应用是否可用: 是

write_content

权限点描述: 编辑文章‎‎、‎‎博客‎‎、‎‎评论‎‎、重定向等
相关接口: 删除博客文章更新博客集合删除博客集合更新主题删除主题获取重定向列表查询单个重定向详情统计重定向数量更新重定向删除单个重定向创建评论更新评论批准评论将评论标记为非垃圾邮件将评论标记为垃圾邮件删除一个评论恢复删除的评论创建一个博客集合为集合创建博客文章更新博客文章创建重定向
私有应用是否可用: 是

write_products

权限点描述: 编辑商品、商品变种及分类
相关接口: 删除手动分类删除智能分类删除商品创建绑定关系删除绑定关系删除sku资源反馈创建sku根据id更新sku更新商品图片删除商品图片创建商品图片更新商品智能分类产品排序更新创建手动分类创建智能分类更新智能分类更新手动分类创建公司地点目录更新公司地点目录删除公司目录目录变体单独定价添加目录产品移除目录产品创建商品
私有应用是否可用: 是

write_return

权限点描述: 编辑退货单、退货履约单信息
相关接口: 关闭退货单创建退货单创建已退货发货单已退货发货单物流信息更新
私有应用是否可用: 是

write_gift_card

权限点描述: 编辑礼品卡代码、配置信息
相关接口: 禁用礼品卡创建礼品卡更新礼品卡
私有应用是否可用: 是

read_script_tags

权限点描述: 查看店面或订单状态页面中的 JavaScript 代码
相关接口: 查询script tag列表查询单个script tag查询script tag数量
私有应用是否可用: 是

read_gift_card

权限点描述: 查询礼品卡代码、配置信息
相关接口: 查询单个礼品卡查询礼品卡数量分页查询礼品卡获取礼品卡操作记录
私有应用是否可用: 是

read_store_metrics

权限点描述: 商品指标、交易指标、访客行为等数据
相关接口: customerSegment
私有应用是否可用: 是

read_products

权限点描述: 查询商品、商品变种及分类
相关接口: 批量查询商品数量查询单个商品所有sku数量根据id查询手动分类属性批量查询手动分类数量批量查询智能分类数量批量查询手动分类单个查询分类关系批量查询分类关系批量查询分类关系数量资源反馈列表批量查询商品查询单个商品查询单个商品所有sku根据id查询sku查询单张商品图片批量查询商品图片查询单个商品的主图总数查询某个分类下商品信息根据id查询分类信息根据id查询智能分类属性批量查询智能分类查询变种的市场价格查询商品的市场价格范围查询商品的市场发布情况检索公司地点目录指定目录变体查询定价规则查询目录地点
私有应用是否可用: 是

write_store_information

权限点描述: 编辑账户语言、店铺信息等
相关接口: 添加店铺语言设置
私有应用是否可用: 是

write_assigned_fulfillment_orders

权限点描述: 编辑发货单、履约单、物流信息跟踪等
相关接口: 设定履约单deadline更新履约单库存地点重新预定履约时间履约单释放onhold状态履约单标记onhold新发货单追踪信息为履约单创建发货单(单个或批量)取消发货单履约应用拒绝取消请求发货履约应用接受取消请求发货履约应用拒绝请求发货履约应用接受请求发货根据履约单请求发货删除履约发货物流事件创建履约发货物流事件
私有应用是否可用: 是

write_product_variant_images

权限点描述: 编辑变体图片
相关接口: 批量更新变体图片
私有应用是否可用: 是

write_customers

权限点描述: 编辑客户、客户地址、订单历史记录和客户组‎
相关接口: companyLocationAssignAddress
私有应用是否可用: 是

write_shop_policy

权限点描述: 编辑店铺政策信息
相关接口: 更新政策页面
私有应用是否可用: 是

read_pos

权限点描述: 查询门店信息
相关接口: 查询门店列表
私有应用是否可用: 否

write_marketing_event

权限点描述: 编辑营销事件的信息
相关接口: 流程统计数据同步创建营销事件更新营销事件删除营销事件创建营销拓展活动更新营销拓展活动创建营销活动汇总数据批量同步营销事件统计数据
私有应用是否可用: 是

read_returns

权限点描述: 查询退货单、退货履约单信息
相关接口: 查询退货单查询退货的履约单查询已退货发货单
私有应用是否可用: 是

read_product_sizechart

权限点描述: 查询商品尺码信息
相关接口: 批量查询尺码
私有应用是否可用: 是

write_translation

权限点描述: 管理 UGC 语料
相关接口: translationsRegister
私有应用是否可用: 是

write_shipping

权限点描述: 编辑承运商信息、地点税费等
相关接口: 创建承运商服务更新承运商服务删除承运商服务批量设置运费方案批量设置运费方案V2
私有应用是否可用: 是

write_bulkoperation

权限点描述: 批量任务的状态变更操作
相关接口: 批量变更任务(弃用)批量查询任务批量任务更新(通用)批量任务取消
私有应用是否可用: 是

read_product_listings

权限点描述: 查看商品列表
相关接口: 查询销售渠道的商品ID查询销售渠道的商品总数查询销售渠道的商品查询销售渠道指定的商品查询销售渠道的分类查询销售渠道中的指定分类检索公司地点目录列表获取目录产品
私有应用是否可用: 是

write_payment_gateways

权限点描述: 编辑支付应用的相关信息
相关接口: 退款成功通知付款成功通知商户激活成功通知设备绑定成功通知
私有应用是否可用: 否

read_location

权限点描述: 查询店铺的地点配置信息
相关接口: 根据ID查询地点查询地点列表统计地点数量
私有应用是否可用: 是

write_inventory

权限点描述: 编辑库存地点、库存内商品信息
相关接口: 更新库存状态设置库存状态连接库存状态断开库存状态更新库存对象
私有应用是否可用: 是

read_price_rules

权限点描述: 查询价格规则的配置信息
相关接口: 检索所有价格规则计数检索单个价格规则
私有应用是否可用: 是

read_selling_plan_group

权限点描述: 查询销售计划组信息
相关接口: 查询销售计划组详情查询多个销售计划组获取销售计划组总数
私有应用是否可用: 否

Unanthenticated AccessScope

unauthenticated_read_checkouts_info

权限点描述: 通过 Storefront 查询结账数据
相关接口: checkout
私有应用是否可用: 是

unauthenticated_write_cart

权限点描述: 通过 Storefront 编辑购物车
相关接口: cartItemSelect
私有应用是否可用: 是

unauthenticated_read_message

权限点描述: 读取商家会话、发起会回等
相关接口: messageQuery
私有应用是否可用: 是

unauthenticated_read_cart

权限点描述: 通过 Storefront 查询购物车数据
相关接口: cartItemSelect
私有应用是否可用: 是

unauthenticated_write_checkouts_info

权限点描述: 通过 Storefront 编辑结账信息
相关接口: checkoutShippingAddressUpdate
私有应用是否可用: 是

unauthenticated_write_customer_information

权限点描述: 通过 Storefront 编辑顾客信息、地址信息
相关接口: customerAccessTokenCreate
私有应用是否可用: 是

unauthenticated_write_message

权限点描述: 管理商家消息列表
相关接口: messageSend
私有应用是否可用: 是

这篇文章对你有帮助吗?

Error loading component.

Error loading component.