Skip to content
biticaretdevelopers

Reference

Scopes

The scopes an app can request and the descriptions shown to the store on the consent screen.

This page is generated from the source code. Apps request scopes in access_scopes.scopes; at install time the store owner sees these descriptions on the consent screen.

read_companies

View companies, their locations and their buyers; access the buyer's company during checkout.

Example

toml
[access_scopes]
scopes = ["read_companies"]

read_company_tax_ids

View the unmasked 11-digit tax number (Turkish national ID) of sole proprietorships.

Example

toml
[access_scopes]
scopes = ["read_company_tax_ids"]

read_customers

View customers. Access to names and contact details depends on the app's customer data level.

Example

toml
[access_scopes]
scopes = ["read_customers"]

read_draft_orders

View draft orders, their line items and their totals.

Example

toml
[access_scopes]
scopes = ["read_draft_orders"]

read_gift_cards

View gift cards and their balances (excluding card codes).

Example

toml
[access_scopes]
scopes = ["read_gift_cards"]

read_inventory

View stock quantities at each location.

Example

toml
[access_scopes]
scopes = ["read_inventory"]

read_locations

View inventory locations.

Example

toml
[access_scopes]
scopes = ["read_locations"]

read_marketing_audience

View customers who consented to marketing (email or phone, name, language, consent date and source) and receive updates when consent is granted or withdrawn. Customers without consent or with erasure requests are excluded.

Example

toml
[access_scopes]
scopes = ["read_marketing_audience"]

read_metaobjects

View custom data (metaobject) definitions and their entries.

Example

toml
[access_scopes]
scopes = ["read_metaobjects"]

read_orders

View orders, refunds, fulfillments and checkouts in progress.

Example

toml
[access_scopes]
scopes = ["read_orders"]

read_product_costs

View product variant unit costs.

Example

toml
[access_scopes]
scopes = ["read_product_costs"]

read_products

View products, variants, total stock and collections.

Example

toml
[access_scopes]
scopes = ["read_products"]

read_translations

View translations of products, collections, pages and menus.

Example

toml
[access_scopes]
scopes = ["read_translations"]

write_channels

Open its own sales channel, publish products on it and create orders from it.

Example

toml
[access_scopes]
scopes = ["write_channels"]

write_checkout_functions

Add shipping options and fees to checkout, and hide or reorder payment methods.

Example

toml
[access_scopes]
scopes = ["write_checkout_functions"]

write_companies

Create, update and delete companies, company locations and buyers.

Example

toml
[access_scopes]
scopes = ["write_companies"]

write_customers

Add tags to customers.

Example

toml
[access_scopes]
scopes = ["write_customers"]

write_discounts

Create, update and delete discount codes; apply automatic discounts in checkout.

Example

toml
[access_scopes]
scopes = ["write_discounts"]

write_draft_orders

Create, update, delete and complete draft orders.

Example

toml
[access_scopes]
scopes = ["write_draft_orders"]

write_emails

Send emails to the store's buyers through the platform: the platform controls the sender and reply-to addresses, and the store's email limits apply.

Example

toml
[access_scopes]
scopes = ["write_emails"]

write_fulfillments

Create fulfillments and update their tracking details.

Example

toml
[access_scopes]
scopes = ["write_fulfillments"]

write_gift_cards

Issue gift cards, update notes and expiry dates, and disable or re-enable cards.

Example

toml
[access_scopes]
scopes = ["write_gift_cards"]

write_inventory

Update stock quantities at each location and transfer stock between locations.

Example

toml
[access_scopes]
scopes = ["write_inventory"]

Withdraw customers' marketing consent; record new consent with the wording and timestamp the customer agreed to.

Example

toml
[access_scopes]
scopes = ["write_marketing_consent"]

write_metaobjects

Create, update and delete custom data definitions and entries; can alter storefront content.

Example

toml
[access_scopes]
scopes = ["write_metaobjects"]

write_orders

Add notes and tags to orders and cancel orders.

Example

toml
[access_scopes]
scopes = ["write_orders"]

write_payments

Work as a payment method: receive payment, refund, capture and void requests and report their results.

Example

toml
[access_scopes]
scopes = ["write_payments"]

write_pixels

View and update settings for the app's own web pixels (such as measurement IDs).

Example

toml
[access_scopes]
scopes = ["write_pixels"]

write_products

Add and update products.

Example

toml
[access_scopes]
scopes = ["write_products"]

write_sms

Send transactional SMS messages to customers about orders via the store's SMS provider; when acting as the SMS provider, send the store's SMS and report delivery status.

Example

toml
[access_scopes]
scopes = ["write_sms"]

write_theme_blocks

Add app blocks and app embeds to the store's theme.

Example

toml
[access_scopes]
scopes = ["write_theme_blocks"]

write_translations

Update translations of products, collections, pages and menus; can alter storefront text, including HTML descriptions.

Example

toml
[access_scopes]
scopes = ["write_translations"]