Scopes are permissions that identify the scope of access your application requests from the user. Below you can see the names of access scopes that exist in Ecwid API and their description.
Each application has a specified set of access scopes that are required for this application. If you specify additional scopes, that exceed the specified ones for the app in Ecwid, you will see an error message. So if you need to add more access scopes - please contact us to update your app.
| Access scope | Notes |
|---|---|
| read_store_profile | Get store name and general settings, get store admin email, get updates statistics etc. Requested in all cases even if not specified |
| update_store_profile | Set taxes, update invoice logo, change Starter Site domain, close store for maintenance, etc. |
| read_store_limits | Get store limits and restrictions, e.g. maximum number of available products. |
| read_catalog | Search products, get product options/variations etc. Also allows receiving push updates (webhooks) about changes in-store products. |
| update_catalog | Update product prices, upload images, and e-goods, modify product attributes, delete products and categories, etc. |
| create_catalog | Create new products |
| read_orders | Get sales for a given period, retrieve order details, etc. Also allows receiving push updates (webhooks) about changes in-store orders. |
| update_orders | Change order totals, switch order status, cancel orders, delete orders, etc. Requires read_orders scope to function |
| create_orders | Place a new order in the store |
| read_customers | Search customers or retrieve some particular customer data |
| update_customers | Change customer profile data, add items to the customer address book, delete customers, etc. |
| create_customers | Add a new customer to the store's Customers list |
| read_discount_coupons | Get the list of discount coupons or retrieve some particular coupon details |
| update_discount_coupons | Change the coupon expiration date or limit its number of use, update coupon code, delete coupon codes, etc. |
| create_discount_coupons | Add a new discount coupon |
| customize_storefront | Attach a custom JS/CSS to the storefront on the fly to modify its look and feel (see Customize appearance) |
| add_to_cp | Add a new tab to merchant control panel (see Embedding apps) |
| add_shipping_method | Add a new shipping method to the store (see Add shipping method) |
| add_payment_method | Add a new payment method to the store (see Add payment method) |
| public_storefront | Get public store details with the public access token |
| customize_cart_calculation | Apply custom discounts to orders in real-time (See Add custom discount) |
| read_invoices | Get the invoices. Allows receiving push updates (webhooks) about creating and deleting store invoices. |
| charge | Charge through Ecwid billing. Required for the Charge requests via an app. |
| read_store_stats | Get a store's statistic information |
| read_staff | Get information about staff accounts in a store |
| invite_staff | Send and resend staff account invites |
| delete_staff | Revoke sent invitation and delete staff account |
| read_subscriptions | Allows to get information about subscriptions |
| update_subscriptions | Allows update the details of subscriptions |
| read_brands | Allows to search product brands |