Skip to content
Get API key (opens in a new tab)

Markets

List markets

Returns a list of markets.

GEThttps://api.cevoid.com/v2/markets

Authorizations

Authorizationbearer tokenheaderrequired

Send Authorization: Bearer <key>, where the key is your API key.

Query parameters

cursorstring

Opaque cursor returned from a previous list response

  • Example: eyJpZCI6InBvc3RfMDEifQ
limitinteger

Page size between 1 and 100

  • Range: 1 <= x <= 100
  • Example: 25

Response

200 Successful response application/json

dataobject[]required

Items returned for this page.

Item properties (11)
idstringrequired

Cevoid market ID.

  • Example: mar_sweden
namestringrequired

Display name of the Market.

  • Example: Sweden
currencystringrequired

ISO 4217 currency code.

  • Example: SEK
countrystringrequired

ISO 3166-1 alpha-2 country code.

  • Example: SE
languagestringrequired

IETF BCP 47 locale.

  • Example: sv-SE
domainstring

Production storefront URL, when configured.

  • Example: https://store.example.com
staging_domainstring

Staging storefront URL, when configured.

  • Example: https://staging.store.example.com
defaultbooleanrequired

Whether this is the workspace fallback Market.

  • Example: true
settingsobjectrequired

Storefront formatting and product display settings.

Properties (9)
hide_pricesbooleanrequired

Whether storefront prices are hidden.

  • Example: false
round_pricesbooleanrequired

Whether displayed prices are rounded.

  • Example: false
display_decimalsbooleanrequired

Whether prices include decimals.

  • Example: true
currency_positionenum<string>required

Whether the currency symbol appears before or after the amount.

  • Allowed values: before after
  • Example: after
currency_displaystringrequired

Currency symbol or display text.

  • Example: kr
decimal_delimiterenum<string>required

Price decimal delimiter.

  • Allowed values: , .
  • Example: ,
thousand_separatorenum<string>required

Price thousands separator.

  • Allowed values: , .
  • Example:
unavailable_product_behaviorenum<string>required

How unavailable products are presented.

  • Allowed values: hide show_as_normal show_as_unavailable
  • Example: hide
out_of_stock_behaviorenum<string>required

How out-of-stock products are presented.

  • Allowed values: show_as_normal hide show_out_of_stock_text
  • Example: show_out_of_stock_text
created_atstring<date-time>required

ISO 8601 timestamp when the Market was created.

  • Example: 2024-01-10T08:00:00.000Z
updated_atstring<date-time>required

ISO 8601 timestamp when the Market was last updated.

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

Whether another page of results is available.

  • Example: true
next_cursorstring | nullrequired

Opaque cursor to request the next page, or null when the list is exhausted.

  • Example: eyJpZCI6InJlc291cmNlXzI1In0
Response headers (5)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

400 Bad request application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)
{key}any
statusnumberrequired

HTTP status code for the error response.

  • Example: 404
codestringrequired

Stable machine-readable error code.

  • Example: not_found
messagestringrequired

Human-readable description of the error.

  • Example: Route not found
request_idstring

Request identifier for support and tracing.

  • Example: req_abc123
Response headers (5)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

401 Unauthorized application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)
{key}any
statusnumberrequired

HTTP status code for the error response.

  • Example: 404
codestringrequired

Stable machine-readable error code.

  • Example: not_found
messagestringrequired

Human-readable description of the error.

  • Example: Route not found
request_idstring

Request identifier for support and tracing.

  • Example: req_abc123
Response headers (5)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

403 Forbidden application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)
{key}any
statusnumberrequired

HTTP status code for the error response.

  • Example: 404
codestringrequired

Stable machine-readable error code.

  • Example: not_found
messagestringrequired

Human-readable description of the error.

  • Example: Route not found
request_idstring

Request identifier for support and tracing.

  • Example: req_abc123
Response headers (5)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

422 Validation error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)
{key}any
statusnumberrequired

HTTP status code for the error response.

  • Example: 404
codestringrequired

Stable machine-readable error code.

  • Example: not_found
messagestringrequired

Human-readable description of the error.

  • Example: Route not found
request_idstring

Request identifier for support and tracing.

  • Example: req_abc123
Response headers (5)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

429 Too many requests application/json

additional_dataobjectrequired

Machine-readable rate-limit details.

Properties (2)
retry_after_secondsintegerrequired
  • Range: 0 <= x
{key}any
statusintegerrequired

HTTP status code.

  • Example: 404
codestringrequired

Stable machine-readable error code.

  • Example: not_found
messagestringrequired

Human-readable error description.

  • Example: Resource not found
request_idstring

Request identifier for support and tracing.

  • Example: req_abc123
Response headers (6)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

Retry-Afterinteger

Seconds to wait before retrying the request

500 Internal server error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)
{key}any
statusnumberrequired

HTTP status code for the error response.

  • Example: 404
codestringrequired

Stable machine-readable error code.

  • Example: not_found
messagestringrequired

Human-readable description of the error.

  • Example: Route not found
request_idstring

Request identifier for support and tracing.

  • Example: req_abc123
Response headers (5)
Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available