Store metadata

GET

/store

Authorization

headerx-api-key<token>

Organization-scoped API key with scope metadata.

Response Body

Success

application/json

response

name*

description*|null

logo*|null

currencies*array<>

locales*array<>

country*string

contactEmail*string|null

canTakeOrders*boolean

True when a payment provider is connected, or when that couldn't be checked. Paid orders are refused without one, whatever this says.

paymentMethods*array<>

How shoppers can pay, from the provider the store's checkout uses. Empty when that can't be read.

Example Request

curl -X GET 'https://api-prood.vercel.app/v1/store'

Example Request

curl -X GET 'https://api-prood.vercel.app/v1/store'

Example ResponseSchema

{
  "name": {
    "property1": "string",
    "property2": "string"
  },
  "description": {
    "property1": "string",
    "property2": "string"
  },
  "logo": {
    "url": "string",
    "alt": "string",
    "width": 0,
    "height": 0
  },
  "currencies": [
    {
      "code": "string",
      "symbol": "string",
      "isDefault": true
    }
  ],
  "locales": [
    {
      "code": "string",
      "name": "string",
      "direction": "ltr",
      "isDefault": true
    }
  ],
  "country": "string",
  "contactEmail": "string",
  "canTakeOrders": true,
  "paymentMethods": [
    "card"
  ]
}

{  "name": {    "property1": "string",    "property2": "string"  },  "description": {    "property1": "string",    "property2": "string"  },  "logo": {    "url": "string",    "alt": "string",    "width": 0,    "height": 0  },  "currencies": [    {      "code": "string",      "symbol": "string",      "isDefault": true    }  ],  "locales": [    {      "code": "string",      "name": "string",      "direction": "ltr",      "isDefault": true    }  ],  "country": "string",  "contactEmail": "string",  "canTakeOrders": true,  "paymentMethods": [    "card"  ]}

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Response Body