Skip to main content
GET
/
shops
/
public
Fetch Shop by slug
curl --request GET \
  --url http://staging.qshop.ng/apiv2/shops/public/
{
  "msg": "<string>",
  "data": {
    "metric": {
      "weight": "<string>",
      "dimension": "<string>",
      "system": "<string>"
    },
    "bankDetailsSecurity": {
      "allowUpdate": true,
      "enabled": true
    },
    "stripe": {
      "connect": {
        "id": "<string>",
        "isActive": true
      },
      "id": "<unknown>"
    },
    "config": {
      "storefront": {
        "showSKU": true,
        "showNameWithLogo": true,
        "buyOverWhatsapp": true,
        "theme": "<string>",
        "colors": {
          "primary": "<string>",
          "secondary": "<string>"
        },
        "font": "<string>",
        "banners": [
          {
            "banner": {
              "uuid": "<string>",
              "name": "<string>",
              "size": 123,
              "isStored": true,
              "isImage": true,
              "originalImageInfo": {
                "dpi": [
                  123
                ],
                "width": 123,
                "format": "<string>",
                "height": 123,
                "sequence": true,
                "color_mode": "<string>",
                "orientation": "<unknown>",
                "geo_location": "<unknown>",
                "datetime_original": "<unknown>"
              },
              "originalVideoInfo": "<unknown>",
              "originalContentInfo": {
                "mime": {
                  "mime": "<string>",
                  "type": "<string>",
                  "subtype": "<string>"
                },
                "image": {
                  "dpi": [
                    123
                  ],
                  "width": 123,
                  "format": "<string>",
                  "height": 123,
                  "sequence": true,
                  "color_mode": "<string>",
                  "orientation": "<unknown>",
                  "geo_location": "<unknown>",
                  "datetime_original": "<unknown>"
                }
              },
              "mimeType": "<string>",
              "originalUrl": "<string>",
              "cdnUrl": "<string>",
              "cdnUrlModifiers": "<string>",
              "sourceInfo": {
                "source": "<string>"
              },
              "crop": {
                "left": 123,
                "top": 123,
                "width": 123,
                "height": 123,
                "sw": 123,
                "sh": 123
              }
            },
            "title": "<string>",
            "subtitle": "<string>",
            "link": {
              "type": "<string>",
              "path": "<string>",
              "extraPathInfo": {
                "label": "<string>",
                "slug": "<string>"
              }
            },
            "is_active": true,
            "period": {
              "start": "<string>",
              "end": "<unknown>"
            },
            "cta": {
              "colour": "<string>",
              "show_gradient": true
            }
          }
        ],
        "showStoreDetails": true,
        "showEmailSignup": true,
        "showSocialLinks": true,
        "showFooterMenu": true,
        "hideLogo": true
      },
      "product": {
        "inventory": {
          "isLowStockEnabled": true,
          "isOutOfStockEnabled": true,
          "enableProductPageStockCount": true,
          "lowStockThreshold": 123,
          "outOfStockThreshold": 123,
          "displayOptionKey": "<string>",
          "storefrontDisplaySoldOut": true
        }
      },
      "customerNotification": {
        "whatsApp": true,
        "email": true
      },
      "shipping": {
        "integrations": {
          "markup": {
            "amount": 123,
            "type": "<string>"
          },
          "useAlternativeCarriers": true,
          "supportedRegions": "<string>",
          "enabled": true,
          "supportedProviders": [
            "<string>"
          ],
          "serviceType": "<string>",
          "feeChargeOn": "<string>"
        },
        "defaultProvider": "<string>",
        "hasDeliveryRates": true,
        "hasPickupRates": true,
        "returnAllRates": true
      },
      "order": {
        "acceptWithoutShippingRate": true
      },
      "calculateProfit": true,
      "enableReviews": true
    },
    "meta": {
      "subscription": {
        "numberOfNotificationsSent": 123,
        "name": "<string>",
        "key": "<string>",
        "_key": "<string>",
        "plan": "<string>",
        "planKey": "<string>",
        "renewed": "<string>",
        "expires": "<string>"
      }
    },
    "productType": "<string>",
    "tags": "<array>",
    "_id": "<string>",
    "name": "<string>",
    "owner": {
      "kyc": {
        "attempts": 123,
        "status": "<string>",
        "requested": "<string>",
        "errors": "<array>",
        "lastUpdated": "<string>"
      },
      "_id": "<string>",
      "email": "<string>",
      "full_name": "<string>"
    },
    "created": "<string>",
    "modified": "<string>",
    "telephone": "<string>",
    "email": "<string>",
    "whatsApp": true,
    "call": true,
    "bio": "<string>",
    "shopCategory": {
      "_id": "<string>",
      "name": "<string>",
      "weight": 123
    },
    "status": "<string>",
    "products": 123,
    "logo": "<unknown>",
    "slug": "<string>",
    "__v": 123,
    "instaAuth": "<string>",
    "instaAuthDateExpires": "<string>",
    "instagram": "<string>",
    "shopPreview": "<string>",
    "trialEnd": "<string>",
    "trialPeriod": 123,
    "trialStart": "<string>",
    "billingNotice": "<string>",
    "trialExtended": 123,
    "subscription": {
      "paymentSnapshot": {
        "amount": 123
      },
      "_id": "<string>",
      "shop": "<string>",
      "billingCycle": "<string>",
      "paymentDate": "<string>",
      "expires": "<string>",
      "paymentReference": "<string>",
      "email": "<string>",
      "paymentPlatform": "<string>",
      "paymentStatus": "<string>",
      "paymentErrors": "<array>",
      "amount": 123,
      "currency": "<string>",
      "plan": "<string>",
      "planCurrency": "<string>",
      "recurringPayment": true,
      "description": "<string>",
      "credits": [
        {
          "type": "<string>",
          "redeemed": 123,
          "limit": 123,
          "balance": 123,
          "valueType": "<string>",
          "_id": "<string>"
        }
      ],
      "_plan": "<string>",
      "__v": 123
    },
    "testShop": true,
    "fbPixelId": "<string>",
    "expandPolicy": true,
    "paused": true,
    "shop_url": "<string>",
    "instaId": "<unknown>",
    "pickupLocation": "<string>",
    "inventoryConfig": {
      "isLowStockEnabled": true,
      "isOutOfStockEnabled": true,
      "enableProductPageStockCount": true,
      "lowStockThreshold": 123,
      "outOfStockThreshold": 123,
      "displayOptionKeyId": "<string>",
      "displayOptionKey": "<string>",
      "storefrontDisplaySoldOut": true,
      "_id": "<string>"
    },
    "domainName": "<string>",
    "firstLaunch": "<string>",
    "referralCode": "<string>",
    "hideLogo": true,
    "logo_uuid": "<string>",
    "customerNotificationConfig": {
      "whatsApp": true,
      "email": true,
      "_id": "<string>"
    },
    "currencies": [
      {
        "_id": "<string>",
        "isRateAutomated": true,
        "shop": "<string>",
        "currency": {
          "_id": "<string>",
          "code": "<string>",
          "symbol": "<string>",
          "nationality": "<string>",
          "exchangeRate": 123,
          "__v": 123,
          "country": "<string>",
          "name": "<string>",
          "minimumProcessingAmount": 123
        },
        "baseRate": 123,
        "currencyRate": 123,
        "isBaseCurrency": true,
        "isStoreFrontDefault": true,
        "isDisabled": true,
        "__v": 123
      }
    ],
    "domainCreated": "<string>",
    "domainValidated": true,
    "domainActive": true,
    "domainLastChecked": "<unknown>",
    "socials": [
      {
        "name": "<string>",
        "slug": "<string>",
        "id": "<unknown>",
        "authExpires": "<unknown>",
        "username": "<unknown>",
        "url": "<unknown>",
        "category": "<string>",
        "paidAccess": true,
        "_id": "<string>",
        "auth": "<unknown>"
      }
    ],
    "country": {
      "_id": "<string>",
      "name": "<string>",
      "dialCode": "<string>",
      "code": "<string>",
      "__v": 123,
      "geoId": "<string>",
      "hasPostCode": true,
      "postalCodeFormat": "<string>",
      "currencyCode": "<string>",
      "east": 123,
      "north": 123,
      "south": 123,
      "west": 123
    },
    "launched": true,
    "description": "<string>",
    "credits": "<array>",
    "kyc": {
      "attempts": 123,
      "status": "<string>",
      "requested": "<string>",
      "errors": "<array>",
      "lastUpdated": "<string>"
    },
    "baseCurrency": {
      "_id": "<string>",
      "code": "<string>",
      "symbol": "<string>",
      "nationality": "<string>",
      "exchangeRate": 123,
      "__v": 123,
      "minimumProcessingAmount": 123,
      "country": "<string>",
      "name": "<string>"
    },
    "plan": "<string>",
    "url": "<string>",
    "whatsapp_number": "<string>"
  },
  "success": true
}

Query Parameters

id
string
domainName
string
required
slug
string
required

Response

200 - application/json
msg
string
required
data
object
required
success
boolean
required