v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

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.

get/2023-10/bundle/preferences

Path parameters

versionstring required

YYYY-MM

Query parameters

myshopifyDomainstring required

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

200

successboolean

messagestring

codestring

{"stackTrail":"paths:/2023-10/bundle/preferences:get:responses:200:content:application/json:schema:properties:pageInfo","oasType":"schema","type":"unknown"}

Example response

{
  "success": true,
  "message": "Preferences fetched successfully",
  "data": {
    "bundle_inventory_control": "SHOW"
  },
  "code": "SUCCESS"
}