Shops

Updates a specific shop.

put/v1/shops/{shopId}/update

Request

Request body

namestring required

Must not be greater than 255 characters.

subdomainstring required

Must match the regex /^(?!-)[A-Za-z0-9-]+(?<!-)$/. Must not be greater than 255 characters.

logo_image_idstring nullable

Must match an existing stored value.

favicon_image_idstring nullable

Must match an existing stored value.

background_image_idstring nullable

Must match an existing stored value.

discord_client_idstring nullable

Must not be greater than 30 characters.

discord_client_secretstring nullable

Must not be greater than 64 characters.

discord_bot_tokenstring nullable

Must not be greater than 100 characters.

discord_login_enabledboolean nullable
crisp_website_idstring nullable

Must not be greater than 40 characters.

tawkto_idstring nullable

Must not be greater than 40 characters.

gtag_idstring nullable

Must not be greater than 30 characters.

gtm_idstring nullable

Must not be greater than 30 characters.

meta_pixel_idstring nullable

Must not be greater than 30 characters.

trustpilot_afs_emailstring nullable

Must be a valid email address. Must match the regex /@invite.trustpilot.com$/i. Must not be greater than 255 characters.

descriptionstring nullable

Must not be greater than 65535 characters.

meta_titlestring nullable

Must not be greater than 255 characters.

meta_descriptionstring nullable

Must not be greater than 65535 characters.

meta_image_idstring nullable

Must match an existing stored value.

meta_twitter_card'summary' | 'summary_large_image'
invoice_headerstring nullable

Must not be greater than 65535 characters.

invoice_notesstring nullable

Must not be greater than 65535 characters.

invoice_footerstring nullable

Must not be greater than 65535 characters.

invoice_attach_emailboolean nullable
tax_enabledboolean nullable
tax_rateinteger nullable

Must be at least 0. Must not be greater than 100.

tax_countriesobject nullable
force_custom_domainboolean nullable
refund_out_of_stock_to_customer_balanceboolean nullable
hide_out_of_stock_productsboolean nullable
hide_out_of_stock_variantsboolean nullable
require_shipping_zoneboolean nullable
noindexboolean
powered_by_enabledboolean nullable
maintenance_enabledboolean nullable
maintenance_passwordstring nullable

Must not be greater than 255 characters.

currencystring nullable

Must be 3 characters.

default_language'en' | 'ar' | 'de' | 'es' | 'fa' | 'fi' | 'fr' | 'he' | 'hi' | 'hr' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'nl' | 'pl' | 'pt' | 'ro' | 'ru' | 'sv' | 'tr' | 'uk' | 'vi' | 'zh' nullable
enabled_languagesstring[]

Example request

{
  "name": "tjqotbhpzwonwlzospqcs",
  "subdomain": "nssrciatkmatldznkaapj",
  "discord_client_id": "ptdhyldmarwuvlvyfcejz",
  "discord_client_secret": "olbxnqyvzmcgyfpncfyst",
  "discord_bot_token": "nonjizoohlpabvwbfbzkw",
  "discord_login_enabled": true,
  "crisp_website_id": "sewlxtdfjxskykaapbpdx",
  "tawkto_id": "voinjyyjgewzrvldmtkty",
  "gtag_id": "kspxnwtkwmotupuntpewa",
  "gtm_id": "eqmxearmqdrugeraqymfe",
  "meta_pixel_id": "gawtjymzjryiswgvrvsnl",
  "trustpilot_afs_email": "hills.rory@example.com",
  "description": "Dignissimos et officiis eius.",
  "meta_title": "xdnpytwkzmrivvydpytrx",
  "meta_description": "enarcdhbxnxeohvqqinls",
  "meta_twitter_card": "summary",
  "invoice_header": "eqaclxvxvxxogzgeajuzg",
  "invoice_notes": "zyecwzbckqdwpluwpkfke",
  "invoice_footer": "wfylathpaxyvlxlkwxicy",
  "invoice_attach_email": true,
  "tax_enabled": true,
  "tax_rate": 16,
  "force_custom_domain": true,
  "powered_by_enabled": true,
  "maintenance_enabled": true,
  "maintenance_password": "tncjtuqjtrzfffyaseegy",
  "currency": "xqk",
  "default_language": "hr",
  "enabled_languages": [
    "it"
  ]
}

Changes

    • breaking

      request property / was restricted to a list of enum values

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      added the new ar enum value to the request property /

    • info

      added the new de enum value to the request property /

    • info

      added the new en enum value to the request property /

    • info

      added the new es enum value to the request property /

    • info

      added the new fa enum value to the request property /

    • info

      added the new fi enum value to the request property /

    • info

      added the new fr enum value to the request property /

    • info

      added the new he enum value to the request property /

    • info

      added the new hi enum value to the request property /

    • info

      added the new hr enum value to the request property /

    • info

      added the new hu enum value to the request property /

    • info

      added the new id enum value to the request property /

    • info

      added the new it enum value to the request property /

    • info

      added the new ja enum value to the request property /

    • info

      added the new ko enum value to the request property /

    • info

      added the new nl enum value to the request property /

    • info

      added the new pl enum value to the request property /

    • info

      added the new pt enum value to the request property /

    • info

      added the new ro enum value to the request property /

    • info

      added the new ru enum value to the request property /

    • info

      added the new sv enum value to the request property /

    • info

      added the new tr enum value to the request property /

    • info

      added the new uk enum value to the request property /

    • info

      added the new vi enum value to the request property /

    • info

      added the new zh enum value to the request property /

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property