权限点是商家对应用进行授权的依据,每一个权限点关联了一个系列的 Open API。通过这些 Open API,应用可以访问或编辑商店的数据。
这篇文档列出了平台目前已有的权限点以及它关联的接口。你可以实际需要决定在商家安装或更新应用时向商家申请哪些权限。例如,一个应用在使用过程中需要查询商家的订单信息,那么在安装时,就需要向商家请求获得 read_orders 的权限。
商家授权后,SHOPLINE 会返回包含 权限点 信息的访问令牌,应用携带访问令牌进行请求时,只有符合 权限点 范围的接口能够成功返回。
AccessScope
需要注意,部分 AccessScope 需要开通特定业务后才能够使用,在未开通业务权限之前申请权限,将可能出现以下报错:the app has no qualification。
需要开通特定业务的 AccessScope 包括:
write_payment_gateways:需要开通支付应用业务read_subscription_contracts&write_subscription_contracts:需要开通订阅电商业务
read_product_variant_images
权限点描述: 查询变体图片组合
相关接口: 查询变体图片组合
私有应用是否可用: 是
write_customers
权限点描述: 编辑客户、客户地址、订单历史记录和客户组
相关接口: companyLocationAssignAddress
私有应用是否可用: 是
read_payment
权限点描述: 查询账单、账户余额等
相关接口: 查询店铺账户余额、查询单一提款记录、查询账单记录、查询店铺交易记录
私有应用是否可用: 是
read_content
权限点描述: 查询主题、文章、博客、评论 、重定向处理记录信息
相关接口: 查询博客集合列表、查询所有文章作者列表、查询博客文章数量、查询博客集合数量、查询单个博客集合、批量查询主题、查询单个主题、通过评论id查询评论、获取评论的数量、查询评论列表、查询博客文章详情、查询博客文章列表
私有应用是否可用: 是
read_store_metrics
权限点描述: 商品指标、交易指标、访客行为等数据
相关接口: customerSegment
私有应用是否可用: 是
read_shop_policy
权限点描述: 店铺政策信息
相关接口: 查询店铺政策
私有应用是否可用: 是
write_page
权限点描述: 编辑页面、自定义页面信息
相关接口: 删除自定义页面、创建自定义页面、更新自定义页面
私有应用是否可用: 是
write_subscription_contracts
权限点描述: 管理支付工具、订阅合同等
相关接口: 跳过下一个账单、订阅合同创建后立即创建订单、修改下一个账单时间、取消订阅合同、编辑订阅合同信息
私有应用是否可用: 否
read_themes
权限点描述: 查询主题、主题文件及主题资产
相关接口: 查询主题所有文件、查询主题文件详情
私有应用是否可用: 是
read_price_rules
权限点描述: 查询价格规则的配置信息
相关接口: 检索所有价格规则计数、查询单个折扣码活动规则
私有应用是否可用: 是
write_themes
权限点描述: 编辑主题、主题文件及主题资产
相关接口: 创建或修改主题文件、删除主题资产、创建主题、批量创建/修改资产内容
私有应用是否可用: 是
write_fulfillment_service
权限点描述: 编辑履约服务信息
相关接口: 创建履约服务地点、创建履约服务、修改履约服务、删除履约服务
私有应用是否可用: 是
read_inventory
权限点描述: 查询库存地点、库存内商品信息
相关接口: 批量查询地点库存数量、查询单个库存单位、批量查询库存单位
私有应用是否可用: 是
read_subscription_contracts
权限点描述: 查询支付工具、订阅合同等
相关接口: 查询订阅合同详情、查询订阅合同列表
私有应用是否可用: 否
read_script_tags
权限点描述: 查看店面或订单状态页面中的 JavaScript 代码
相关接口: 查询script tag列表、查询单个script tag、查询script tag数量
私有应用是否可用: 是
write_shop_policy
权限点描述: 编辑店铺政策信息
相关接口: 更新政策页面
私有应用是否可用: 是
write_draft_orders
权限点描述: 编辑商家代表客户创建的订单
相关接口: 发送草稿单账单邮件、删除草稿单
私有应用是否可用: 是
read_publications
权限点描述: 查询在APP中发布的一组商品
相关接口: publications
私有应用是否可用: 是
write_shipping
权限点描述: 编辑承运商信息、地点税费等
相关接口: 创建承运商服务、更新承运商服务、删除承运商服务、批量设置运费方案、批量设置运费方案V2
私有应用是否可用: 是
write_store_information
权限点描述: 编辑账户语言、店铺信息等
相关接口: 添加店铺语言
私有应用是否可用: 是
read_assigned_fulfillment_orders
权限点描述: 发货单、履约单、物流信息跟踪等
相关接口: 获取指定履约单、查询发货单数量、获取履约单下的所有发货单、获取订单下的指定发货单、履约应用请求取消发货、履约单列表查询、查询履约发货物流事件
私有应用是否可用: 是
read_location
权限点描述: 查询店铺的地点配置信息
相关接口: 根据ID查询地点、查询地点列表、统计地点数量
私有应用是否可用: 是
write_product_variant_images
权限点描述: 编辑变体图片
相关接口: 批量更新变体图片
私有应用是否可用: 是
write_publications
权限点描述: 管理 APP 发布的一组商品
相关接口: publishablePublishToCurrentChannel
私有应用是否可用: 是
read_markets
权限点描述: 市场的基本信息
相关接口: 通过ID查询市场资源、查询市场列表
私有应用是否可用: 是
write_bulkoperation
权限点描述: 批量任务的状态变更操作
相关接口: 创建变更类批量任务(待废弃)、创建一个批量查询任务、创建一个批量变更任务
私有应用是否可用: 是
write_product_sizechart
权限点描述: 编辑商品尺码信息
相关接口: 批量删除尺码、创建尺码、更新尺码
私有应用是否可用: 是
read_product_sizechart
权限点描述: 查询商品尺码信息
相关接口: 批量查询尺码
私有应用是否可用: 是
write_script_tags
权限点描述: 编辑店面或订单状态页面中的 JavaScript 代码
相关接口: scriptTagCreate
私有应用是否可用: 是
read_shipping
权限点描述: 查询承运商信息、地点税费等
相关接口: 查询库存地址、查询所有到店取货信息、查询所有本地配送信息、查询店铺已配置税费的国家数量、查询指定国家的税费信息、查询店铺所有的税费信息、查询某个国家下所有州省的数量、查询指定国家下所有的州省信息、查询州省信息、获取承运商列表、获取指定承运商服务
私有应用是否可用: 是
write_price_rules
权限点描述: 编辑价格规则的配置信息
相关接口: 删除现有价格规则、更新折扣码活动规则
私有应用是否可用: 是
read_gift_card
权限点描述: 查询礼品卡代码、配置信息
相关接口: 查询单个礼品卡、查询礼品卡数量、获取礼品卡操作记录
私有应用是否可用: 是
read_product_listings
权限点描述: 查看商品列表
相关接口: 查询销售渠道的商品ID、查询销售渠道的商品总数、查询销售渠道的商品、查询销售渠道指定的商品、查询销售渠道的分类、查询销售渠道中的指定分类、检索公司地点目录列表、获取目录产品
私有应用是否可用: 是
write_orders
权限点描述: 编辑订单、交易、发货、弃单和结账
相关接口: 更新支付单