Get markets

GET

markets

Get markets

curl --request GET \
  --url https://api.cevoid.com/v1/markets \
  --header 'x-api-key: <api-key>'

{
  "count": 123,
  "next": "<string>",
  "nodes": [
    {
      "id": "market_us_123abc",
      "shortId": "us",
      "title": "United States",
      "country": "US",
      "currency": "USD",
      "language": "en",
      "domain": "https://store.example.com",
      "default": true,
      "createdAt": "2024-01-10T08:00:00.000Z",
      "updatedAt": "2024-01-15T12:45:30.000Z",
      "customId": "us-market",
      "settings": {}
    }
  ]
}

Authorizations

x-api-key

string

header

required

Query Parameters

limit

number

default:25

Max value for limit is 25

Required range: 1 <= x <= 25

Example:

10

skip

number | null

default:0

Number of items to skip

Required range: x >= 0

Example:

0

Response

Successful response

count

number

required

Total number of items

string | null

required

URL for next page

nodes

object[]

required

Show child attributes

nodes.id

string

required

Unique identifier for the market within the Cevoid system

Example:

"market_us_123abc"

nodes.shortId

string

required

Shortened, human-readable identifier for the market, typically used in URLs and API calls

Example:

"us"

nodes.title

string

required

Display name of the market, typically representing the country or region

Example:

"United States"

nodes.country

string

required

ISO 3166-1 alpha-2 country code representing the geographic market location

Example:

"US"

nodes.currency

string

required

ISO 4217 currency code used for pricing and transactions within this market

Example:

"USD"

nodes.language

string

required

ISO 639-1 language code representing the primary language for content and communications in this market

Example:

"en"

nodes.domain

string

required

Primary domain URL or website associated with this market, used for e-commerce store integration

Example:

"https://store.example.com"

nodes.default

boolean

required

Indicates whether this market serves as the default/fallback market when no specific market is selected

Example:

true

nodes.createdAt

string

required

ISO 8601 timestamp indicating when this market was first created in the system

Example:

"2024-01-10T08:00:00.000Z"

nodes.updatedAt

string

required

ISO 8601 timestamp indicating when this market was last updated

Example:

"2024-01-15T12:45:30.000Z"

nodes.customId

string

Custom identifier for the market, alternative to shortId

Example:

"us-market"

nodes.settings

any | null

Market-specific configuration and settings object

Example:

{}

Get market by IDRetrieve a specific market by its ID or shortId

⌘I

Get markets

curl --request GET \
  --url https://api.cevoid.com/v1/markets \
  --header 'x-api-key: <api-key>'

{
  "count": 123,
  "next": "<string>",
  "nodes": [
    {
      "id": "market_us_123abc",
      "shortId": "us",
      "title": "United States",
      "country": "US",
      "currency": "USD",
      "language": "en",
      "domain": "https://store.example.com",
      "default": true,
      "createdAt": "2024-01-10T08:00:00.000Z",
      "updatedAt": "2024-01-15T12:45:30.000Z",
      "customId": "us-market",
      "settings": {}
    }
  ]
}

Core Concepts

Posts

Markets

Members

Authorizations

Query Parameters

Response