Shops

Get Shop

Retrieves a specific shop.

get/v1/shops/{shopId}

Response

idinteger
created_atstring
updated_atstring
namestring
subdomainstring
logo_image_idstring
favicon_image_idstring
background_image_idstring
owner_idinteger
descriptionstring
currencystring
default_languagestring
enabled_languagesstring
meta_titlestring
meta_descriptionstring
meta_image_idstring
meta_twitter_cardstring
termsstring
privacy_policystring
refund_policystring
discord_urlstring
youtube_urlstring
telegram_urlstring
tiktok_urlstring
instagram_urlstring
theme_idstring
deleted_atstring
crisp_website_idstring
tawkto_idstring
gtag_idstring
gtm_idstring
meta_pixel_idstring
discord_client_idstring
discord_client_secretstring
discord_bot_tokenstring
termination_reasonstring
termination_internal_reasonstring
terminated_atstring
termination_appealstring
products_soldinteger
products_sold_offsetinteger
total_customersinteger
total_completed_invoicesstring
total_customers_offsetinteger
total_feedbacksinteger
average_ratingstring
webhook_secretstring
invoice_headerstring
invoice_notesstring
invoice_footerstring
invoice_attach_emailboolean
tax_enabledboolean
tax_ratestring
tax_countriesstring
tickets_enabledboolean
maintenance_enabledinteger
refund_out_of_stock_to_customer_balanceboolean
trustpilot_afs_emailstring
force_custom_domainboolean
hide_out_of_stock_productsboolean
require_shipping_zoneinteger
noindexboolean
powered_by_enabledboolean
urlstring
is_subscribedboolean
subscription_ends_atstring
subscription_sourcestring
logo_image_urlstring
activity_log_enabledboolean
active_grantstring
verified_domainstring
logo_imagestring

Example response

{
  "id": 1,
  "created_at": "2026-08-28T18:23:02.000000Z",
  "updated_at": "2026-08-28T18:23:02.000000Z",
  "name": "Demo Shop",
  "subdomain": "demo-shop",
  "logo_image_id": null,
  "favicon_image_id": null,
  "background_image_id": null,
  "owner_id": 1,
  "description": null,
  "currency": "USD",
  "default_language": null,
  "enabled_languages": null,
  "meta_title": null,
  "meta_description": null,
  "meta_image_id": null,
  "meta_twitter_card": "summary",
  "terms": null,
  "privacy_policy": null,
  "refund_policy": null,
  "discord_url": null,
  "youtube_url": null,
  "telegram_url": null,
  "tiktok_url": null,
  "instagram_url": null,
  "theme_id": null,
  "deleted_at": null,
  "crisp_website_id": null,
  "tawkto_id": null,
  "gtag_id": null,
  "gtm_id": null,
  "meta_pixel_id": null,
  "discord_client_id": null,
  "discord_client_secret": null,
  "discord_bot_token": null,
  "termination_reason": null,
  "termination_internal_reason": null,
  "terminated_at": null,
  "termination_appeal": null,
  "products_sold": 0,
  "products_sold_offset": 0,
  "total_customers": 0,
  "total_completed_invoices": null,
  "total_customers_offset": 0,
  "total_feedbacks": 0,
  "average_rating": "0.00",
  "webhook_secret": "bda0dde14f8a0ce924459ecafcbdf92da6276276d2c0fc87082c3019d787de37",
  "invoice_header": null,
  "invoice_notes": null,
  "invoice_footer": null,
  "invoice_attach_email": false,
  "tax_enabled": false,
  "tax_rate": null,
  "tax_countries": null,
  "tickets_enabled": true,
  "maintenance_enabled": 0,
  "refund_out_of_stock_to_customer_balance": false,
  "trustpilot_afs_email": null,
  "force_custom_domain": true,
  "hide_out_of_stock_products": false,
  "require_shipping_zone": 1,
  "noindex": false,
  "powered_by_enabled": false,
  "url": "http://demo-shop.mysellauth.test:80",
  "is_subscribed": true,
  "subscription_ends_at": "2036-08-28T18:23:02.000000Z",
  "subscription_plan": {
    "id": "scale",
    "name": "Scale",
    "product_id": 801686,
    "price": 29.99,
    "rank": 2,
    "referral_bonus": 0.1,
    "has_custom_domain": true,
    "has_custom_pages": true,
    "has_custom_notes": true,
    "has_manual_payment_method": true,
    "has_feedback_dispute": true,
    "has_priority_dispute_resolution": true,
    "has_feedback_image": true,
    "has_feedback_disable": true,
    "has_blacklist_advanced_types": true,
    "has_whitelist_advanced_types": true,
    "has_email_templates": true,
    "has_smtp": true,
    "has_discord_remove_role": true,
    "has_checkout_api": true,
    "has_checkout_custom_css": true,
    "has_beta_features": true,
    "has_abandoned_checkouts": true,
    "has_subscriptions": true,
    "has_ai_theme_editor": true,
    "has_reseller_panel": true,
    "has_email_marketing": true,
    "has_email_automations": true,
    "has_email_tracking": true,
    "product_limit": 5000,
    "variant_per_product_limit": 1000,
    "image_per_product_limit": 50,
    "gif_frame_limit": 5000,
    "team_member_limit": 50,
    "blacklist_limit": 5000,
    "whitelist_limit": 5000,
    "cart_item_limit": 100,
    "downloadable_file_limit": 500,
    "downloadable_file_max_size_mb": 100,
    "affiliate_tier_limit": 500,
    "affiliate_limit": 10000,
    "reseller_tier_limit": 500,
    "reseller_limit": 10000,
    "blog_post_limit": 500,
    "coupon_limit": 50000,
    "email_monthly_send_limit": 50000,
    "email_campaign_limit": 500,
    "email_list_limit": 100,
    "email_contact_limit": 100000,
    "email_marketing_template_limit": 100,
    "email_automation_limit": 20,
    "email_send_rate_per_minute": 200,
    "min_feedback_price_usd": 0,
    "webp_quality": 98,
    "image_max_size_mb": 50,
    "theme_asset_file_max_size_mb": 10
  },
  "subscription_source": "paid",
  "logo_image_url": null,
  "activity_log_enabled": true,
  "pivot": {
    "user_id": 1,
    "shop_id": 1,
    "role": "owner"
  },
  "subscription": {
    "id": 1,
    "shop_id": 1,
    "plan": "scale",
    "renewal_method": "manual",
    "product_subscription_id": null,
    "cancel_at_period_end": false,
    "ends_at": "2036-08-28T18:23:02.000000Z",
    "rate_usd_per_day": null,
    "previous_plan": null,
    "switched_at": null,
    "expiry_reminder_stage": 0,
    "created_at": "2026-08-28T18:23:02.000000Z",
    "updated_at": "2026-08-28T18:23:02.000000Z",
    "deleted_at": null
  },
  "active_grant": null,
  "payment_methods": [
    {
      "id": 1,
      "shop_id": 1,
      "type": "stripe",
      "name": "Stripe",
      "checkout_name": null,
      "icon_image_id": null,
      "percentage_fee": 0,
      "fixed_fee": 0,
      "min_amount": null,
      "max_amount": null,
      "currency_override": null,
      "hide_powered_by": false,
      "is_active": true,
      "order": 0,
      "created_at": "2026-08-28T18:23:02.000000Z",
      "updated_at": "2026-08-28T18:23:02.000000Z",
      "deleted_at": null,
      "icon_image_url": null,
      "icon_image": null
    },
    {
      "id": 2,
      "shop_id": 1,
      "type": "CUSTOMERBALANCE",
      "name": "Customer Balance",
      "checkout_name": null,
      "icon_image_id": null,
      "percentage_fee": 0,
      "fixed_fee": 0,
      "min_amount": null,
      "max_amount": null,
      "currency_override": null,
      "hide_powered_by": false,
      "is_active": true,
      "order": 0,
      "created_at": "2026-08-28T18:23:02.000000Z",
      "updated_at": "2026-08-28T18:23:02.000000Z",
      "deleted_at": null,
      "icon_image_url": null,
      "icon_image": null
    }
  ],
  "verified_domain": null,
  "logo_image": null
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.