Shops
Get Shops
Retrieves all your shops.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Create Shop
Creates a new shop.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
multipart/form-dataRequirednameRequiredstringsubdomainRequiredstringMust match the regex /^(?!-)[A-Za-z0-9-]+(?<!-)$/.
logofileMust be an image.
"binary"Get Shop
Retrieves a specific shop.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
Delete Shop
Deletes a specific shop.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredpasswordRequiredstringnameRequiredstringPath Parameters
shopIdRequiredintegerThe shop ID.
Update Shop
Updates a specific shop.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequirednameRequiredstringsubdomainRequiredstringMust match the regex /^(?!-)[A-Za-z0-9-]+(?<!-)$/.
logo_image_idstringfavicon_image_idstringbackground_image_idstringdiscord_urlstringMust be a valid URL.
youtube_urlstringMust be a valid URL.
telegram_urlstringMust be a valid URL.
tiktok_urlstringMust be a valid URL.
instagram_urlstringMust be a valid URL.
discord_client_idstringMust not be greater than 255 characters.
discord_client_secretstringMust not be greater than 255 characters.
discord_bot_tokenstringMust not be greater than 255 characters.
crisp_website_idstringMust not be greater than 255 characters.
tawkto_idstringMust not be greater than 255 characters.
gtag_idstringMust not be greater than 255 characters.
trustpilot_afs_emailstringMust be a valid email address. Must match the regex /@invite.trustpilot.com$/i.
descriptionstringMust not be greater than 65535 characters.
meta_titlestringMust not be greater than 255 characters.
meta_descriptionstringMust not be greater than 65535 characters.
meta_image_idstringmeta_twitter_cardstring"summary" | "summary_large_image"termsstringMust not be greater than 65535 characters.
privacy_policystringMust not be greater than 65535 characters.
refund_policystringMust not be greater than 65535 characters.
enable_automatic_feedbackbooleanhide_automatic_feedbacks_on_homebooleaninvoice_headerstringMust not be greater than 65535 characters.
invoice_notesstringMust not be greater than 65535 characters.
invoice_footerstringMust not be greater than 65535 characters.
invoice_attach_emailbooleantax_enabledbooleantax_ratenumberMust be at least 0. Must not be greater than 100.
tax_countriesobjectMust not have more than 255 items.
smtp_hoststringMust not be greater than 255 characters.
smtp_portnumbersmtp_usernamestringMust not be greater than 255 characters.
smtp_passwordstringMust not be greater than 255 characters.
smtp_encryptionstring"ssl" | "tls"smtp_fromstringMust be a valid email address.
smtp_namestringMust not be greater than 255 characters.
show_coupon_inputbooleanshow_terms_checkboxbooleanshow_newsletter_checkboxbooleantickets_enabledbooleanaffiliate_enabledbooleanaffiliate_publicbooleanaffiliate_code_editablebooleanaffiliate_percentagenumberMust be at least 0. Must not be greater than 100.
force_custom_domainbooleanrefund_out_of_stock_to_customer_balancebooleanmaintenance_enabledbooleanmaintenance_passwordstringMust not be greater than 255 characters.
Path Parameters
shopIdRequiredintegerThe shop ID.
Get Shop Stats
Retrieves shop statistics.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.