Get market by ID

Retrieve a specific market by its ID or shortId

GET /v1/markets/{id}

Get market by ID

cURL

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

200

{
  "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

Path Parameters

id · string · required

Market ID or shortId

Example:

"us"

Response

200

application/json

Successful response

id · string · required

Unique identifier for the market within the Cevoid system

Example:

"market_us_123abc"

shortId · string · required

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

Example:

"us"

title · string · required

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

Example:

"United States"

country · string · required

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

Example:

"US"

currency · string · required

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

Example:

"USD"

language · string · required

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

Example:

"en"

domain · string · required

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

Example:

"https://store.example.com"

default · boolean · required

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

Example:

true

createdAt · string · required

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

Example:

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

updatedAt · string · required

ISO 8601 timestamp indicating when this market was last updated

Example:

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

customId · string

Custom identifier for the market, alternative to shortId

Example:

"us-market"

settings · any | null

Market-specific configuration and settings object

Example:

{}