权限点是商家对应用进行授权的依据,每一个权限点关联了一个系列的 Open API。通过这些 Open API,应用可以访问或编辑商店的数据。
这篇文档列出了平台目前已有的权限点以及它关联的接口。你可以实际需要决定在商家安装或更新应用时向商家申请哪些权限。例如,一个应用在使用过程中需要查询商家的订单信息,那么在安装时,就需要向商家请求获得 read_orders
的权限。
商家授权后,SHOPLINE 会返回包含 权限点
信息的访问令牌,应用携带访问令牌进行请求时,只有符合 权限点
范围的接口能够成功返回。
AccessScope
需要注意,部分 AccessScope 需要开通特定业务后才能够使用,在未开通业务权限之前申请权限,将可能出现以下报错:the app has no qualification
。
需要开通特定业务的 AccessScope 包括:
write_payment_gateways
:需要开通支付应用业务read_fulfillment_service
&write_fulfillment_service
:需要开通履约应用业务read_subscription_contracts
&write_subscription_contracts
:需要开通订阅电商业务
read_store_metrics
权限点描述: 商品指标、交易指标、访客行为等数据
相关接口: 查询店铺生效套餐
私有应用是否可用: 是
read_markets
权限点描述: 市场的基本信息
相关接口: 查询市场列表、通过ID查询市场资源
私有应用是否可用: 是
write_draft_orders
权限点描述: 编辑商家代表客户创建的订单
相关接口: 发送invoice链接、删除草稿单、完成草稿单、创建草稿单、编辑草稿单
私有应用是否可用: 是
write_translation
权限点描述: 管理 UGC 语料
相关接口: 删除店铺语言、根据 UGC 资源 IDs 和 Field 删除语料、更新 UGC 语料
私有应用是否可用: 是
read_pos
权限点描述: 查询门店信息
相关接口: 查询门店列表
私有应用是否可用: 否
read_payment
权限点描述: 查询账单、账户余额等
相关接口: 查询店铺账户余额、查询店铺提款记录、查询账单记录、查询单一提款记录
私有应用是否可用: 是
write_customers
权限点描述: 编辑客户、客户地址、订单历史记录和客户组
相关接口: 创建客户分组、更新客户分组、删除客户分组、删除顾客信息、发送激活邮件、激活客户、批量操作地址、新增地址2.0、更新地址2.0、设置默认地址2.0、删除客户地址2.0、删除指定客户标签、新增顾客信息、更新顾客信息
私有应用是否可用: 是
read_draft_orders
权限点描述: 查看商家代表客户创建的订单
相关接口: 草稿单数量查询、查询草稿单
私有应用是否可用: 是
write_inventory
权限点描述: 编辑库存地点、库存内商品信息
相关接口: 更新库存状态、设置库存状态、连接库存状态、断开库存状态、更新库存对象
私有应用是否可用: 是
write_price_rules
权限点描述: 编辑价格规则的配置信息
相关接口: 删除现有价格规则、更新现有价格规则
私有应用是否可用: 是
read_product_listings
权限点描述: 查看商品列表
相关接口: 查询销售渠道的商品ID、查询销售渠道的商品总数、查询销售渠道的商品、查询销售渠道指定的商品、查询销售渠道的分类、查询销售渠道中的指定分类
私有应用是否可用: 是
write_shipping
权限点描述: 编辑承运商信息、地点税费等
相关接口: 创建承运商服务、更新承运商服务、删除承运商服务、批量设置运费方案
私有应用是否可用: 是
write_discounts
权限点描述: 编辑折扣代码和促销策略信息
相关接口: 创建DiscountCode、删除DiscountCode、更新DiscountCode、创建优惠码创建的任务、创建价格规则
私有应用是否可用: 是
read_marketing_event
权限点描述: 营销事件的信息
相关接口: 查询单个营销事件、查询营销事件数量、查询营销事件列表
私有应用是否可用: 是
write_products
权限点描述: 编辑商品、商品变种及分类
相关接口: 创建手动分类、更新手动分类、删除手动分类、删除智能分类、删除商品、创建绑定关系、删除绑定关系、删除sku、资源反馈、更新商品、创建商品、创建sku、根据id更新sku、更新商品图片、删除商品图片、创建商品图片、创建智能分类、更新智能分类
私有应用是否可用: 是
read_content
权限点描述: 查询主题、文章、博客、评论、重定向处理记录信息
相关接口: 查询博客集合列表、查询博客文章列表、查询所有文章作者列表、查询博客文章详情、查询博客文章数量、查询博客集合数量、查询单个博客集合、批量获取主题列表、查询一个主题、通过评论id查询评论、获取评论的数量、查询评论列表
私有应用是否可用: 是
write_page
权限点描述: 编辑页面、自定义页面信息
相关接口: 删除自定义页面、增加自定义页面、更新自定义页面
私有应用是否可用: 是
write_selling_plan_group
权限点描述: 编辑销售计划组
相关接口: 添加商品到销售计划组、从销售计划组解绑商品、删除销售计划组、创建销售计划组、更新销售计划组
私有应用是否可用: 否
read_shop_policy
权限点描述: 店铺政策信息
相关接口: 查询店铺政策
私有应用是否可用: 是
write_product_listings
权限点描述: 编辑商品列表
相关接口: 从销售渠道中移除分类、查询销售渠道指定分类的商品ID、从销售渠道中移除商品、添加商品到销售渠道、添加分类到销售渠道
私有应用是否可用: 是
write_store_information
权限点描述: 编辑账户语言、店铺信息等
相关接口: 添加店铺语言设置
私有应用是否可用: 是
read_store_information
权限点描述: 查询当前账户语言、店铺信息
相关接口: 查询店铺信息、查询店铺支付渠道
私有应用是否可用: 是
write_orders
权限点描述: 编辑订单、交易、发货、弃单和结账
相关接口: 更新运单号、更新支付单、查询支付设置、删除订单相关的所有风险欺诈、新增订单风险欺诈、删除订单指定的风险欺诈、更新订单风险欺诈、订单退款试算、创建订单、取消订单、更新订单、订单退款、创建支付单、订单发货、取消发货
私有应用是否可用: 是
read_returns
权限点描述: 查询退货单、退货履约单信息
相关接口: 查询退货单、查询退货的履约单、查询已退货发货单
私有应用是否可用: 是
write_payment_gateways
权限点描述: 编辑支付应用的相关信息
相关接口: 退款成功通知、付款成功通知、商户激活成功通知
私有应用是否可用: 否
read_shipping
权限点描述: 查询承运商信息、地点税费等
相关接口: 查询库存地址、查询所有到店取货信息、查询所有本地配送信息、查询店铺已配置税费的国家数量、查询指定国家的税费信息、查询店铺所有的税费信息、查询某个国家下所有州省的数量、查询指定国家下所有的州省信息、查询州省信息、获取承运商列表、获取指定承运商服务
私有应用是否可用: 是
write_script_tags
权限点描述: 编辑店面或订单状态页面中的 JavaScript 代码
相关接口: 创建一个script tag、更新script tag、删除script tag
私有应用是否可用: 是
read_orders
权限点描述: 查看订单、交易、发货、弃单和结账
相关接口: 查询弃单、查询店铺结算货币、查询订单风险欺诈列表、查询订单指定的风险欺诈、查询订单ID关联的所有退款单、查询订单指定的退款单、弃单数量查询、订单数量查询、查询交易单列表、查询订单
私有应用是否可用: 是
write_bulkoperation
权限点描述: 批量任务的状态变更操作
相关接口: 批量变更任务(弃用)、批量查询任务、批量任务更新(通用)、批量任务取消
私有应用是否可用: 是
read_assigned_fulfillment_orders
权限点描述: 发货单、履约单、物流信息跟踪等
相关接口: 获取指定履约单、查询发货单数量、获取订单下的所有履约单、获取履约单下的所有发货单、获取订单下的所有发货单、获取订单下的指定发货单
私有应用是否可用: 是
write_assigned_fulfillment_orders
权限点描述: 编辑发货单、履约单、物流信息跟踪等
相关接口: 设定履约单deadline、更新履约单库存地点、重新预定履约时间、履约单释放onhold状态、履约单标记onhold、新发货单追踪信息、为履约单创建发货单(单个或批量)、取消发货单
私有应用是否可用: 是
read_gift_card
权限点描述: 查询礼品卡代码、配置信息
相关接口: 查询单个礼品卡、查询礼品卡数量、分页查询礼品卡
私有应用是否可用: 是
write_marketing_event
权限点描述: 编辑营销事件的信息
相关接口: 流程统计数据同步、创建营销事件、批量同步营销事件统计数据、更新营销事件、删除营销事件、创建营销拓展活动、更新营销拓展活动
私有应用是否可用: 是
read_bulkoperation
权限点描述: 查询批量任务的状态
相关接口: 查询当前店铺的活跃任务
私有应用是否可用: 是
read_price_rules
权限点描述: 查询价格规则的配置信息
相关接口: 检索所有价格规则计数、检索单个价格规则
私有应用是否可用: 是
read_subscription_contracts
权限点描述: 查询支付工具、订阅合同等
相关接口: 查询订阅合同详情、查询订阅合同列表
私有应用是否可用: 否
write_shop_policy
权限点描述: 编辑店铺政策信息
相关接口: 更新政策页面
私有应用是否可用: 是
read_translation
权限点描述: 查询 UGC 语料等
相关接口: 获取店铺语言设置、批量查询店铺的翻译语料、查询 UGC 语料
私有应用是否可用: 是
write_themes
权限点描述: 编辑主题、主题文件及主题资产
相关接口: 创建/修改主题资产、删除主题资产、创建主题
私有应用是否可用: 是
read_script_tags
权限点描述: 查看店面或订单状态页面中的 JavaScript 代码
相关接口: 查询script tag列表、查询单个script tag、查询script tag数量
私有应用是否可用: 是
read_products
权限点描述: 查询商品、商品变种及分类
相关接口: 批量查询商品数量、查询单个商品所有sku数量、根据id查询手动分类属性、批量查询手动分类数量、批量查询智能分类数量、批量查询手动分类、单个查询分类关系、批量查询分类关系、批量查询分类关系数量、资源反馈列表、批量查询商品、查询单个商品、查询单个商品所有sku、根据id查询sku、查询单张商品图片、批量查询商品图片、查询单个商品的主图总数、查询某个分类下商品信息、根据id查询分类信息、根据id查询智能分类属性、批量查询智能分类
私有应用是否可用: 是
read_files
权限点描述: 查询店铺内容维护的多媒体资源
相关接口: 查看单个文件、批量查询文件
私有应用是否可用: 是
write_subscription_contracts
权限点描述: 管理支付工具、订阅合同等
相关接口: 跳过下一个账单、订阅合同创建后立即创建订单、修改下一个账单时间、取消订阅合同、编辑订阅合同信息
私有应用是否可用: 否
read_selling_plan_group
权限点描述: 查询销售计划组信息
相关接口: 查询销售计划组详情、查询多个销售计划组、获取销售计划组总数
私有应用是否可用: 否
read_customers
权限点描述: 查询客户、客户地址、订单历史记录和客户组
相关接口: 指定客户分组查询、批量获取客户分组、顾客数量查询、查询客户分组下的所有顾客、批量查询用户订阅信息、查询店铺分组数量、查询指定客户订单、会员列表、会员详情、查询客户地址详情2.0、批量查询客户地址2.0、通过邮件查询顾客信息、查询顾客信息列表、查询顾客详情、顾客信息检索
私有应用是否可用: 是
write_files
权限点描述: 编辑店铺内容维护的多媒体资源
相关接口: 创建文件、更新文件、删除文件
私有应用是否可用: 是
read_themes
权限点描述: 查询主题、主题文件及主题资产
相关接口: 查询主题资产列表、查询主题资产详情
私有应用是否可用: 是
read_discounts
权限点描述: 查询折扣代码和促销策略信息
相关接口: 查询自动折扣活动、折扣码查询、根据Id查询DiscountCode、根据Code查询DiscountCode、优惠规则Id查询DiscountCode、查询店铺DiscountCode总数、根据任务ID查询优惠码信息、查询批量创建的折扣码列表、检索价格规则列表
私有应用是否可用: 是
read_page
权限点描述: 查询页面、自定义页面信息
相关接口: 查询页面详情信息、获取自定义页面列表、统计自定义页面页数
私有应用是否可用: 是
write_gift_card
权限点描述: 编辑礼品卡代码、配置信息
相关接口: 创建礼品卡、更新礼品卡、禁用礼品卡
私有应用是否可用: 是
write_return
权限点描述: 编辑退货单、退货履约单信息
相关接口: 关闭退货单、创建退货单、创建已退货发货单、已退货发货单物流信息更新
私有应用是否可用: 是
read_inventory
权限点描述: 查询库存地点、库存内商品信息
相关接口: 批量查询库存状态、获取单个库存对象、批量查询库存对象
私有应用是否可用: 是
read_location
权限点描述: 查询店铺的地点配置信息
相关接口: 根据ID查询地点、查询地点列表、统计地点数量
私有应用是否可用: 是
write_markets
权限点描述: 编辑市场的基本信息
相关接口: 更新市场币种汇率
私有应用是否可用: 是
write_content
权限点描述: 编辑文章、博客、评论、重定向等
相关接口: 删除博客文章、更新博客文章、更新博客集合、删除博客集合、更新主题、删除主题、创建重定向、获取重定向列表、查询单个重定向详情、统计重定向数量、更新重定向、删除单个重定向、创建评论、更新评论、批准评论、将评论标记为非垃圾邮件、将评论标记为垃圾邮件、删除一个评论、恢复删除的评论、为集合创建博客文章、创建一个博客集合
私有应用是否可用: 是
Unanthenticated AccessScope
unauthenticated_write_customer_information
权限点描述: 通过 Storefront 编辑顾客信息、地址信息
相关接口: customerAccessTokenCreate
私有应用是否可用: 是
unauthenticated_read_checkouts_info
权限点描述: 通过 Storefront 查询结账数据
相关接口: checkout
私有应用是否可用: 是
unauthenticated_write_checkouts_info
权限点描述: 通过 Storefront 编辑结账信息
相关接口: checkoutShippingAddressUpdate
私有应用是否可用: 是