AccessScope resources are used by merchants to authorize apps.

Each permission point is associated with a series of Open APIs. Through these Open APIs, apps can access or edit store data.

This document lists the currently available AccessScope permission points on the platform and their associated interfaces.

You should determine which permissions to apply from the merchant when installing or updating the app based on your actual needs.

For example, if an app needs to query the merchant’s order information during use, it needs to request the read_orders permission from the merchant during installation.

After merchant authorization, SHOPLINE will return an access token containing AccessScope information. When the app makes a request with the access token, only interfaces that meet the scope of the AccessScope can be successfully returned.

AccessScope​

read_location​

Permission point description: Access locations and logistical setups
Related interface: Based on id query location、Query location list、Statistics number of locations
Apply to private application: true

read_customers​

Permission point description: Manage customers, customer addresses, order history, and customer groups
Related interface: companyCredit
Apply to private application: true

write_shipping​

Permission point description: Modify shipping service provider settings and local tax fees
Related interface: Create a new CarrierService、Modify an existing CarrierService、Remove an existing CarrierService、Batch shipping plan、Batch shipping plan V2
Apply to private application: true

read_files​

Permission point description: Manage store information and manage multimedia resources
Related interface: View individual files、Batch query files
Apply to private application: true

read_subscription_contracts​

Permission point description: Access subscription contracts and payment tools
Related interface: Query subscription contract details、Query subscription contract list
Apply to private application: false

read_orders​

Permission point description: Access orders, transactions, fulfillments, and abandoned checkouts
Related interface: Query abandoned order、Query store settlement currency、Query order risk fraud list、Query risk fraud for order specify、Retrieves a count of checkouts、Order quantity query、Retrieves a list of transactions、Query all refund orders for the id association、Query order specify of your money back order、Query orders
Apply to private application: true

read_payment​

Permission point description: Access payment and account balances
Related interface: Balance、Payouts、Payout、Balance transactions、Query store transaction records
Apply to private application: true

read_markets​

Permission point description: Access market information
Related interface: Query markets、Returns a market resource by ID、Query market list
Apply to private application: true

write_price_rules​

Permission point description: Modify conditional discounts
Related interface: Delete existing price rule、Update existing price rule
Apply to private application: true

write_checkouts​

Permission point description: Manage checkouts
Related interface: Query tax channel、Update tax channel、Delete tax channel
Apply to private application: true

read_discounts​

Permission point description: Manage automatic discounts and discount codes
Related interface: appDiscountType
Apply to private application: true

write_page​

Permission point description: Modify page and custom messaging
Related interface: Delete custom pages、Add custom pages、Update custom page
Apply to private application: true

read_store_staff​

Permission point description: Query staff information based on store（Only for Enterprise store）.
Related interface: staffMembers
Apply to private application: true

write_product_variant_images​

Permission point description: Write Variant Images
Related interface: batch update variant images
Apply to private application: true

read_content​

Permission point description: Access articles, blogs, and comments, and redirect traffic
Related interface: Query blog collection list、Query list of all articles authors、Query blog post、Query blog collection quantity、Query single blog collection、Get theme list in bulk、Query one theme、By reviewing id query comments、Number of get the comments、Query list of comments、Query blog post details、Query blog post list
Apply to private application: true

read_draft_orders​

Permission point description: Manage the orders that merchants created for customers
Related interface: Draft order quantity query、Query draft order
Apply to private application: true

read_shipping​

Permission point description: Access shipping information and local tax rates
Related interface: Query inventory address、Query all pickup information、Query all local shipping information、Query country number of tax already configured in stores、Query specify tax information from the country、Query all tax information in the store、Query quantity of all state provinces in a country、Query specify all state province information under the country、Query state province information、Receive a list of all CarrierServices、Receive a single CarrierService
Apply to private application: true

read_gift_card​

Permission point description: Access gift cards and coupon codes
Related interface: Query single gift card、Query number of gift cards、Paging query gift card、Get gift card operation records
Apply to private application: true

read_store_log​

Permission point description: Query store log information
Related interface: Operation inquiries based on log ID、Full inquiries list of store operation log、Query the total number of store operation logs
Apply to private application: true

read_product_sizechart​

Permission point description: Read Product Sizechart
Related interface: Query product size data in batch
Apply to private application: true

read_data_report​

Permission point description: Report user identity, attributes and events
Related interface: Report buyer identity、Report buyer behavior events
Apply to private application: true

read_store_information​

Permission point description: Access account langauge and store information
Related interface: Query store payment channels、Query store information
Apply to private application: true

read_selling_plan_group​

Permission point description: Access selling plan group
Related interface: Query sales program group details、Query multiple selling programs、Get the sales plan group total number
Apply to private application: false

write_store_information​

Permission point description: Modify store information and langauge
Related interface: Add store language settings
Apply to private application: true

read_themes​

Permission point description: Access themes, theme templates, and assets
Related interface: Query theme asset list、Query theme asset details
Apply to private application: true

write_url_route​

Permission point description: Write URL routing structure of the online store
Related interface: Update URL routing
Apply to private application: true

read_page​

Permission point description: Access page
Related interface: Count the number of custom pages、Get a custom page list、Query page's detail information
Apply to private application: true

write_subscription_contracts​

Permission point description: Modify subscription contracts and payment methods
Related interface: Skip the next bill、Create your order as soon as your subscription contract is created、Revise next bill time、Cancel subscription contract、Edit subscription contract information
Apply to private application: false

write_discounts​

Permission point description: Modify automatic discounts and discount codes
Related interface: discountAutomaticDoniUpdate
Apply to private application: true

read_publications​

Permission point description: Query a set of products published in the APP
Related interface: publications
Apply to private application: true

read_fulfillment_service​

Permission point description: Contact relevant staff of the fulfillment service provider
Related interface: Fulfillment service details、Fulfillment service list
Apply to private application: true

write_draft_orders​

Permission point description: Modify orders created by merchants on behalf of customers
Related interface: Send invoice link、Delete draft order、Create draft order、Edit draft order、Complete draft order
Apply to private application: true

write_customers​

Permission point description: Modify customer information, customer addresses, order history, and customer groups
Related interface: companyLocationAssignAddress
Apply to private application: true

write_products​

Permission point description: Modify products, variants, and collections
Related interface: Delete manual collection、Delete intelligent collection、Delete product、Create binding relationship、Delete binding relationship、Delete SKU、Resources feedback、Create SKU、Update SKU by ID、Update Product images、Delete Product images、Create Product images、Update product、Update Product Sorting in Smart Collections、Create manual collection、Create smart collection、Update smart collection、Update manual collection、Create a company location catalog、Update a company location catalog、Delete catalog、Separate pricing for catalog variants、Add catalog products、Remove catalog products、Create product、Add products to the market、Remove market products、Remove company locations
Apply to private application: true

write_content​

Permission point description: Modify articles, blogs, and comments, redirect traffic
Related interface: Delete blog post、Update blog collection、Delete blog collection、Update theme、Delete theme、Get a list of redirect、Query single redirect details、Statistical redirect quantity、Update redirect、Remove a redirect、Create a comment、Update comments、Approve the comment、Labeled comments as non spam、Labeled comments as spam、Delete a comment、Comment for recovery delete、Create a blog collection、Create blog articles for the collection、Update blog post、Create a redirect
Apply to private application: true

write_shop_policy​

Permission point description: Modify shop policy
Related interface: Update a store policy page
Apply to private application: true

write_translation​

Permission point description: Modify translated content
Related interface: translationsRegister
Apply to private application: true

read_marketing_event​

Permission point description: Access and create marketing event
Related interface: Query individual marketing events、Query number of marketing events、Query marketing events list
Apply to private application: true

write_fulfillment_service​

Permission point description: Edit fulfillment service information
Related interface: Create fulfillment location、Create fulfillment service、Modify fulfillment service、Delete fulfillment service
Apply to private application: true

read_returns​

Permission point description: Access returns and return orders
Related interface: Query Return Fulfillment Order、Query Return Fulfillment、Query returns
Apply to private application: true

read_shop_policy​

Permission point description: Access shop policies
Related interface: Query policy page information
Apply to private application: true

write_marketing_event​

Permission point description: Edit marketing events
Related interface: Process Statistics Synchronization、Create marketing events、Update marketing events、Delete marketing events、Create marketing expansion、Update marketing expansion、Create campaign summary data、Mass sync marketing event statistics
Apply to private application: true

write_product_listings​

Permission point description: Manage product lists
Related interface: Remove collection from sales channels、Query sales channels specify collection Product id、Remove from sales channels Product、Add Product to sales channels、Add collection to sales channels
Apply to private application: true

write_orders​

Permission point description: Modify orders, transactions, fulfillments, and abandoned checkouts
Related interface: Update tracking number、Update payment slip、Query payment settings、Delete all risk fraud related to the order、Add risk fraud、Remove the specify of the order risk fraud、Update order risk fraud、Order refund trial、Order refund、Create payment slip、Order shipped、Cancel shipping、Order archive、Cancel order archive、Start editing、Set item quantity、Add a custom product、Submit edit results、Add items in order、Add product discount、Delete product discount、Create an order、Update order、Cancel order、Delete an order、Abandoning and archiving
Apply to private application: true

write_bulkoperation​

Permission point description: Manage bulkoperation
Related interface: Bulk operation mutation（Deprecated）、Bulk operation query、Batch mission update ( generic )、Bulk mission cancellation
Apply to private application: true

read_product_variant_images​

Permission point description: Read ProductVariant Images
Related interface: query Images of variant
Apply to private application: true

write_inventory​

Permission point description: Modify inventory and related messages across multiple locations
Related interface: Update inventory status、Set inventory status、Connect stock status、Disconnect stock status、Update inventory object
Apply to private application: true

write_assigned_fulfillment_orders​

Permission point description: Manage assigned fulfillment orders
Related interface: Set up a fulfillment order deadline、Update inventory location for fulfillment order、Re-book the date of the sale、Fulfillment order release onhold status、Performance appointment marker onhold、Update fulfillment tracking information、Create an fulfillment for the fulfillment order ( single or batch )、Cancel fulfillment、Fulfillment app rejects shipment cancellation request、Fulfillment app accepts cancellation request for shipment、Fulfillment app rejects shipment request、Fulfillment app accepts request to ship、Ship according to fulfillment order request、Delete fulfillment delivery logistics event、Create fulfillment shipping logistics event
Apply to private application: true

read_price_rules​

Permission point description: Access pricing and allocations
Related interface: Retrieve all price rules counts、Retrieve individual price rules
Apply to private application: true

read_bulkoperation​

Permission point description: Access bulk operations and status
Related interface: Query active tasks in current stores
Apply to private application: true

write_return​

Permission point description: Modify returns and return fulfillments
Related interface: Close Return、Create a Return、Create a Return Fulfillment、Update logistics information for a Return Fulfillment
Apply to private application: true

write_markets​

Permission point description: Modify market information
Related interface: Market Currency Update
Apply to private application: true

read_url_route​

Permission point description: Query URL routing structure of the online store
Related interface: Query URL routing
Apply to private application: true

write_payment_gateways​

Permission point description: Modify payment gateways
Related interface: Refund successful notification、Merchant activation successful notification、Device binding success notification、Payment successful notice
Apply to private application: false

read_assigned_fulfillment_orders​

Permission point description: Access assigned fulfillment orders and logistics tracking
Related interface: Get specify fulfillment order、Query number of fulfillment、Get all of the order-placed fulfillment order、Get all fulfillments for the fulfillment order、Get specify fulfillment under fulfillment order、Fulfillment app requests shipment cancellation、Fulfillment order list query、Query fulfillment and delivery logistics events、Query all fulfillments for an order
Apply to private application: true

write_files​

Permission point description: Modify store information and manage multimedia resources
Related interface: Create File、Update Files、Delete Files
Apply to private application: true

write_product_sizechart​

Permission point description: Write product sizechart
Related interface: Batch delete sizechart、Create a size chart、Update a size chart
Apply to private application: true

read_translation​

Permission point description: Access translation
Related interface: translatableResources
Apply to private application: true

read_product_listings​

Permission point description: Access product entries
Related interface: Query Product id for sales channels、Query Product total number for sales channels、Query Product of sales channels、Query specify Product for sales channels、Query collection of sales channels、Query specify collection in sales channels、Retrieve a list of company location catalogs、Get catalog products
Apply to private application: true

read_script_tags​

Permission point description: Access the JavaScript code in storefront or orders status pages
Related interface: Query script tag list、Query a single script tag、Query the number of script tags
Apply to private application: true

write_selling_plan_group​

Permission point description: Modify selling plan group
Related interface: Add Product to sales plan group、Tie-downs from the sales plan group Product、Delete sales plan group、Create a sales plan group、Update sales plan group
Apply to private application: false

write_gift_card​

Permission point description: Modify gift card codes and related messages
Related interface: Disable gift card、Create gift cards、Update gift card
Apply to private application: true

read_pos​

Permission point description: Access POS
Related interface: Query store list
Apply to private application: false

write_script_tags​

Permission point description: Modify JavaScript codes in storefront or orders status pages
Related interface: scriptTagCreate
Apply to private application: true

write_publications​

Permission point description: Manage a set of products published by the app.
Related interface: publishablePublishToCurrentChannel
Apply to private application: true

read_products​

Permission point description: Access products, variants, and collections
Related interface: Batch query product quantity、Query all SKUs quantity of single product、Query manual collection attributes by ID、Batch query manual collection quantity、Batch query intelligent collection quantity、Batch query manual collection、Single query collection relationship、Batch query collection relationship、Batch query collection relationship quantity、List of resources feedback、Bulk query products、Query single product、Query all SKUs of single product、Query SKU by ID、Query single Product image、Batch query Product images、Query main image total number for single Product、Query product information in a certain collection、Query collection information by ID、Query intelligent collection attributes by ID、Batch query intelligent collection、Query the market price of the variant、Query the market price ranges of the product、Query the market published of the product、Retrieve a company location catalog、Specify variant for pricing rules、Get catalog locations、Get markets published products、Add company locations、Get catalog locations (recommended)
Apply to private application: true

read_inventory​

Permission point description: Access inventory across multiple locations
Related interface: Batch query inventory status、Get a single inventory object、Batch query inventory object
Apply to private application: true

write_themes​

Permission point description: Modify themes, theme templates, and assets
Related interface: Create / modify theme asset、Delete theme asset、Create theme、Batch create/modify asset content
Apply to private application: true

read_store_metrics​

Permission point description: Access store metrics, transactions, customer behavior
Related interface: customerSegment
Apply to private application: true

Unanthenticated AccessScope​

unauthenticated_read_checkouts_info​

Permission point description: Access product sales and checkout info via Storefront
Related interface: checkout
Apply to private application: true

unauthenticated_write_message​

Permission point description: Create business sessions, initiate meetings, etc.
Related interface: messageSend
Apply to private application: true

unauthenticated_write_cart​

Permission point description: Modify shopping carts via Storefront
Related interface: cartItemSelect
Apply to private application: true

unauthenticated_write_checkouts_info​

Permission point description: Update checkout info via Storefront
Related interface: checkoutShippingAddressUpdate
Apply to private application: true

unauthenticated_write_customer_information​

Permission point description: Modify customer information and address via Storefront
Related interface: customerAccessTokenCreate
Apply to private application: true

unauthenticated_read_cart​

Permission point description: Access shopping cart data via Storefront
Related interface: cartItemSelect
Apply to private application: true

unauthenticated_read_message​

Permission point description: Read business information list
Related interface: messageQuery
Apply to private application: true