Skip to main content
PUT
Update 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.

Body

application/json
name
string
required

Must not be greater than 255 characters.

Example:

"pasyzwszwtxpeqq"

subdomain
string
required

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

Example:

"ikymwkiinfowtzm"

logo_image_id
string
Example:

null

favicon_image_id
string
Example:

null

background_image_id
string
Example:

null

discord_url
string

Must be a valid URL. Must not be greater than 255 characters.

Example:

"http://www.volkman.com/dignissimos-error-et-itaque-quibusdam-tempora-velit"

youtube_url
string

Must be a valid URL. Must not be greater than 255 characters.

Example:

"http://wisoky.com/explicabo-eligendi-occaecati-debitis-et-saepe-eum"

telegram_url
string

Must be a valid URL. Must not be greater than 255 characters.

Example:

"https://cummings.org/ipsum-inventore-sed-libero-et.html"

tiktok_url
string

Must be a valid URL. Must not be greater than 255 characters.

Example:

"https://www.mccullough.com/deserunt-laudantium-quibusdam-enim-nostrum-soluta-qui-ipsam-non"

instagram_url
string

Must be a valid URL. Must not be greater than 255 characters.

Example:

"http://jenkins.org/"

discord_client_id
string

Must not be greater than 30 characters.

Example:

"agqzitsslufxbon"

discord_client_secret
string

Must not be greater than 64 characters.

Example:

"cxhcsddnacixfxg"

discord_bot_token
string

Must not be greater than 100 characters.

Example:

"smpbolpwypthgxn"

discord_login_enabled
boolean
Example:

false

crisp_website_id
string

Must not be greater than 40 characters.

Example:

"ysmpobtnyrwnubz"

tawkto_id
string

Must not be greater than 40 characters.

Example:

"pcclwldceqpnviy"

gtag_id
string

Must not be greater than 30 characters.

Example:

"qjogqswwhqqtqjg"

gtm_id
string

Must not be greater than 30 characters.

Example:

"hjxtodzarmjbcub"

meta_pixel_id
string

Must not be greater than 30 characters.

Example:

"bljkbkjttcfoszg"

trustpilot_afs_email
string

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

Example:

"mario.mayert@example.org"

description
string

Must not be greater than 65535 characters.

Example:

"Rerum exercitationem est rem."

meta_title
string

Must not be greater than 255 characters.

Example:

"ctqmzsbvhoayvnd"

meta_description
string

Must not be greater than 65535 characters.

Example:

"tbvsnyfgnguxbsm"

meta_image_id
string
Example:

null

meta_twitter_card
enum<string>
Available options:
summary,
summary_large_image
Example:

"summary_large_image"

invoice_header
string

Must not be greater than 65535 characters.

Example:

"ezpaxzmtcdhmgla"

invoice_notes
string

Must not be greater than 65535 characters.

Example:

"esduhcpozpojzeu"

Must not be greater than 65535 characters.

Example:

"sgsepklwggloodq"

invoice_attach_email
boolean
Example:

true

tax_enabled
boolean
Example:

true

tax_rate
integer

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

Example:

4

tax_countries
object
Example:

null

force_custom_domain
boolean
Example:

true

refund_out_of_stock_to_customer_balance
boolean
Example:

false

hide_out_of_stock_products
boolean
Example:

false

hide_out_of_stock_variants
boolean
Example:

true

require_shipping_zone
boolean
Example:

true

noindex
boolean
Example:

true

powered_by_enabled
boolean
Example:

false

maintenance_enabled
boolean
Example:

true

maintenance_password
string

Must not be greater than 255 characters.

Example:

"aojzdbsajohfbtv"

currency
string

Must be 3 characters.

Example:

"tvu"

default_language
enum<string>
Available options:
en,
ar,
de,
es,
fa,
fi,
fr,
he,
hi,
hu,
id,
it,
ja,
ko,
nl,
pl,
pt,
ro,
ru,
sv,
tr,
uk,
vi,
zh
Example:

"he"

enabled_languages
string[]
Example:

Response

200 - undefined