Skip to main content
GET
Get Shop

Authorizations

Authorization
string
header
required

You can retrieve your API key from your dashboard under Account > Developers.

Path Parameters

shopId
integer
required

The shop ID.

Response

200 - application/json
id
integer
Example:

1

created_at
string
Example:

"2026-09-20T15:56:23.000000Z"

updated_at
string
Example:

"2026-09-20T15:56:23.000000Z"

name
string
Example:

"Demo Shop"

subdomain
string
Example:

"demo-shop"

logo_image_id
string
Example:

null

favicon_image_id
string
Example:

null

background_image_id
string
Example:

null

owner_id
integer
Example:

1

description
string
Example:

null

currency
string
Example:

"USD"

default_language
string
Example:

null

enabled_languages
string
Example:

null

meta_title
string
Example:

null

meta_description
string
Example:

null

meta_image_id
string
Example:

null

meta_twitter_card
string
Example:

"summary"

discord_url
string
Example:

null

youtube_url
string
Example:

null

telegram_url
string
Example:

null

tiktok_url
string
Example:

null

instagram_url
string
Example:

null

theme_id
string
Example:

null

deleted_at
string
Example:

null

crisp_website_id
string
Example:

null

tawkto_id
string
Example:

null

gtag_id
string
Example:

null

gtm_id
string
Example:

null

meta_pixel_id
string
Example:

null

discord_client_id
string
Example:

null

discord_client_secret
string
Example:

null

discord_bot_token
string
Example:

null

discord_login_enabled
boolean
Example:

false

termination_reason
string
Example:

null

termination_internal_reason
string
Example:

null

terminated_at
string
Example:

null

termination_appeal
string
Example:

null

products_sold
integer
Example:

0

products_sold_offset
integer
Example:

0

total_customers
integer
Example:

0

total_completed_invoices
string
Example:

null

total_customers_offset
integer
Example:

0

total_feedbacks
integer
Example:

0

average_rating
string
Example:

"0.00"

webhook_secret
string
Example:

"4d3aa09bd7887cd0bd40bd64e829adf34cdf8dd46be389e723b7c170ad166dae"

invoice_header
string
Example:

null

invoice_notes
string
Example:

null

Example:

null

invoice_attach_email
boolean
Example:

false

tax_enabled
boolean
Example:

false

tax_rate
string
Example:

null

tax_countries
string
Example:

null

maintenance_enabled
integer
Example:

0

refund_out_of_stock_to_customer_balance
boolean
Example:

false

trustpilot_afs_email
string
Example:

null

force_custom_domain
boolean
Example:

true

hide_out_of_stock_products
boolean
Example:

false

hide_out_of_stock_variants
boolean
Example:

false

require_shipping_zone
integer
Example:

1

noindex
boolean
Example:

false

powered_by_enabled
boolean
Example:

false

product_limit_override
string
Example:

null

legacy_team_limits
boolean
Example:

false

url
string
Example:

"http://demo-shop.mysellauth.test:80"

is_subscribed
boolean
Example:

true

subscription_ends_at
string
Example:

"2036-09-20T15:56:23.000000Z"

subscription_plan
object
subscription_source
string
Example:

"paid"

team_member_limit
integer
Example:

10

logo_image_url
string
Example:

null

activity_log_enabled
boolean
Example:

true

pivot
object
subscription
object
active_grant
string
Example:

null

payment_methods
object[]
Example:
verified_domain
string
Example:

null

logo_image
string
Example:

null