Queek docs

Scopes

The 123 scopes across 195 operations, generated from the spec — a key carries scopes, and scopes are its whole permission.

A key holds scopes; scopes are the whole permission. Grant the smallest set that covers the calls the integration makes — an operation outside them is a 403 insufficient_scope, never a silent partial answer. See Authentication & keys for who can grant what.

Every row below comes from the Requires scope sentence on the operation itself, so this table says exactly what the API enforces. The reference pages repeat the scope per operation.

ScopeOperations
merchant-analytics-customers-readGET /analytics/customers
merchant-analytics-products-readGET /analytics/products
merchant-analytics-sales-readGET /analytics/sales
merchant-analytics-traffic-readGET /analytics/traffic
merchant-app-requirements-writePUT /app/requirements
PUT /app/line-inputs
merchant-app_alerts-createPOST /app/alerts
merchant-app_metafields-readGET /app/metafields
merchant-app_metafields-updatePATCH /app/metafields
PATCH /metafield-definitions/{definition}
DELETE /metafield-definitions/{definition}
merchant-app_payment_secret-createPOST /app/payment-provider/signing-secret
merchant-app_setup-updatePUT /app/setup
merchant-business_profile-readGET /store
merchant-checkouts-readGET /abandoned-checkouts
merchant-collected-definitions-manageGET /collected-definitions
POST /collected-definitions
PATCH /collected-definitions/{definition}
merchant-collected-records-readGET /records
GET /records/{record}
merchant-collected-records-submitPOST /records
merchant-collected-records-updatePATCH /records/{record}
merchant-collections-createPOST /collections/bulk
merchant-collections-detailGET /collections/{collection}
merchant-collections-readGET /collections
merchant-collections-updatePUT /collections/{collection}
POST /collections/{collection}/products/pin
POST /collections/{collection}/products/reorder
merchant-conversations-readGET /conversations
GET /conversations/{conversation}
GET /conversations/{conversation}/messages
merchant-conversations-replyPOST /conversations/{conversation}/messages
merchant-conversations-updatePOST /conversations/{conversation}/mark-read
merchant-coupons-createPOST /coupons
merchant-coupons-readGET /coupons
merchant-coupons-updatePATCH /coupons/{coupon}
merchant-customer-segments-createPOST /customer-segments
merchant-customer-segments-deleteDELETE /customer-segments/{segment}
merchant-customer-segments-readGET /customer-segments
GET /customer-segments/{segment}
POST /customer-segments/preview
merchant-customer-segments-updatePATCH /customer-segments/{segment}
merchant-customers-consent-updatePOST /customers/{customer}/email-marketing-consent
merchant-customers-detailGET /customers/{customer}
GET /customers/{customer}/wishlist-items
merchant-customers-readGET /customers
GET /customers/followers
merchant-customers-sms-consent-updatePOST /customers/{customer}/sms-marketing-consent
merchant-customers-updatePUT /customers/{customer}/tags
merchant-discounts-createPOST /discounts
merchant-discounts-detailGET /discounts/{discount}
merchant-discounts-readGET /discounts
merchant-discounts-updatePATCH /discounts/{discount}
POST /discounts/{discount}/publish
POST /discounts/{discount}/unpublish
merchant-exports-createPOST /exports
merchant-exports-readGET /exports/{export}
merchant-inventory-detailGET /inventory/products/{product}/history
merchant-inventory-readGET /inventory
GET /inventory/levels
GET /inventory/low-stock
GET /inventory/out-of-stock
merchant-inventory-updatePOST /inventory/levels/adjustments
POST /inventory/adjustments
merchant-invoices-createPOST /invoices
POST /orders/{order}/invoice
merchant-invoices-deleteDELETE /invoices/{invoice}
merchant-invoices-fiscal-referencePOST /invoices/{invoice}/fiscal-reference
merchant-invoices-readGET /invoices
GET /invoices/{invoice}
GET /orders/{order}/invoice
merchant-invoices-record-paymentPOST /invoices/{invoice}/payments
POST /invoices/{invoice}/payments/{payment}/void
merchant-invoices-updatePATCH /invoices/{invoice}
POST /invoices/{invoice}/issue
merchant-invoices-voidPOST /invoices/{invoice}/void
POST /invoices/{invoice}/credit-notes
merchant-items-createPOST /products
merchant-items-deleteDELETE /products/{product}
merchant-items-detailGET /products/{product}/images
GET /products/{product}/market-prices
GET /products/{product}
GET /products/{product}/variants
merchant-items-readGET /products
GET /storefront/search
merchant-items-updatePOST /products/{product}/images
PATCH /products/{product}/images/{image}
DELETE /products/{product}/images/{image}
PUT /products/{product}/market-prices
PUT /products/{product}
POST /products/publish
POST /products/{product}/variants
PATCH /products/{product}/variants/{variant}
DELETE /products/{product}/variants/{variant}
merchant-locales-readGET /locales
merchant-locales-writePOST /locales
PATCH /locales/{locale}
DELETE /locales/{locale}
POST /locales/{locale}/default
merchant-markets-readGET /markets
GET /markets/options
GET /markets/{market}
merchant-markets-writePOST /markets
PATCH /markets/{market}
DELETE /markets/{market}
merchant-media-createPOST /files
merchant-media-deleteDELETE /files/{file}
merchant-media-readGET /files
GET /files/{file}/references
merchant-media-updatePATCH /files/{file}
merchant-metafields-createPOST /metafield-definitions
merchant-metafields-readGET /metafield-definitions
merchant-metafields-updatePATCH /products/{product}/metafields
PATCH /products/{product}/variants/{variant}/metafields
merchant-metaobjects-createPOST /metaobject-definitions
POST /metaobjects
merchant-metaobjects-readGET /metaobject-definitions
GET /metaobjects
merchant-options-createPOST /addon-groups
merchant-options-deleteDELETE /addon-groups/{group}
merchant-options-detailGET /addon-groups/{group}
merchant-options-readGET /addon-groups
merchant-options-updatePATCH /addon-groups/{group}
POST /products/{product}/addons
DELETE /products/{product}/addons/{group}
merchant-orders-createPOST /orders
merchant-orders-importPOST /orders/import
merchant-orders-readGET /orders
GET /orders/{order}
GET /orders/{order}/refund-suggestion
merchant-orders-refund-createPOST /orders/{order}/refunds
merchant-orders-status-updatePOST /orders/{order}/status
POST /orders/{order}/assign-rider
merchant-orders-updatePATCH /orders/{order}
PATCH /orders/{order}/shipment
merchant-pages-createPOST /pages
merchant-pages-deleteDELETE /pages/{page}
merchant-pages-detailGET /pages/{page}
merchant-pages-readGET /pages
merchant-pages-updatePATCH /pages/{page}
merchant-payout-batches-readGET /payouts
GET /payouts/{payout}
merchant-payout-ledger-readGET /payout-transactions
GET /payout-transactions/{transaction}
merchant-posts-createPOST /posts
merchant-posts-deleteDELETE /posts/{post}
merchant-posts-detailGET /posts/{post}
merchant-posts-readGET /posts
merchant-posts-updatePUT /posts/{post}
merchant-product_reviews-moderatePATCH /product-reviews/{review}/status
merchant-product_reviews-readGET /product-reviews
GET /product-reviews/{review}
merchant-product_reviews-respondPOST /product-reviews/{review}/response
merchant-publications-createPOST /publications
merchant-publications-readGET /publications
merchant-publications-updatePATCH /publications/{publication}/resources
merchant-purchase_orders-createPOST /purchase-orders
merchant-purchase_orders-detailGET /purchase-orders/{po}
merchant-purchase_orders-readGET /purchase-orders
merchant-purchase_orders-updatePOST /purchase-orders/{po}/cancel
POST /purchase-orders/{po}/order
POST /purchase-orders/{po}/close
POST /purchase-orders/{po}/receive
merchant-returns-createPOST /returns
merchant-returns-readGET /returns
GET /returns/{return}
GET /orders/{order}/returnable
merchant-returns-updatePOST /returns/{return}/approve
POST /returns/{return}/decline
POST /returns/{return}/cancel
POST /returns/{return}/close
POST /returns/{return}/reopen
POST /returns/{return}/receive
merchant-review_settings-readGET /review-settings
merchant-review_settings-updatePATCH /review-settings
merchant-reviews-importPOST /reviews/import
merchant-reviews-readGET /reviews
merchant-shipping-createPOST /shipping-zones
merchant-shipping-readGET /shipping-zones
merchant-shipping-updatePUT /shipping-zones/{zone}
merchant-stock_adjustments-readGET /inventory/adjustments
merchant-suppliers-createPOST /suppliers
merchant-suppliers-readGET /suppliers
merchant-suppliers-updatePATCH /suppliers/{supplier}
merchant-taxes-createPOST /taxes
merchant-taxes-readGET /taxes
GET /taxes/{tax}
merchant-taxes-updatePATCH /taxes/{tax}
merchant-team-directory-readGET /team-directory
merchant-translations-machinePOST /translations/machine/quote
POST /translations/machine
merchant-translations-readGET /translatable-resources
GET /translatable-resources/{type}/{id}
merchant-translations-writePUT /translations/{type}/{id}
DELETE /translations/{type}/{id}

A write scope also returns, in that write’s own response, the record it wrote — listing or reading records needs the matching read scope.

Translations scopes

Four scopes cover every language and translation operation: merchant-locales-read, merchant-locales-write, merchant-translations-read and merchant-translations-write. merchant-translations-read reads the translatable content of every resource type — products, product options and option values, collections, categories, pages, posts, menus and theme strings — and merchant-translations-write writes and removes translations on all of them. No scope of the resource itself (such as merchant-pages-read or merchant-items-read) is needed to translate it. See Translate store content.

merchant-translations-machine is separate: it lets an app ask Queek to machine-translate the store’s own content, which is charged to the store’s credits and saves the results as translations. It is shown to the merchant at install, and the merchant can switch it off for each app. See Machine translation.

On this page