Read Preferences

The Read Preferences API endpoint is designed to fetch admin preferences from the Loop admin portal for bundles associated with a specific Shopify domain.

Fetches the bundle preferences configured in the Loop admin portal for a store, so your custom UI stays consistent with the merchant's settings.


Auth: Storefront-callable (no token).

Parameters

NameInTypeRequiredDescription
versionpathstringYesAPI version (2023-10).
myshopifyDomainquerystringYesThe store's *.myshopify.com domain.

Response

data is a map of preference keyvalue. Known preferences:

KeyExample valueMeaning
bundle_inventory_controlSHOWWhether inventory (e.g. out-of-stock state) is surfaced in the bundle UI. SHOW / HIDE.
Query Params
string

myShopifyDomain is your default domain which you have chosen when you signed up to Shopify. It has ".myshopify.com" at the end (your-store-name.myshopify.com)

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json