docs
  1. Admin Api
  2. Resources
  3. Custom Data
  4. Shop
  5. Shop Custom Data By Key

Shop custom data by key

Get shop custom data for a specific key

Rate Limit: 2000 Max attempts within 1 minute.

Path Parameters

ParameterDetails
shopKey
  • required
string
Example:
ms
key
  • required
string
Example:
score

Responses

200
Shop custom data for a specific key
application/json
Success
property name
null
401
Unauthorized
application/json
Error
404
Not Found
application/json
Error
GET/shops/{shopKey}/custom-data/{key}

Request samples

Response samples

200
Shop Custom Data For Key:
Content type: application/json
Create or update shop custom data for a specific key

Rate Limit: 1000 Max attempts within 1 minute.

Path Parameters

ParameterDetails
shopKey
  • required
string
Example:
ms
key
  • required
string
Example:
score

Query Parameters

ParameterDetails
locale
  • MaxLength: 5
string
Example:
de_DE

Request body

required
ParameterDetails
-
  • MinProps: 1
object

Responses

201
Shop custom data was successfully created or updated.
application/json
Success
property name
null
400
Bad Request
application/json
Error
401
Unauthorized
application/json
Error
404
Not Found
application/json
Error
PUT/shops/{shopKey}/custom-data/{key}

Request samples

Response samples

201
Shop Custom Data:
Content type: application/json
Delete shop custom data for a specific key

Rate Limit: 1000 Max attempts within 1 minute.

Path Parameters

ParameterDetails
shopKey
  • required
string
Example:
ms
key
  • required
string
Example:
score

Query Parameters

ParameterDetails
locale
  • MaxLength: 5
string
Example:
de_DE

Responses

204
Shop custom data for a specific key was successfully deleted.
Success
400
Bad Request
application/json
Error
401
Unauthorized
application/json
Error
404
Not Found
application/json
Error
DELETE/shops/{shopKey}/custom-data/{key}

Request samples

Last updated: June 19, 2024

Provide Feedback