权限点是商家对应用进行授权的依据,每一个权限点关联了一个系列的 Open API。通过这些 Open API,应用可以访问或编辑商店的数据。
这篇文档列出了平台目前已有的权限点以及它关联的接口。你可以实际需要决定在商家安装或更新应用时向商家申请哪些权限。例如,一个应用在使用过程中需要查询商家的订单信息,那么在安装时,就需要向商家请求获得 read_orders 的权限。
商家授权后,SHOPLINE 会返回包含 权限点 信息的访问令牌,应用携带访问令牌进行请求时,只有符合 权限点 范围的接口能够成功返回。
AccessScope
需要注意,部分 AccessScope 需要开通特定业务后才能够使用,在未开通业务权限之前申请权限,将可能出现以下报错:the app has no qualification。
需要开通特定业务的 AccessScope 包括:
write_payment_gateways:需要开通支付应用业务read_subscription_contracts&write_subscription_contracts:需要开通订阅电商业务
write_assigned_fulfillment_orders
权限点描述: 编辑发货单、履约单、物流信息跟踪等
相关接口: 设定履约单deadline、更新履约单库存地点、重新预定履约时间、履约单释放onhold状态、履约单标记onhold、取消发货单、履约应用拒绝取消请求发货、履约应用接受取消请求发货、履约应用拒绝请求发货、履约应用接受请求发货、根据履约单请求发货、删除履约发货物流事件、创建履约发货物流事件、为履约单创建发货单(单个或批量)、更新发货单物流追踪信息
私有应用是否可用: 是
write_script_tags
权限点描述: 编辑店面或订单状态页面中的 JavaScript 代码
相关接口: scriptTagCreate
私有应用是否可用: 是
read_location
权限点描述: 查询店铺的地点配置信息
相关接口: 根据ID查询地点、查询地点列表、统计地点数量
私有应用是否可用: 是
read_returns
权限点描述: 查询退货单、退货履约单信息
相关接口: 查询退货的履约单、查询已退货发货单、查询退货单
私有应用是否可用: 是
read_data_report
权限点描述: 用户身份、属性及事件上报
相关接口: 上报买家身份信息、上报买家行为事件
私有应用是否可用: 是
write_subscription_contracts
权限点描述: 管理支付工具、订阅合同等
相关接口: 跳过下一个账单、订阅合同创建后立即创建订单、修改下一个账单时间、取消订阅合同、编辑订阅合同信息
私有应用是否可用: 否
read_orders
权限点描述: 查看订单、交易、发货、弃单和结账
相关接口: 查询店铺结算货币、查询订单欺诈风险、查询订单指定的风险欺诈、弃单数量查询、查询订单数量、查询订单支付单列表、查询订单指定的退款单
私有应用是否可用: 是
write_shop_policy
权限点描述: 编辑店铺政策信息
相关接口: 更新政策页面
私有应用是否可用: 是
read_bulkoperation
权限点描述: 查询批量任务的状态
相关接口: 查询一个有效批量任务
私有应用是否可用: 是
read_selling_plan_group
权限点描述: 查询销售计划组信息
相关接口: 查询销售计划组详情、查询多个销售计划组、获取销售计划组总数
私有应用是否可用: 否
read_shop_policy
权限点描述: 店铺政策信息
相关接口: 查询店铺政策
私有应用是否可用: 是
read_fulfillment_service
权限点描述: 用于履约服务商相关接口的权限调用
相关接口: 履约服务详情、履约服务列表
私有应用是否可用: 是
write_inventory
权限点描述: 编辑库存地点、库存内商品信息
相关接口: 更新地点库存数量、设置地点库存数量、断开库存单位与地点连接、更新库存单位
私有应用是否可用: 是
write_draft_orders
权限点描述: 编辑商家代表客户创建的订单
相关接口: 发送草稿单账单邮件、删除草稿单
私有应用是否可用: 是
read_payment
权限点描述: 查询账单、账户余额等
相关接口: 查询单一提款记录
私有应用是否可用: 是
read_store_staff
权限点描述: 基于店铺维度查询用户信息(仅支持Enterprise店铺调用)。
相关接口: staffMembers
私有应 用是否可用: 是
write_bulkoperation
权限点描述: 批量任务的状态变更操作
相关接口: 创建变更类批量任务(待废弃)、创建一个批量查询任务、创建一个批量变更任务
私有应用是否可用: 是
write_store_information
权限点描述: 编辑账户语言、店铺信息等
相关接口: 添加店铺语言
私有应用是否可用: 是
write_product_variant_images
权限点描述: 编辑变体图片
相关接口: 批量更新变体图片
私有应用是否可用: 是
read_price_rules
权限点描述: 查询价格规则的配置信息
相关接口: 检索所有价格规则计数、查询单个折扣码活动规则
私有应用是否可用: 是
write_checkouts
权限点描述: 编辑税务配置信息
相关接口: 查询计税渠道、修改计税渠道配置、删除计税渠道配置
私有应用是否可用: 是
write_discounts
权限点描述: 编辑折扣代码和促销策略信息
相关接口: discountAutomaticDoniUpdate
私有应用是否可用: 是
read_product_listings
权限点描述: 查看商品列表
相关接口: 查询销售渠道的商品ID、查询销售渠道的商品总数、查询销售渠道的商品、查询销售渠道指 定的商品、查询销售渠道的分类、查询销售渠道中的指定分类、检索公司地点目录列表、获取目录产品
私有应用是否可用: 是
write_selling_plan_group
权限点描述: 编辑销售计划组
相关接口: 添加商品到销售计划组、从销售计划组移除商品、删除销售计划组、创建销售计划组、更新销售计划组
私有应用是否可用: 否
write_marketing_event
权限点描述: 编辑营销事件的信息
相关接口: 流程统计数据同步、创建营销事件、更新营销事件、删除营销事件、创建营销拓展活动、更新营销拓展活动、创建营销活动汇总数据、批量同步营销事件统计数据
私有应用是否可用: 是
write_publications
权限点描述: 管理 APP 发布的一组商品
相关接口: publishablePublishToCurrentChannel
私有应用是否可用: 是
write_product_listings
权限点描述: 编辑商品列表
相关接口: 从销售渠道中移除分类、查询销售渠道指定分类的商品ID、添加分类到销售渠道
私有应用是否可用: 是
read_discounts
权限点描述: 查询折扣代码和促销策略信息
相关接口: appDiscountType
私有应用是否可用: 是
read_product_sizechart
权限点描述: 查询商品尺码信息
相关接口: 批量查询尺码
私有应用是否可用: 是
read_product_variant_images
权限点描述: 查询变体图片组合
相关接口: 查询变体图片组合
私有应用是否可用: 是
read_customers
权限点描述: 查询客户、客户地址、订单历史记录和客户组
相关接口: companyCredit
私有应用是否可用: 是
read_store_metrics
权限点描述: 商品指标、交易指标、访客行为等数据
相关接口: customerSegment
私有应用是否可用: 是
read_products
权限点描述: 查询商品、商品变种及分类
相关接口: 查询单个商品的所有款式数量、根据 ID 查询手动分类属性、查询手动分类数量、查询智能分类数量、批量查询手动分类、查询单个商品分类关系、批量查询分类关系、查询分类关系数量、资源反馈列表、查询单个商品所有款式、查询单个 商品款式、查询单个商品的图片数量、查询某个分类下商品信息、根据 ID 查询分类信息、根据 ID 查询智能分类属性、批量查询智能分类、查询商品款式在各市场的价格、查询商品在各市场的价格范围、查询商品在市场的发布状态、检索公司地点目录、指定目录变体查询定价规则、查询目录地点、查询市场发布的商品列表、添加公司地点、查询目录地点(推荐)、批量查询分类树子节点、查询分类树节点、查询店铺所有分类树节点
私有应用是否可用: 是
read_inventory
权限点描述: 查询库存地点、库存内商品信息
相关接口: 批量查询地点库存数量、查询单个库存单位、批量查询库存单位
私有应用是否可用: 是
read_draft_orders
权限点描述: 查看商家代表客户创建的订单
相关接口: 草稿单数量查询
私有应用是否可用: 是
read_gift_card
权限点描述: 查询礼品卡代码、配置信息
相关接口: 查询单个礼品卡、查询礼品卡数量、获取礼品卡操作记录
私有应用是否可用: 是
read_store_information
权限点描述: 查询当前账户语言、店铺信息
相关接口: 查询店铺支付渠道、查询店铺信息
私有应用是否可用: 是
read_store_log
权限点描述: 查询店铺日志信息
相关接口: 查询店铺操作日志总数
私有应用是否可用: 是
write_product_sizechart
权限点描述: 编辑商品尺码信息
相关接口: 批量删除尺码、创建尺码、更新尺码
私有应用是否可用: 是
read_shipping
权限点描述: 查询承运商信息、地点税费等
相关接口: 查询库存地址、查询所有到店取货信息、查询所有本地配送信息、查询店铺已配置税费的国家数量、查询指定国家的税费信息、查询店铺所有的税费信息、查询某个国家下所有州省的数量、查询指定国家下所有的州省信息、查询州省信息、获取承运商列表、获取指定承运商服务
私有应用是否可用: 是
read_page
权限点描述: 查询页面、自定义页面信息
相关接口: 统计自定义页面页数、查询自定义页面
私有应用是否可用: 是
write_price_rules
权限点描述: 编辑价格规则的配置信息
相关接口: 删除现有价格规则、更新折扣码活动规则
私有应用是否可用: 是
write_files
权限点描述: 编辑店铺内容维护的多媒体资源
相关接口: 删除文件、初始化文件分段上传任务
私有应用是否可用: 是
write_shipping
权限点描述: 编辑承运商信息、地点税费等
相关接口: 创建承运商服务、更新承运商服务、删除承运商服务、批量设置运费方案、批量设置运费方案V2
私有应用是否可用: 是
write_payment_gateways
权限点描述: 编辑支付应用的相关信息
相关接口: 退款成功通知、商户激活成功通知、设备绑定成功通知、付款成功通知
私有应用是否可用: 否
read_markets
权限点描述: 市场的基本信息
相关接口: 通过ID查询市场资源、查询市场列表
私有应用是否可用: 是