Markets

Get market by ID

Retrieve a specific market by its ID or shortId

GEThttps://api.cevoid.com/v1/markets/{id}

Request

curl 'https://api.cevoid.com/v1/markets/us' \
  -H "x-api-key: ${CEVOID_API_KEY}"

fetch("https://api.cevoid.com/v1/markets/us", {
  headers: {
    "x-api-key": process.env.CEVOID_API_KEY,
  },
})
  .then((response) => response.json())
  .then((data) => console.log(data))

const response = await fetch("https://api.cevoid.com/v1/markets/us", {
  headers: {
    "x-api-key": process.env.CEVOID_API_KEY,
  },
})
if (!response.ok) throw new Error(`Request failed: ${response.status}`)
const data = await response.json()
console.log(data)

import os

import requests

response = requests.get(
    "https://api.cevoid.com/v1/markets/us",
    headers={
        "x-api-key": os.environ["CEVOID_API_KEY"],
    },
)
response.raise_for_status()
print(response.json())

<?php

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.cevoid.com/v1/markets/us',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'x-api-key: ' . getenv('CEVOID_API_KEY'),
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://api.cevoid.com/v1/markets/us", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("x-api-key", os.Getenv("CEVOID_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}

require "net/http"

uri = URI("https://api.cevoid.com/v1/markets/us")
request = Net::HTTP::Get.new(uri)
request["x-api-key"] = ENV.fetch("CEVOID_API_KEY")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.body

Response

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

"string"

"No valid API key provided"

"Could not find market"

"Something went wrong"

Authorizations

x-api-keystringheaderrequired

Send your API key in the x-api-key header.

Path parameters

idstringrequired

Market ID or shortId

Example: us

Response

200 Successful response application/json

idstringrequired

Unique identifier for the market within the Cevoid system

Example: market_us_123abc

shortIdstringrequired

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

Example: us

titlestringrequired

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

Example: United States

customIdstring

Custom identifier for the market, alternative to shortId

Example: us-market

countrystringrequired

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

Example: US

currencystringrequired

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

Example: USD

languagestringrequired

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

Example: en

domainstringrequired

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

Example: https://store.example.com

defaultbooleanrequired

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

Example: true

settingsany | null

Market-specific configuration and settings object

Example: {}

createdAtstringrequired

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

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

updatedAtstringrequired

ISO 8601 timestamp indicating when this market was last updated

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

400 Bad request application/json

string

401 Unauthorized application/json

enum<string>

No valid API key provided

404 Not found application/json

enum<string>

Could not find market

500 Internal server error application/json

enum<string>

Something went wrong