Create a shop

Create a new shop

Rate Limit: 300 Max attempts within 1 minute.

Request body

required

Parameter	Details
id readonly	integer Example: 1
key	string Example: ms
name	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 string MaxLength: 5 Example: de_DE url string Example: https://www.example.com currencyCode string nullable Example: EUR customData nullable object MinProps: 1 countryCode string required MinLength: 2 MaxLength: 2 Example: DE defaultLanguageCode string required MaxLength: 5 Example: de_DE supportedLanguageCodes array string MaxLength: 5 Example: de_DE url string required Example: https://www.example.com currencyCode required customData nullable object MinProps: 1 assortment object
customData nullable	object MinProps: 1

Responses

201

Shop was successfully created.

application/json

Success

integer

Example:

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:

companyId

integer

Example:

Array of object

null

400

Bad Request

application/json

Error

401

Unauthorized

application/json

Error

POST/shops

Request samples

Response samples

201

Shop:

Content type: application/json