Shops
Get Shops
Retrieves all your shops.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Create Shop
Creates a new shop.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
multipart/form-data
Requiredname
Requiredstringsubdomain
RequiredstringMust match the regex /^[A-Za-z0-9-]+$/.
logo
fileMust be an image.
"binary"
Get Shop
Retrieves a specific shop.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
RequiredintegerDelete Shop
Deletes a specific shop.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/json
Requiredpassword
Requiredstringname
RequiredstringPath Parameters
shopId
RequiredintegerUpdate Shop
Updates a specific shop.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/json
Requiredname
Requiredstringsubdomain
RequiredstringMust match the regex /^[A-Za-z0-9-]+$/.
logo_image_id
stringfavicon_image_id
stringbackground_image_id
stringdiscord_url
stringMust be a valid URL.
youtube_url
stringMust be a valid URL.
telegram_url
stringMust be a valid URL.
tiktok_url
stringMust be a valid URL.
instagram_url
stringMust be a valid URL.
discord_client_id
stringMust not be greater than 255 characters.
discord_client_secret
stringMust not be greater than 255 characters.
discord_bot_token
stringMust not be greater than 255 characters.
crisp_website_id
stringMust not be greater than 255 characters.
tawkto_id
stringMust not be greater than 255 characters.
gtag_id
stringMust not be greater than 255 characters.
description
stringMust not be greater than 65535 characters.
terms
stringMust not be greater than 65535 characters.
enable_automatic_feedback
booleanhide_automatic_feedbacks_on_home
booleaninvoice_header
stringMust not be greater than 65535 characters.
invoice_notes
stringMust not be greater than 65535 characters.
invoice_footer
stringMust not be greater than 65535 characters.
invoice_attach_email
booleantax_enabled
booleantax_rate
numberMust be at least 0. Must not be greater than 100.
tax_countries
objectMust not have more than 255 items.
smtp_host
stringMust not be greater than 255 characters.
smtp_port
numbersmtp_username
stringMust not be greater than 255 characters.
smtp_password
stringMust not be greater than 255 characters.
smtp_encryption
string"ssl" | "tls"
smtp_from
stringMust be a valid email address.
smtp_name
stringMust not be greater than 255 characters.
show_terms_checkbox
booleanshow_newsletter_checkbox
booleanPath Parameters
shopId
RequiredintegerGet Shop Stats
Retrieves shop statistics.
Authorization
Authorization
RequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopId
Requiredinteger