Zid Docs
Apps
ThemesPayments
Apps
ThemesPayments
Help Center
Slack
  1. Build an app
  • πŸ—‚οΈ Overview
  • πŸš€ Start Here
  • Create your First App
  • Responses
  • Rate Limiting
  • Embedded Apps
  • StoreFront Events
  • Zid MUI
  • Zid SDKs
  • Our custom MCP server
  • Zid AI Agent Skill
  • Authorization
    • Authorization
    • Public Apps OAuth Requirements
    • OAuth Errors & Troubleshooting
    • Zid Bridge Tool
  • Merchant APIs
    • Account
      • Me
        • Me
      • Store
        • Store
        • Branding
        • Localization
        • Social
        • Operations
        • Business
        • Upload Logo Image
        • Delete Logo Image
        • Upload Icon Image
        • Delete Icon Image
        • Upload Cover Image
        • Delete Cover Image
    • Orders
      • Order Tags
        • List Order Tags
        • Create Order Tag
      • Validate Order Request
      • Create Order
      • Change Order Status
      • Add Order Comment
      • View Order
      • List Orders
      • List Custom Order Statuses
      • List Order Credit Notes
      • Get Orders Highlights
      • Order Fulfillment Inventories
      • Bulk Create/Update Custom Order Statuses
    • Reverse Orders
      • Create Reverse Orders
      • Create Reverse Orders Waybill
      • Add Reverse Order Reasons
      • List Reverse Reasons
      • Calculate Reverse Totals
      • Create refund for reverse order
      • Upload bank transfer receipt
      • Update return products
      • Order Details – View for Return
    • Abandoned Carts
      • List Carts
      • View Cart
      • Validate Abandoned Cart Messages
      • Send Abandoned Cart Notification Manually
    • Products
      • Managing Products
        • Create Product Types
        • Create Product
        • List Products
        • View Product
        • List Product Settings
        • Update Product
        • Bulk Update Products
        • Delete Product
      • Digital Vouchers
        • List Vouchers
        • Order Vouchers
        • Create Voucher
        • Import Vouchers
        • Export Vouchers
        • Update Voucher
        • Remove Voucher
      • Product Categories
        • List Categories
        • View Category
        • Create Category
        • Create Subcategory
        • Update Category
        • Assign Product to Category
        • Bulk Assign Products to Category
        • Publish Category
        • Detach Category from All Products
        • Remove Product from Category
        • Set Categories Nesting
        • Delete Category Cover Image
        • Upload Category Cover Image
        • Delete Category
        • Delete Category Image
        • Upload Category Image
        • Update Category
      • Product Brands
        • List Brands
        • Single Brand
      • Product Badge
        • List Badges
      • Product Attributes
        • List Attributes
        • View Attribute
        • Create Attribute
        • Update Attribute
        • Delete Attribute
      • Product Attribute Presets
        • List Presets
        • Create Preset
        • Update Preset
        • Delete Preset
      • Product Variants
        • Create Variants
        • Create Custom Option
        • Update Custom Option
        • Delete Custom Option Field
        • Create Custom Input Field
        • Update Custom Input Field
        • Delete Custom Input Field
      • Product Sorting
        • Set Manual Product Order
        • Reset Manual Product Order
      • Product Images
        • List Images
        • Upload Image
        • Update Image Order
        • Delete Image
      • Product Availability Notifications
        • Notification Stats
        • Noticiation Settings
        • List Notifications
        • Create Notification
        • Update Settings
        • Send Notification Email
        • Export Notifications
      • Product Export
        • Email All Products to Store Owner
        • Import Products via CSV or xlsx File
      • Product Stock
        • Retrieve Product Stock
        • List Product Stock Records
        • Create Product Stock
        • Update Product Stock
        • Bulk Update Product Stock Records
      • Product Questions & Answers
        • Retrieve Product Question
        • Retrieve Product Answer
        • List Product Questions
        • List Answers for Question
        • Create Product Question
        • Create Product Answer
        • Update Product Question
        • Update Product Answer
        • Delete Product Question
        • Delete Product Answer
        • List Store Product Questions
      • Product Reviews
        • List Reviews
        • Count Reviews
      • Digital Products
        • Create Downloadable Product
        • Generate Upload URL
        • Upload File to S3
        • Create Product Downloadable
        • Get Product Downloadables
        • Delete Product Downloadable
        • List Store Downloadables
        • Create Store Downloadable
        • Delete Store Downloadable
    • Inventories
      • Create Location
      • Update Location
      • Update Product Stock for Location
      • List Locations
      • View Location
    • Shipping
      • List Store Shipping Methods
    • Marketing
      • Coupons
        • List Coupons
        • View Coupon
        • Create Coupon
        • Generate Bulk Coupons
        • Duplicate Coupon
        • Duplicate Bulk Coupons
        • Update Coupon Note
        • Update Coupon
        • Update Bulk Coupons
        • Update Coupon Status
        • Update Bulk Coupons Status
        • Delete Coupon
        • Delete Bulk Coupons
      • Bundle Offers
        • List Bundle Offers
        • View Bundle Offer
        • Create Bundle Offer
        • Update Bundle Offer
        • Delete Bundle Offer
        • Bulk Delete Bundle Offers
      • Loyalty Program
        • Loyalty Program Status
        • Loyalty Program Details
        • Loyalty Program Info
        • Customer Loyalty Summary
        • Customer Points History
        • Activate Loyalty Program
        • Set Points Expiration Rules
        • Update Cashback Rule
        • Create Points Redemption Method
        • Update Points Redemption Method
        • Delete Points Redemption Method
        • Adjust Customer Points
        • Update Redemption Method Status
        • Loyalty Program Analytics
        • Loyalty Program Settings
      • Customer Wallets
        • Cashback Rules
          • List Cashback Rules
          • Create Cashback Rule
          • Retrieve Cashback Rule
          • Update Cashback Rule
          • Delete Cashback Rule
        • Wallet Analytics
          • Get Wallet Analytics
          • Get Wallet Analytics by Rule
        • Manager Customer Wallet
          • List Customer Wallets
          • Bulk Credit Customer Wallets
          • Bulk Debit Customer Wallets
          • Export Customer Wallets
          • Get Customer Wallet Balance
          • Credit Customer Wallet
          • Debit Customer Wallet
          • Customer Pending Cashbacks
          • Customer Wallet Transactions
    • Customers
      • Customer Tags
        • List Customer Tags
        • Add Customer Tag
        • Ω’Update Customer Tag
        • Delete Customer Tag
      • Customer Portal Tickets
        • List Customer Portal Tickets
        • Customer Portal Ticket Detail
      • List Customers
      • View Customer
      • Primary Customer List
      • FInd Customer By Phone Number
      • Customer Profile
      • Add Customer
      • Update Customer
      • Delete Customer
      • Add Bulk Customers
      • Import Customers
    • Store Settings
      • πŸ“„ User Roles and Permissions
      • Retrieve Store Manager Profile
      • Retrieve VAT Settings
      • List Payment Methods
      • List Store Operating Countries
      • OneSignal Store Settings
      • Create or Update OneSignal Store Settings
      • Get Payment Options
    • Countries and Cities
      • List Countries
      • List Cities for Country
    • Blogs
      • Settings
        • Create
        • List
      • Categories
        • Create
        • List
        • Bulk Activate
        • Bulk Deactivate
        • Bulk Delete
        • Retrieve
        • Destroy
        • Partial Update
        • Bulk Add To Posts
        • Bulk Remove From Posts
        • Bulk Delete Blog Categories
      • Posts
        • Media
          • List
          • Create
          • Destroy
        • Create
        • List
        • Retrieve
        • Partial Update
        • Destroy
        • Archive
        • Publish
        • Bulk Archive
        • Bulk Publish
        • Bulk Delete
        • Export Posts
        • Import Template
        • Import Posts
      • Tags
        • Create
        • List
        • Retrieve
        • Partial Update
        • Destroy
        • Bulk Delete Tags
        • Bulk Add To Posts
        • Bulk Remove From Posts
      • Storefront
        • Posts
          • List
          • Retrieve
        • Categories
          • List
          • Retrieve
        • Tags
          • List
  • Webhooks
    • Overview
    • Webhook Health Tracking
    • Events
      • Order
      • Product
      • Abandoned Cart
      • Customer
      • Product Category
    • APIs
      • Health Summary
      • Broken Webhooks
      • Recover Broken Webhooks
      • List Webhooks
      • Create Webhook
      • Delete Webhook
      • Delete Webhook By subscriber
  • App Management
    • Events
    • APIs
      • Subscription Details
      • Update Usage-Based Charges
  • Build an app
    • Justifying your scopes
    • Submitting your app for review
    • Plans & billing
      • Plans and pricing
      • Creating a plan
      • Usage-based plans
      • Private plans
      • Subscription and app events
  1. Build an app

Justifying your scopes

A scope is a permission your app asks a merchant to approve. When you submit your app, Zid reviews every scope you selected against what your app actually does.
Every scope you request must be used by a feature in your app.
If you select a scope your app does not use β€” no feature needs it, no endpoint calls it β€” your app will be rejected.

Where you write your reason#

In the Partner Dashboard, in your app's Scopes section, there is a description field below the scope list. Write your reason there before you submit.
How manyOne description covering your whole selection
LengthBetween 50 and 200 characters
RequiredYes β€” you cannot submit without it
It is short on purpose. Name the features, not the scopes.

What a good reason looks like#

A reviewer is checking one thing: does each scope you selected connect to something your app actually does?
Good
Syncs orders and customers to the merchant's CRM, and creates discount coupons for abandoned-cart recovery emails.
Three scopes are implied and each is tied to a real feature.
Too vague β€” expect questions or rejection
Our app needs these permissions to work properly and give merchants the best experience.
It names no feature, so a reviewer cannot match it to anything.
A common mistake
Full access so we can add more features later.
Request scopes when you build the feature, not before. You can add a scope later β€” see Adding a scope after launch below.

Scopes that always need a clear reason#

All scopes are reviewed, but these get the closest look because of what they expose. If you request one, make sure your description names the feature that uses it.

Customer and merchant personal data#

Covered by Saudi Arabia's Personal Data Protection Law. You are responsible for how you store and use anything you read.
Scope groupWhy it is sensitiveYour reason should show
CustomersNames, phone numbers, emails, addressesWhich feature needs customer records, and what you do with them
OrdersCustomer details plus purchase historyWhy order data must leave the store
Abandoned CartsContact details of people who did not buyThe exact recovery feature, and how merchants control it
Account, Account IdentityThe merchant's own account and identity detailsWhy your app needs the merchant's identity, not just their store
Customer WalletCustomer balances and transactionsThe wallet feature you provide
Customer ReferralsCustomer relationships and referral dataThe referral feature you provide

Money and pricing#

Scope groupWhy it is sensitiveYour reason should show
CouponsCreates discounts that cost the merchant moneyWhat creates coupons, and what limits it
Bundle OffersChanges pricing shown to shoppersThe offer feature you provide
LoyaltyIssues and spends loyalty valueThe loyalty feature you provide
Order CreateCreates real orders on the storeWhere the orders come from
PaymentsReads which payment methods are enabledWhy your app needs to know

Code and content on the storefront#

Scope groupWhy it is sensitiveYour reason should show
Extra AddonsAdds JavaScript that runs on the merchant's storefrontWhat the script does, and what it sends anywhere else
CatalogChanges what shoppers see in the storeWhich part of the storefront your app changes

Store configuration#

Scope groupWhy it is sensitiveYour reason should show
Store Core Details, Store Business DetailsStore and business settingsWhich settings your app reads or changes, and why
Store DomainThe store's domainWhy your app needs domain access
Languages & CurrenciesHow prices and content are shownThe feature that depends on it

Data delivery#

Scope groupWhy it is sensitiveYour reason should show
WebhooksSubscribes your app to a stream of store dataWhich events you subscribe to and why

Read or read & write#

Each group has an access level. Ask for read when your app only needs to see the data. Requesting read & write when your app never changes anything is one of the most common reasons a scope gets questioned.

Adding a scope after launch#

You can change your scopes later, and Zid reviews the change the same way. Merchants who already installed your app must approve the new permission before it works β€” until they do, calls needing it fail with 403, and your app should prompt them to reauthorize.
This is why requesting scopes early "just in case" does not help: it costs you installs now and saves you nothing later.

Before you submit#

Every scope you selected is used by a feature that exists today
You removed any scope left over from an earlier version of your app
You chose read rather than read & write wherever your app only reads
Your description names the features, not the scopes
Your description is between 50 and 200 characters
Modified atΒ 2026-10-21 15:16:30
Previous
Update Usage-Based Charges
Next
Submitting your app for review
Built with