Path parameters

• shopId integer(int64) Required

Query parameters

• key string

Responses

• 200

  Page Info

  Hide response attributes Show response attributes object

  • data object
    Hide data attributes Show data attributes object

    • mainDetails object
      Hide mainDetails attributes Show mainDetails attributes object

      • id integer(int64)
      • name string | null
      • onHold boolean
      • enableFaq boolean
      • passwordProtected boolean
      • balanceEnabled boolean
      • subscriptionName string | null
      • seoDetails object
        Hide seoDetails attributes Show seoDetails attributes object

        • id integer(int64)
        • favIconUrl string | null
        • metaTitle string | null
        • metaDescription string | null
        • metaImageCfId string | null
        • Additional properties are NOT allowed
      • defaultDiscordSettings object
        Hide defaultDiscordSettings attributes Show defaultDiscordSettings attributes object

        • enabled boolean
        • required boolean
        • Additional properties are NOT allowed
      • design object
        Hide design attributes Show design attributes object

        • cfImageId string | null
        • title string | null
        • description string | null
        • buttonText string | null
        • disableButton boolean
        • disableTitle boolean
        • disableDescription boolean
        • backgroundCfImageId string | null
        • backgroundColor string | null
        • primaryColor string | null
        • primaryColorAccent string | null
        • secondaryColor string | null
        • primaryTextColor string | null
        • secondaryTextColor string | null
        • disableShadows boolean
        • disableSnow boolean
        • disableSupport boolean
        • isMainPageVisible boolean
        • fontLink string | null
        • darkMode boolean
        • disableBusinessName boolean
        • disableSearchBar boolean
        • centerProductTitle boolean
        • disableBusinessLogo boolean
        • disableReviews boolean
        • disableProductsSold boolean
        • hideOutOfStockProducts boolean
        • hideProductStock boolean
        • googleAnalyticsKey string | null
        • crispChatKey string | null
        • Additional properties are NOT allowed
      • discordOauthUrl string | null
      • shopPopUp string | null
      • shopTerms string | null
      • socialLinks array[object] | null
        Hide socialLinks attributes Show socialLinks attributes array[object] | null

        • platform integer(int32)

          Values are 0, 1, 2, 3, 4, 5, 6, 7, or 8.

        • link string | null
        • Additional properties are NOT allowed
      • Additional properties are NOT allowed
    • listings array[object] | null
      Hide listings attributes Show listings attributes array[object] | null

      • id integer(int64)
      • path string | null
      • searchWordsMeta string | null
      • position integer(int32)
      • minPriceDetails object
        Hide minPriceDetails attributes Show minPriceDetails attributes object

        • amount number(double)
        • currency string | null
        • Additional properties are NOT allowed
      • seo object
        Hide seo attributes Show seo attributes object

        • metaTitle string | null
        • metaDescription string | null
        • metaCfImageId string | null
        • Additional properties are NOT allowed
      • visibility integer(int32)

        " Public = 0 Private = 1 Unlisted = 2 "

        Values are 0, 1, or 2.

      • type integer(int32)

        " Products = 0 Groups = 1 Categories = 3 "

        Values are 0, 1, or 3.

      • product object
        Hide product attributes Show product attributes object

        • id integer(int64)
        • title string | null
        • shortDescription string | null
        • thumbnailCfImageId string | null
        • statistics object
          Hide statistics attributes Show statistics attributes object

          • rating number(float)
          • totalFeedbacks integer(int64)
          • totalProductsSold integer(int64)
          • customersCount integer(int64)
          • Additional properties are NOT allowed
        • groupId integer(int64) | null
        • isInstantDelivery boolean
        • isInStock boolean
        • onHold boolean
        • unlisted boolean
        • private boolean
        • Additional properties are NOT allowed
      • group object
        Hide group attributes Show group attributes object

        • id integer(int64)
        • title string | null
        • description string | null
        • cfImageId string | null
        • listings array[object] | null
          Hide listings attribute Show listings attribute array[object] | null

          • Additional properties are NOT allowed
        • type integer(int32)

          Values are 0 or 1.

        • Additional properties are NOT allowed
      • Additional properties are NOT allowed
    • categories array[object] | null
      Hide categories attributes Show categories attributes array[object] | null

      • id integer(int64)
      • name string | null
      • listingIds array[integer(int64)] | null
      • Additional properties are NOT allowed
    • Additional properties are NOT allowed
  • errors array[string] | null
  • message string | null
  • log string | null
  • Additional properties are NOT allowed
• 404

  Shop Not Found