> ## Documentation Index
> Fetch the complete documentation index at: https://developers.qshop.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Fetch Shop by slug

> **Host**: http://qshop.ng



## OpenAPI

````yaml get /shops/public/
openapi: 3.1.0
info:
  title: OpenAPI Specification
  version: 1.0.0
  description: >-
    QShop storefront API.  This API is used to build a storefront for a QShop
    store
  contact:
    name: QShop
    url: https://qshop.ng
    email: hello@qshop.ng
servers:
  - url: http://staging.qshop.ng/apiv2
    description: Staging server
  - url: http://qshop.ng/api
    description: Production server
security: []
paths:
  /shops/public/:
    get:
      tags:
        - Shops
      summary: Fetch Shop by slug
      description: '**Host**: http://qshop.ng'
      parameters:
        - name: id
          in: query
          required: false
          schema:
            type: string
        - name: domainName
          in: query
          required: true
          schema:
            type: string
        - name: slug
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      metric:
                        type: object
                        properties:
                          weight:
                            type: string
                          dimension:
                            type: string
                          system:
                            type: string
                        required:
                          - weight
                          - dimension
                          - system
                      bankDetailsSecurity:
                        type: object
                        properties:
                          allowUpdate:
                            type: boolean
                          enabled:
                            type: boolean
                        required:
                          - allowUpdate
                          - enabled
                      stripe:
                        type: object
                        properties:
                          connect:
                            type: object
                            properties:
                              id:
                                type: string
                              isActive:
                                type: boolean
                            required:
                              - id
                              - isActive
                          id:
                            type: 'null'
                        required:
                          - connect
                          - id
                      config:
                        type: object
                        properties:
                          storefront:
                            type: object
                            properties:
                              showSKU:
                                type: boolean
                              showNameWithLogo:
                                type: boolean
                              buyOverWhatsapp:
                                type: boolean
                              theme:
                                type: string
                              colors:
                                type: object
                                properties:
                                  primary:
                                    type: string
                                  secondary:
                                    type: string
                                required:
                                  - primary
                                  - secondary
                              font:
                                type: string
                              banners:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    banner:
                                      type: object
                                      properties:
                                        uuid:
                                          type: string
                                        name:
                                          type: string
                                        size:
                                          type: integer
                                        isStored:
                                          type: boolean
                                        isImage:
                                          type: boolean
                                        originalImageInfo:
                                          type: object
                                          properties:
                                            dpi:
                                              type: array
                                              items:
                                                type: integer
                                            width:
                                              type: integer
                                            format:
                                              type: string
                                            height:
                                              type: integer
                                            sequence:
                                              type: boolean
                                            color_mode:
                                              type: string
                                            orientation:
                                              type: 'null'
                                            geo_location:
                                              type: 'null'
                                            datetime_original:
                                              type: 'null'
                                          required:
                                            - dpi
                                            - width
                                            - format
                                            - height
                                            - sequence
                                            - color_mode
                                            - orientation
                                            - geo_location
                                            - datetime_original
                                        originalVideoInfo:
                                          type: 'null'
                                        originalContentInfo:
                                          type: object
                                          properties:
                                            mime:
                                              type: object
                                              properties:
                                                mime:
                                                  type: string
                                                type:
                                                  type: string
                                                subtype:
                                                  type: string
                                              required:
                                                - mime
                                                - type
                                                - subtype
                                            image:
                                              type: object
                                              properties:
                                                dpi:
                                                  type: array
                                                  items:
                                                    type: integer
                                                width:
                                                  type: integer
                                                format:
                                                  type: string
                                                height:
                                                  type: integer
                                                sequence:
                                                  type: boolean
                                                color_mode:
                                                  type: string
                                                orientation:
                                                  type: 'null'
                                                geo_location:
                                                  type: 'null'
                                                datetime_original:
                                                  type: 'null'
                                              required:
                                                - dpi
                                                - width
                                                - format
                                                - height
                                                - sequence
                                                - color_mode
                                                - orientation
                                                - geo_location
                                                - datetime_original
                                          required:
                                            - mime
                                            - image
                                        mimeType:
                                          type: string
                                        originalUrl:
                                          type: string
                                        cdnUrl:
                                          type: string
                                        cdnUrlModifiers:
                                          type: string
                                        sourceInfo:
                                          type: object
                                          properties:
                                            source:
                                              type: string
                                          required:
                                            - source
                                        crop:
                                          type: object
                                          properties:
                                            left:
                                              type: integer
                                            top:
                                              type: integer
                                            width:
                                              type: integer
                                            height:
                                              type: integer
                                            sw:
                                              type: integer
                                            sh:
                                              type: integer
                                          required:
                                            - left
                                            - top
                                            - width
                                            - height
                                            - sw
                                            - sh
                                      required:
                                        - uuid
                                        - name
                                        - size
                                        - isStored
                                        - isImage
                                        - originalImageInfo
                                        - originalVideoInfo
                                        - originalContentInfo
                                        - mimeType
                                        - originalUrl
                                        - cdnUrl
                                        - cdnUrlModifiers
                                        - sourceInfo
                                        - crop
                                    title:
                                      type: string
                                    subtitle:
                                      type: string
                                    link:
                                      type: object
                                      properties:
                                        type:
                                          type: string
                                        path:
                                          type: string
                                        extraPathInfo:
                                          type: object
                                          properties:
                                            label:
                                              type: string
                                            slug:
                                              type: string
                                          required:
                                            - label
                                            - slug
                                      required:
                                        - type
                                        - path
                                        - extraPathInfo
                                    is_active:
                                      type: boolean
                                    period:
                                      type: object
                                      properties:
                                        start:
                                          type: string
                                        end:
                                          type: 'null'
                                      required:
                                        - start
                                        - end
                                    cta:
                                      type: object
                                      properties:
                                        colour:
                                          type: string
                                        show_gradient:
                                          type: boolean
                                      required:
                                        - colour
                                        - show_gradient
                                  required:
                                    - banner
                                    - title
                                    - subtitle
                                    - link
                                    - is_active
                                    - period
                                    - cta
                              showStoreDetails:
                                type: boolean
                              showEmailSignup:
                                type: boolean
                              showSocialLinks:
                                type: boolean
                              showFooterMenu:
                                type: boolean
                              hideLogo:
                                type: boolean
                            required:
                              - showSKU
                              - showNameWithLogo
                              - buyOverWhatsapp
                              - theme
                              - colors
                              - font
                              - banners
                              - showStoreDetails
                              - showEmailSignup
                              - showSocialLinks
                              - showFooterMenu
                              - hideLogo
                          product:
                            type: object
                            properties:
                              inventory:
                                type: object
                                properties:
                                  isLowStockEnabled:
                                    type: boolean
                                  isOutOfStockEnabled:
                                    type: boolean
                                  enableProductPageStockCount:
                                    type: boolean
                                  lowStockThreshold:
                                    type: integer
                                  outOfStockThreshold:
                                    type: integer
                                  displayOptionKey:
                                    type: string
                                  storefrontDisplaySoldOut:
                                    type: boolean
                                required:
                                  - isLowStockEnabled
                                  - isOutOfStockEnabled
                                  - enableProductPageStockCount
                                  - lowStockThreshold
                                  - outOfStockThreshold
                                  - displayOptionKey
                                  - storefrontDisplaySoldOut
                            required:
                              - inventory
                          customerNotification:
                            type: object
                            properties:
                              whatsApp:
                                type: boolean
                              email:
                                type: boolean
                            required:
                              - whatsApp
                              - email
                          shipping:
                            type: object
                            properties:
                              integrations:
                                type: object
                                properties:
                                  markup:
                                    type: object
                                    properties:
                                      amount:
                                        type: integer
                                      type:
                                        type: string
                                    required:
                                      - amount
                                      - type
                                  useAlternativeCarriers:
                                    type: boolean
                                  supportedRegions:
                                    type: string
                                  enabled:
                                    type: boolean
                                  supportedProviders:
                                    type: array
                                    items:
                                      type: string
                                  serviceType:
                                    type: string
                                  feeChargeOn:
                                    type: string
                                required:
                                  - markup
                                  - useAlternativeCarriers
                                  - supportedRegions
                                  - enabled
                                  - supportedProviders
                                  - serviceType
                                  - feeChargeOn
                              defaultProvider:
                                type: string
                              hasDeliveryRates:
                                type: boolean
                              hasPickupRates:
                                type: boolean
                              returnAllRates:
                                type: boolean
                            required:
                              - integrations
                              - defaultProvider
                              - hasDeliveryRates
                              - hasPickupRates
                              - returnAllRates
                          order:
                            type: object
                            properties:
                              acceptWithoutShippingRate:
                                type: boolean
                            required:
                              - acceptWithoutShippingRate
                          calculateProfit:
                            type: boolean
                          enableReviews:
                            type: boolean
                        required:
                          - storefront
                          - product
                          - customerNotification
                          - shipping
                          - order
                          - calculateProfit
                          - enableReviews
                      meta:
                        type: object
                        properties:
                          subscription:
                            type: object
                            properties:
                              numberOfNotificationsSent:
                                type: integer
                              name:
                                type: string
                              key:
                                type: string
                              _key:
                                type: string
                              plan:
                                type: string
                              planKey:
                                type: string
                              renewed:
                                type: string
                              expires:
                                type: string
                            required:
                              - numberOfNotificationsSent
                              - name
                              - key
                              - _key
                              - plan
                              - planKey
                              - renewed
                              - expires
                        required:
                          - subscription
                      productType:
                        type: string
                      tags:
                        type: array
                      _id:
                        type: string
                      name:
                        type: string
                      owner:
                        type: object
                        properties:
                          kyc:
                            type: object
                            properties:
                              attempts:
                                type: integer
                              status:
                                type: string
                              requested:
                                type: string
                              errors:
                                type: array
                              lastUpdated:
                                type: string
                            required:
                              - attempts
                              - status
                              - requested
                              - errors
                              - lastUpdated
                          _id:
                            type: string
                          email:
                            type: string
                          full_name:
                            type: string
                        required:
                          - kyc
                          - _id
                          - email
                          - full_name
                      created:
                        type: string
                      modified:
                        type: string
                      telephone:
                        type: string
                      email:
                        type: string
                      whatsApp:
                        type: boolean
                      call:
                        type: boolean
                      bio:
                        type: string
                      shopCategory:
                        type: object
                        properties:
                          _id:
                            type: string
                          name:
                            type: string
                          weight:
                            type: integer
                        required:
                          - _id
                          - name
                          - weight
                      status:
                        type: string
                      products:
                        type: integer
                      logo:
                        type: 'null'
                      slug:
                        type: string
                      __v:
                        type: integer
                      instaAuth:
                        type: string
                      instaAuthDateExpires:
                        type: string
                      instagram:
                        type: string
                      shopPreview:
                        type: string
                      trialEnd:
                        type: string
                      trialPeriod:
                        type: integer
                      trialStart:
                        type: string
                      billingNotice:
                        type: string
                      trialExtended:
                        type: integer
                      subscription:
                        type: object
                        properties:
                          paymentSnapshot:
                            type: object
                            properties:
                              amount:
                                type: integer
                            required:
                              - amount
                          _id:
                            type: string
                          shop:
                            type: string
                          billingCycle:
                            type: string
                          paymentDate:
                            type: string
                          expires:
                            type: string
                          paymentReference:
                            type: string
                          email:
                            type: string
                          paymentPlatform:
                            type: string
                          paymentStatus:
                            type: string
                          paymentErrors:
                            type: array
                          amount:
                            type: integer
                          currency:
                            type: string
                          plan:
                            type: string
                          planCurrency:
                            type: string
                          recurringPayment:
                            type: boolean
                          description:
                            type: string
                          credits:
                            type: array
                            items:
                              type: object
                              properties:
                                type:
                                  type: string
                                redeemed:
                                  type: integer
                                limit:
                                  type: integer
                                balance:
                                  type: integer
                                valueType:
                                  type: string
                                _id:
                                  type: string
                              required:
                                - type
                                - redeemed
                                - limit
                                - balance
                                - valueType
                                - _id
                          _plan:
                            type: string
                          __v:
                            type: integer
                        required:
                          - paymentSnapshot
                          - _id
                          - shop
                          - billingCycle
                          - paymentDate
                          - expires
                          - paymentReference
                          - email
                          - paymentPlatform
                          - paymentStatus
                          - paymentErrors
                          - amount
                          - currency
                          - plan
                          - planCurrency
                          - recurringPayment
                          - description
                          - credits
                          - _plan
                          - __v
                      testShop:
                        type: boolean
                      fbPixelId:
                        type: string
                      expandPolicy:
                        type: boolean
                      paused:
                        type: boolean
                      shop_url:
                        type: string
                      instaId:
                        type: 'null'
                      pickupLocation:
                        type: string
                      inventoryConfig:
                        type: object
                        properties:
                          isLowStockEnabled:
                            type: boolean
                          isOutOfStockEnabled:
                            type: boolean
                          enableProductPageStockCount:
                            type: boolean
                          lowStockThreshold:
                            type: integer
                          outOfStockThreshold:
                            type: integer
                          displayOptionKeyId:
                            type: string
                          displayOptionKey:
                            type: string
                          storefrontDisplaySoldOut:
                            type: boolean
                          _id:
                            type: string
                        required:
                          - isLowStockEnabled
                          - isOutOfStockEnabled
                          - enableProductPageStockCount
                          - lowStockThreshold
                          - outOfStockThreshold
                          - displayOptionKeyId
                          - displayOptionKey
                          - storefrontDisplaySoldOut
                          - _id
                      domainName:
                        type: string
                      firstLaunch:
                        type: string
                      referralCode:
                        type: string
                      hideLogo:
                        type: boolean
                      logo_uuid:
                        type: string
                      customerNotificationConfig:
                        type: object
                        properties:
                          whatsApp:
                            type: boolean
                          email:
                            type: boolean
                          _id:
                            type: string
                        required:
                          - whatsApp
                          - email
                          - _id
                      currencies:
                        type: array
                        items:
                          type: object
                          properties:
                            _id:
                              type: string
                            isRateAutomated:
                              type: boolean
                            shop:
                              type: string
                            currency:
                              type: object
                              properties:
                                _id:
                                  type: string
                                code:
                                  type: string
                                symbol:
                                  type: string
                                nationality:
                                  type: string
                                exchangeRate:
                                  type: number
                                __v:
                                  type: integer
                                country:
                                  type: string
                                name:
                                  type: string
                                minimumProcessingAmount:
                                  type: integer
                              required:
                                - _id
                                - code
                                - symbol
                                - nationality
                                - exchangeRate
                                - __v
                                - country
                                - name
                            baseRate:
                              type: integer
                            currencyRate:
                              type: number
                            isBaseCurrency:
                              type: boolean
                            isStoreFrontDefault:
                              type: boolean
                            isDisabled:
                              type: boolean
                            __v:
                              type: integer
                          required:
                            - _id
                            - isRateAutomated
                            - shop
                            - currency
                            - baseRate
                            - currencyRate
                            - isBaseCurrency
                            - isStoreFrontDefault
                            - isDisabled
                            - __v
                      domainCreated:
                        type: string
                      domainValidated:
                        type: boolean
                      domainActive:
                        type: boolean
                      domainLastChecked:
                        type: 'null'
                      socials:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                            slug:
                              type: string
                            id:
                              type:
                                - 'null'
                                - string
                            authExpires:
                              type:
                                - 'null'
                                - string
                            username:
                              type:
                                - 'null'
                                - string
                            url:
                              type:
                                - 'null'
                                - string
                            category:
                              type: string
                            paidAccess:
                              type: boolean
                            _id:
                              type: string
                            auth:
                              type: 'null'
                          required:
                            - name
                            - slug
                            - id
                            - authExpires
                            - username
                            - url
                            - category
                            - paidAccess
                            - _id
                      country:
                        type: object
                        properties:
                          _id:
                            type: string
                          name:
                            type: string
                          dialCode:
                            type: string
                          code:
                            type: string
                          __v:
                            type: integer
                          geoId:
                            type: string
                          hasPostCode:
                            type: boolean
                          postalCodeFormat:
                            type: string
                          currencyCode:
                            type: string
                          east:
                            type: number
                          north:
                            type: number
                          south:
                            type: number
                          west:
                            type: number
                        required:
                          - _id
                          - name
                          - dialCode
                          - code
                          - __v
                          - geoId
                          - hasPostCode
                          - postalCodeFormat
                          - currencyCode
                          - east
                          - north
                          - south
                          - west
                      launched:
                        type: boolean
                      description:
                        type: string
                      credits:
                        type: array
                      kyc:
                        type: object
                        properties:
                          attempts:
                            type: integer
                          status:
                            type: string
                          requested:
                            type: string
                          errors:
                            type: array
                          lastUpdated:
                            type: string
                        required:
                          - attempts
                          - status
                          - requested
                          - errors
                          - lastUpdated
                      baseCurrency:
                        type: object
                        properties:
                          _id:
                            type: string
                          code:
                            type: string
                          symbol:
                            type: string
                          nationality:
                            type: string
                          exchangeRate:
                            type: integer
                          __v:
                            type: integer
                          minimumProcessingAmount:
                            type: integer
                          country:
                            type: string
                          name:
                            type: string
                        required:
                          - _id
                          - code
                          - symbol
                          - nationality
                          - exchangeRate
                          - __v
                          - minimumProcessingAmount
                          - country
                          - name
                      plan:
                        type: string
                      url:
                        type: string
                      whatsapp_number:
                        type: string
                    required:
                      - metric
                      - bankDetailsSecurity
                      - stripe
                      - config
                      - meta
                      - productType
                      - tags
                      - _id
                      - name
                      - owner
                      - created
                      - modified
                      - telephone
                      - email
                      - whatsApp
                      - call
                      - bio
                      - shopCategory
                      - status
                      - products
                      - logo
                      - slug
                      - __v
                      - instaAuth
                      - instaAuthDateExpires
                      - instagram
                      - shopPreview
                      - trialEnd
                      - trialPeriod
                      - trialStart
                      - billingNotice
                      - trialExtended
                      - subscription
                      - testShop
                      - fbPixelId
                      - expandPolicy
                      - paused
                      - shop_url
                      - instaId
                      - pickupLocation
                      - inventoryConfig
                      - domainName
                      - firstLaunch
                      - referralCode
                      - hideLogo
                      - logo_uuid
                      - customerNotificationConfig
                      - currencies
                      - domainCreated
                      - domainValidated
                      - domainActive
                      - domainLastChecked
                      - socials
                      - country
                      - launched
                      - description
                      - credits
                      - kyc
                      - baseCurrency
                      - plan
                      - url
                      - whatsapp_number
                  success:
                    type: boolean
                required:
                  - msg
                  - data
                  - success
          description: ''

````