> ## 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.
# Clear redis cache
## OpenAPI
````yaml post /cache/
openapi: 3.0.3
info:
title: API V2
version: 1.0.0
contact: {}
servers:
- url: http://staging.qshop.ng/apiv2
description: Staging server
- url: http://qshop.ng/api
description: null
security: []
tags:
- name: Analytics
- name: Authentication
- name: Storefront
- name: Roles
- name: Banks
- name: Products
- name: Shops
- name: Roles1
- name: Bank accounts
- name: Users
- name: Payment methods
- name: Integrations
- name: Subscriptions
- name: Currency
- name: Shipping zones
- name: Shipping rates
- name: Policies
- name: Contact us
- name: Locations
- name: Reviews
- name: Referral
- name: Stripe
- name: Campaigns
- name: Credits
- name: Product Tags
- name: Product Attributes
- name: Product Categories
- name: Orders
- name: Discount
- name: Shipping
- name: Redeem digital assets
- name: Coupons
- name: Currencies
- name: Shop categories
- name: Locations1
- name: Features
- name: Subscription plan
- name: Recurring subscription plan
- name: Shop payments
- name: QDiscounts
- name: Order status
- name: Announcements
- name: Wishlist
- name: Transaction status
- name: Templates
- name: Config
- name: Cart management
- name: Users1
- name: Profile
- name: Domains
- name: Transactions
- name: Subscriptions1
- name: Subscription statuses
- name: Security
- name: Payments
- name: Payment methods1
- name: Payment platforms
- name: Public
- name: social
- name: Shipping1
- name: Orders1
- name: Integrations1
- name: Webhook
- name: ShopTags
- name: Themes
paths:
/cache/:
post:
tags:
- Webhook
summary: Clear redis cache
description: Clear redis cache
operationId: clearRedisCache
requestBody:
content:
application/json:
schema:
type: object
properties:
event:
type: string
example: shop
props:
type: object
properties:
shop:
type: object
properties:
__v:
type: number
example: 83
_id:
type: string
example: 61a956d91a113f7e13c45c15
area:
type: string
example: 62f2e2efa65b7319b3b4715f
bio:
type: string
example: We love football
call:
type: boolean
example: true
city:
type: string
example: 62d46bb079344c34996b2c47
country:
type: string
example: 628c8d3c21ce8313e6293c8e
created:
type: string
example: '2021-12-02T23:29:29.317Z'
currencies:
type: array
items:
type: string
example: 629dd54ac046650e6cb78b74
example:
- 629dd54ac046650e6cb78b74
- 629dd54ac046650e6cb78b75
- 630bfb78e50744001d860921
customerNotificationConfig:
type: object
properties:
_id:
type: string
example: 63ef5d3cc8d82a2da6d83db0
email:
type: boolean
example: true
whatsApp:
type: boolean
example: true
description:
type: string
example: Hey there brother
domainActive:
type: boolean
example: false
domainCreated:
type: string
example: '2023-01-12T12:00:54.442Z'
domainExpires:
type: string
example: '2023-02-25T10:23:50.199Z'
domainName:
type: string
example: staar.pre
domainPeriod:
type: number
example: 1
domainPurchaseOnQshop:
type: boolean
example: true
domainValidated:
type: boolean
example: false
email:
type: string
example: adeyinkabadmus@gmail.com
expandPolicy:
type: boolean
example: false
firstLaunch:
type: string
example: '2021-12-03T07:54:38.595Z'
flutterwaveAcctInfo:
type: object
properties:
account_bank:
type: string
example: '044'
account_id:
type: number
example: 1845025
account_number:
type: string
example: '0697325039'
bank_name:
type: string
example: ACCESS BANK NIGERIA
business_name:
type: string
example: Egoli
country:
type: string
example: NG
created_at:
type: string
example: '2022-10-07T10:57:11.000Z'
full_name:
type: string
example: Forrest Green
id:
type: number
example: 18000
meta:
nullable: true
example: null
split_ratio:
type: number
example: 1
split_type:
type: string
example: percentage
split_value:
type: number
example: 0.04
subaccount_id:
type: string
example: RS_0EB1BBE6A3054B1626CA9BECE5994BD3
hideLogo:
type: boolean
example: false
instaAuth:
type: string
example: >-
IGQVJXUXB0SWVPeWNoTk1MbFNKWkhpaXlfMnM3blljcU9RaHU4LUNlSWh6RDg0bVNsYlE0TUtjQXc4VDNLSm1hcFljanV5VGs2WlBTbVhZASXRCc3V4WDNia1V5QkM0TFBJUDhOVC1R
instaAuthDateExpires:
type: string
example: '2022-06-20T12:57:31.973Z'
instagram:
type: string
example: newtonlovestocode
inventoryConfig:
type: object
properties:
_id:
type: string
example: 63d3308668c893478d07c1bd
displayOptionKey:
type: string
example: always
displayOptionKeyId:
type: string
example: 624d9757733a4a29e8ec0d81
enableProductPageStockCount:
type: boolean
example: false
isLowStockEnabled:
type: boolean
example: true
isOutOfStockEnabled:
type: boolean
example: true
lowStockThreshold:
type: number
example: 50
outOfStockThreshold:
type: number
example: 9
storefrontDisplaySoldOut:
type: boolean
example: false
launched:
type: boolean
example: true
logo_uuid:
type: string
example: c912279d-1e23-4a55-a939-26e4fa734c68
mig_updated:
type: boolean
example: true
modified:
type: string
example: '2022-04-12T14:11:01.079Z'
name:
type: string
example: Egoli
owner:
type: string
example: 61a956551a113f7e13c45c10
paused:
type: boolean
example: false
paymentError:
type: array
items:
type: object
properties:
data:
type: object
properties:
data:
nullable: true
example: null
msg:
type: string
example: Error!
success:
type: boolean
example: false
date:
type: string
example: '2022-02-23T09:52:35.952Z'
platform:
type: string
example: flutterwave
example:
- data:
data: null
msg: Error!
success: false
date: '2022-02-23T09:52:35.952Z'
platform: flutterwave
paymentMethods:
type: array
items:
type: string
example: 616c5714bc454798c50d7add
example:
- 616c5714bc454798c50d7add
- 5ee8ada78d362db318828297
- 62253a53eb629b0f831614d1
- 5ee79950eea46308e8f84868
- 625c396a7a8687194e375d07
paystackAcctNo:
type: string
example: ACCT_ew3ivl3oa56j1np
pickupLocation:
type: string
example: 5 Eastpark avenue, Mowe
products:
type: number
example: 80
referralCode:
type: string
example: 61a961291a113f7e13c45c27
returnPolicy:
type: string
example: Exchange again and again
shippingPolicy:
type: string
example: Pick up update again
shippingRates:
type: array
items:
type: object
properties:
_id:
type: string
example: 5ee6a1a5eea46308e8f84843
countryCode:
type: string
example: NG
enableShipping:
type: boolean
example: true
name:
type: string
example: Abia
rate:
type: number
nullable: true
example: 2000
example:
- _id: 5ee6a1a5eea46308e8f84843
countryCode: NG
enableShipping: true
name: Abia
rate: 2000
- _id: 5ee6a281eea46308e8f84844
countryCode: NG
enableShipping: true
name: Adamawa
rate: null
- _id: 5ee6a281eea46308e8f84845
countryCode: NG
enableShipping: true
name: Akwa Ibom
rate: null
shopCategory:
type: string
example: 61a9303ef2a5bc507fc0b1f7
shopPreview:
type: string
example: '2022-06-28T12:53:02.499Z'
shop_url:
type: string
example: codely
slug:
type: string
example: egoli-3
slugLastUpdated:
type: string
example: '2022-10-30T13:17:19.421Z'
socials:
type: array
items:
type: object
properties:
_id:
type: string
example: 63239fbfc563fc9332fb932e
auth:
type: string
nullable: true
example: >-
IGQVJYSnlndjdFVjlPTy1Kelptb055UTduNnJUTjB6SDhtMTF3RFFZAQUpKMjZABcVluUV9sc2dXbTR2Vk9vb2x0ZAnhlMlEtTVBqa19KLTZAsZA0FhSF8xczk2UkNlRzctSlduU0pTM0JR
authExpires:
type: string
nullable: true
example: '2023-04-21T13:19:01.540Z'
id:
type: string
example: '6894675363891920'
name:
type: string
example: Instagram
slug:
type: string
example: instagram
url:
type: string
example: https://instagram.com/newtonlovestocode
username:
type: string
nullable: true
example: newtonlovestocode
example:
- _id: 63239fbfc563fc9332fb932e
auth: >-
IGQVJYSnlndjdFVjlPTy1Kelptb055UTduNnJUTjB6SDhtMTF3RFFZAQUpKMjZABcVluUV9sc2dXbTR2Vk9vb2x0ZAnhlMlEtTVBqa19KLTZAsZA0FhSF8xczk2UkNlRzctSlduU0pTM0JR
authExpires: '2023-04-21T13:19:01.540Z'
id: '6894675363891920'
name: Instagram
slug: instagram
url: https://instagram.com/newtonlovestocode
username: newtonlovestocode
- _id: 6323b21c8f5489dedb1ca6f0
auth: null
authExpires: null
id: +234 903 436 2570
name: Whatsapp
slug: whatsapp
url: https://wa.me/2349034362570
username: null
state:
type: string
example: 62c80815c9d738e14b8988e5
status:
type: string
example: active
subscription:
type: object
properties:
__v:
type: number
example: 0
_id:
type: string
example: 640614021e9d0f5cc82ee44a
amount:
type: number
example: 0
billingCycle:
type: string
example: free
billingNotice:
type: string
example: '2023-03-06T16:25:38.044Z'
currency:
type: string
example: 630bfb78e50744001d860921
description:
type: string
example: Auto downgrade due to subscription expiration
email:
type: string
example: adeyinkabadmus@gmail.com
expires:
type: string
example: '2123-03-06T16:25:38.044Z'
paymentDate:
type: string
example: '2023-03-06T16:25:38.044Z'
paymentErrors:
type: array
items: {}
example: []
paymentPlatform:
nullable: true
example: null
paymentReference:
nullable: true
example: null
paymentSnapshot:
type: object
properties:
amount:
type: number
example: 0
paymentStatus:
type: string
example: 61b9d41f1cdf3b37551276e8
plan:
type: string
example: 62f4fe1ccef5cde11f8f9914
planCurrency:
type: string
example: 60aa6cd79aed9f2aa1b677db
recurringPayment:
type: boolean
example: false
referralLink:
nullable: true
example: null
shop:
type: string
example: 61a956d91a113f7e13c45c15
transactionId:
nullable: true
example: null
telephone:
type: string
example: '+2349034362570'
testShop:
type: boolean
example: false
thirtyDayReward:
type: boolean
example: true
whatsApp:
type: boolean
example: true
wizard_steps:
type: object
properties:
'1':
type: string
example: done
'2':
type: string
example: done
'3':
type: string
example: done
'4':
type: string
example: done
subscription:
type: object
properties:
__v:
type: number
example: 0
_id:
type: string
example: 640616130c0680cb9c85563b
amount:
type: number
example: 0
billingCycle:
type: string
example: free
billingNotice:
type: string
example: '2023-03-06T16:34:27.615Z'
currency:
type: string
example: 630bfb78e50744001d860921
description:
type: string
example: Auto downgrade due to subscription expiration
email:
type: string
example: adeyinkabadmus@gmail.com
expires:
type: string
example: '2123-03-06T16:34:27.615Z'
paymentDate:
type: string
example: '2023-03-06T16:34:27.615Z'
paymentErrors:
type: array
items: {}
example: []
paymentPlatform:
nullable: true
example: null
paymentReference:
nullable: true
example: null
paymentSnapshot:
type: object
properties:
amount:
type: number
example: 0
paymentStatus:
type: string
example: 61b9d41f1cdf3b37551276e8
plan:
type: string
example: 62f4fe1ccef5cde11f8f9914
planCurrency:
type: string
example: 60aa6cd79aed9f2aa1b677db
recurringPayment:
type: boolean
example: false
referralLink:
nullable: true
example: null
shop:
type: string
example: 61a956d91a113f7e13c45c15
transactionId:
nullable: true
example: null
example:
event: shop
props:
shop:
__v: 83
_id: 61a956d91a113f7e13c45c15
area: 62f2e2efa65b7319b3b4715f
bio: We love football
call: true
city: 62d46bb079344c34996b2c47
country: 628c8d3c21ce8313e6293c8e
created: '2021-12-02T23:29:29.317Z'
currencies:
- 629dd54ac046650e6cb78b74
- 629dd54ac046650e6cb78b75
- 630bfb78e50744001d860921
customerNotificationConfig:
_id: 63ef5d3cc8d82a2da6d83db0
email: true
whatsApp: true
description: Hey there brother
domainActive: false
domainCreated: '2023-01-12T12:00:54.442Z'
domainExpires: '2023-02-25T10:23:50.199Z'
domainName: staar.pre
domainPeriod: 1
domainPurchaseOnQshop: true
domainValidated: false
email: adeyinkabadmus@gmail.com
expandPolicy: false
firstLaunch: '2021-12-03T07:54:38.595Z'
flutterwaveAcctInfo:
account_bank: '044'
account_id: 1845025
account_number: '0697325039'
bank_name: ACCESS BANK NIGERIA
business_name: Egoli
country: NG
created_at: '2022-10-07T10:57:11.000Z'
full_name: Forrest Green
id: 18000
meta: null
split_ratio: 1
split_type: percentage
split_value: 0.04
subaccount_id: RS_0EB1BBE6A3054B1626CA9BECE5994BD3
hideLogo: false
instaAuth: >-
IGQVJXUXB0SWVPeWNoTk1MbFNKWkhpaXlfMnM3blljcU9RaHU4LUNlSWh6RDg0bVNsYlE0TUtjQXc4VDNLSm1hcFljanV5VGs2WlBTbVhZASXRCc3V4WDNia1V5QkM0TFBJUDhOVC1R
instaAuthDateExpires: '2022-06-20T12:57:31.973Z'
instagram: newtonlovestocode
inventoryConfig:
_id: 63d3308668c893478d07c1bd
displayOptionKey: always
displayOptionKeyId: 624d9757733a4a29e8ec0d81
enableProductPageStockCount: false
isLowStockEnabled: true
isOutOfStockEnabled: true
lowStockThreshold: 50
outOfStockThreshold: 9
storefrontDisplaySoldOut: false
launched: true
logo_uuid: c912279d-1e23-4a55-a939-26e4fa734c68
mig_updated: true
modified: '2022-04-12T14:11:01.079Z'
name: Egoli
owner: 61a956551a113f7e13c45c10
paused: false
paymentError:
- data:
data: null
msg: Error!
success: false
date: '2022-02-23T09:52:35.952Z'
platform: flutterwave
paymentMethods:
- 616c5714bc454798c50d7add
- 5ee8ada78d362db318828297
- 62253a53eb629b0f831614d1
- 5ee79950eea46308e8f84868
- 625c396a7a8687194e375d07
paystackAcctNo: ACCT_ew3ivl3oa56j1np
pickupLocation: 5 Eastpark avenue, Mowe
products: 80
referralCode: 61a961291a113f7e13c45c27
returnPolicy: Exchange again and again
shippingPolicy: Pick up update again
shippingRates:
- _id: 5ee6a1a5eea46308e8f84843
countryCode: NG
enableShipping: true
name: Abia
rate: 2000
- _id: 5ee6a281eea46308e8f84844
countryCode: NG
enableShipping: true
name: Adamawa
rate: null
- _id: 5ee6a281eea46308e8f84845
countryCode: NG
enableShipping: true
name: Akwa Ibom
rate: null
shopCategory: 61a9303ef2a5bc507fc0b1f7
shopPreview: '2022-06-28T12:53:02.499Z'
shop_url: codely
slug: egoli-3
slugLastUpdated: '2022-10-30T13:17:19.421Z'
socials:
- _id: 63239fbfc563fc9332fb932e
auth: >-
IGQVJYSnlndjdFVjlPTy1Kelptb055UTduNnJUTjB6SDhtMTF3RFFZAQUpKMjZABcVluUV9sc2dXbTR2Vk9vb2x0ZAnhlMlEtTVBqa19KLTZAsZA0FhSF8xczk2UkNlRzctSlduU0pTM0JR
authExpires: '2023-04-21T13:19:01.540Z'
id: '6894675363891920'
name: Instagram
slug: instagram
url: https://instagram.com/newtonlovestocode
username: newtonlovestocode
- _id: 6323b21c8f5489dedb1ca6f0
auth: null
authExpires: null
id: +234 903 436 2570
name: Whatsapp
slug: whatsapp
url: https://wa.me/2349034362570
username: null
state: 62c80815c9d738e14b8988e5
status: active
subscription:
__v: 0
_id: 640614021e9d0f5cc82ee44a
amount: 0
billingCycle: free
billingNotice: '2023-03-06T16:25:38.044Z'
currency: 630bfb78e50744001d860921
description: Auto downgrade due to subscription expiration
email: adeyinkabadmus@gmail.com
expires: '2123-03-06T16:25:38.044Z'
paymentDate: '2023-03-06T16:25:38.044Z'
paymentErrors: []
paymentPlatform: null
paymentReference: null
paymentSnapshot:
amount: 0
paymentStatus: 61b9d41f1cdf3b37551276e8
plan: 62f4fe1ccef5cde11f8f9914
planCurrency: 60aa6cd79aed9f2aa1b677db
recurringPayment: false
referralLink: null
shop: 61a956d91a113f7e13c45c15
transactionId: null
telephone: '+2349034362570'
testShop: false
thirtyDayReward: true
whatsApp: true
wizard_steps:
'1': done
'2': done
'3': done
'4': done
subscription:
__v: 0
_id: 640616130c0680cb9c85563b
amount: 0
billingCycle: free
billingNotice: '2023-03-06T16:34:27.615Z'
currency: 630bfb78e50744001d860921
description: Auto downgrade due to subscription expiration
email: adeyinkabadmus@gmail.com
expires: '2123-03-06T16:34:27.615Z'
paymentDate: '2023-03-06T16:34:27.615Z'
paymentErrors: []
paymentPlatform: null
paymentReference: null
paymentSnapshot:
amount: 0
paymentStatus: 61b9d41f1cdf3b37551276e8
plan: 62f4fe1ccef5cde11f8f9914
planCurrency: 60aa6cd79aed9f2aa1b677db
recurringPayment: false
referralLink: null
shop: 61a956d91a113f7e13c45c15
transactionId: null
responses:
'200':
description: ''
````