Get started

Scopes

What each access lets an app read and change.

An app gets only the scopes the seller ticks. write_* always includes read_*. A call outside the app's scopes answers 403 with the code insufficient_scope and the missing scope in param. Account security (passwords, sessions, store owners) is never open to apps.

Catalog

Scope	Lets the app
`read_products`	See products, variants, prices and categories.
`write_products`	Add, change and delete products. Includes read.
`read_inventory`	See stock levels and adjustments.
`write_inventory`	Change stock counts. Includes read.
`read_files`	See uploaded images and digital files.
`write_files`	Upload files and attach them to products. Includes read.

Sales

Scope	Lets the app
`read_orders`	See orders, buyers on them, payments state and fulfilments.
`write_orders`	Create orders, mark fulfilled, cancel and refund. Includes read.
`read_checkouts`	See checkouts and abandoned checkouts.
`write_checkouts`	Change checkout settings such as shipping. Includes read.
`read_customers`	See customers and their consent to messages.
`write_customers`	Add and change customers. Includes read.
`read_discounts`	See discount codes.
`write_discounts`	Create, change and end discount codes. Includes read.

Online store and pages

Scope	Lets the app
`read_pages`	See payment pages and their A/B tests.
`write_pages`	Create, edit, publish and test payment pages. Includes read.
`read_themes`	See the store theme and its settings.
`write_themes`	Change and publish the theme. Includes read.
`read_domains`	See connected domains.
`write_domains`	Connect and remove domains. Includes read.

Store

Scope	Lets the app
`read_store`	See the store name, policies, taxes and ad pixels.
`write_store`	Change store settings, policies, taxes and ad pixels. Includes read.
`read_webhooks`	See webhook subscriptions and deliveries.
`write_webhooks`	Add webhooks and resend deliveries. Includes read.

Insights (read only)

Scope	Lets the app
`read_payments`	See payment attempts, failure causes and payouts.
`read_analytics`	See visits, funnels, journeys and heatmaps.