Update store settings

PATCH
/admin/store

Authorization

headerx-api-key<token>

Organization-scoped API key with scope metadata.

Request Body

application/json
  1. body
name?
description?|

Shown on the store. Send null to remove it.

logo?|string
favicon?string
currency?string
Match^[A-Za-z]{3}$
locale?string
Value in"en""pt""es"
timezone?string
country?string
contactEmail?|

Shown on the store and to customers. Send null to remove it.

contactPhone?|

Send null to remove it.

address?string
socialLinks?

Response Body

Success

application/json
  1. response
name*
description*|null
logo*string|null
favicon*string|null
currency*string
locale*string
timezone*string
country*string
supportedCurrencies*array<string>
supportedLocales*array<string>
contactEmail*string|null
contactPhone*string|null
address*string|null
socialLinks*|null
currencyLocked*boolean
Example Request
curl -X PATCH 'https://api-prood.vercel.app/v1/admin/store' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "name": {    "property1": "string",    "property2": "string"  },  "description": {    "property1": "string",    "property2": "string"  },  "logo": "string",  "favicon": "string",  "currency": "string",  "locale": "string",  "timezone": "string",  "country": "string",  "supportedCurrencies": [    "string"  ],  "supportedLocales": [    "string"  ],  "contactEmail": "string",  "contactPhone": "string",  "address": "string",  "socialLinks": {    "property1": "string",    "property2": "string"  },  "currencyLocked": true}