docs
  1. Admin Api
  2. Resources
  3. Shops
  4. Update A Shop

Update a shop

Update an existing shop

Rate Limit: 300 Max attempts within 1 minute.

Path Parameters

ParameterDetails
shopKey
  • required
string
Example:
ms

Request body

required
ParameterDetails
id
  • readonly
integer
Example:
1
key
  • required
string
Example:
ms
name
  • required
string
Example:
My shop
logoUrl
  • nullable
string
Example:
images/logo.png
logoSource
  • writeonly
  • MinProps: 1
  • MaxProps: 1
object
url
string
Format:
uri
Example:
https://example.com/image.png
attachment
string
Format:
byte
Example:
U3dhZ2dlciByb2Nrcw==
active
  • readonly
boolean
Example:
true
deleted
  • readonly
boolean
priceGroupKey
  • nullable
string
Example:
myPriceGroup
shopCategoryTreeId
integer
Example:
1
companyId
integer
Example:
1
countries
object
countryCode
string
  • MinLength: 2
  • MaxLength: 2
Example:
DE
defaultLanguageCode
string
  • MaxLength: 5
Example:
de_DE
supportedLanguageCodes
array
url
string
Example:
https://www.example.com
currencyCode
string
  • nullable
Example:
EUR
customData
  • nullable
assortment
object
customData
  • nullable
object
  • MinProps: 1

Responses

200
Shop was successfully updated.
application/json
Success
id
integer
Example:
1
keyrequired
string
Example:
ms
namerequired
string
Example:
My shop
logoUrl
string
Example:
images/logo.png
object
active
boolean
Example:
true
deleted
boolean
priceGroupKey
string
Example:
myPriceGroup
shopCategoryTreeId
integer
Example:
1
companyId
integer
Example:
1
Array of object
null
400
Bad Request
application/json
Error
401
Unauthorized
application/json
Error
404
Not Found
application/json
Error
PUT/shops/{shopKey}

Request samples

Response samples

200
Shop:
Content type: application/json
Provide Feedback