Products

Get product

Returns information about a specific product or product variant.

GEThttps://api.cevoid.com/v2/products/{id}

Request

curl 'https://api.cevoid.com/v2/products/prd_abc123def456gh' \
  -H "Authorization: Bearer ${CEVOID_API_KEY}"

fetch("https://api.cevoid.com/v2/products/prd_abc123def456gh", {
  headers: {
    Authorization: `Bearer ${process.env.CEVOID_API_KEY}`,
  },
})
  .then((response) => response.json())
  .then((data) => console.log(data))

const response = await fetch("https://api.cevoid.com/v2/products/prd_abc123def456gh", {
  headers: {
    Authorization: `Bearer ${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/v2/products/prd_abc123def456gh",
    headers={
        "Authorization": f"Bearer {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/v2/products/prd_abc123def456gh',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . 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/v2/products/prd_abc123def456gh", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer " + 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/v2/products/prd_abc123def456gh")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{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

{
  "data": {
    "id": "prd_abc123def456gh",
    "type": "PRODUCT",
    "market_id": "mar_sweden",
    "external_id": "shopify_product_123",
    "title": "Merino crew neck",
    "sku": "MERINO-CREW",
    "url": "https://shop.example.com/products/merino-crew",
    "image_url": "https://cdn.cevoid.com/products/merino-crew/0.jpg",
    "availability": "IN_STOCK",
    "price": {
      "currency": "SEK",
      "min_amount": 799,
      "max_amount": 999
    }
  }
}

{
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "request_id": "req_abc123"
}

{
  "status": 403,
  "code": "forbidden",
  "message": "Forbidden",
  "request_id": "req_abc123"
}

{
  "additional_data": {
    "errors": [
      {
        "field": "query.market",
        "message": "Invalid input: expected string, received array"
      }
    ]
  },
  "status": 404,
  "code": "not_found",
  "message": "Route not found",
  "request_id": "req_abc123"
}

{
  "additional_data": {
    "errors": [
      {
        "field": "query.market",
        "message": "Invalid input: expected string, received array"
      }
    ]
  },
  "status": 422,
  "code": "validation_error",
  "message": "Validation error",
  "request_id": "req_abc123"
}

{
  "status": 429,
  "code": "rate_limit_exceeded",
  "message": "Rate limit exceeded",
  "request_id": "req_abc123",
  "additional_data": {
    "retry_after_seconds": 1
  }
}

{
  "status": 500,
  "code": "internal_server_error",
  "message": "Internal server error",
  "request_id": "req_abc123"
}

Authorizations

Authorizationbearer tokenheaderrequired

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

Path parameters

idstringrequired

Cevoid product or variant ID.

Example: prd_abc123def456gh

Query parameters

marketstring

Market ID used to resolve localized data. Omit to use the default market.

Example: mar_sweden

Response

200 Successful response application/json

dataobjectrequired

Requested resource.

Option 1: object

market_idstringrequired

Cevoid market ID for this product presentation.

Example: mar_sweden

external_idstring

Product identifier from the connected commerce platform.

Example: shopify_product_123

titlestring

Market-specific product title.

Example: Merino crew neck

variant_titlestring

Market-specific variant option label.

Example: Navy / M

skustring

Market-specific stock keeping unit.

Example: MERINO-NAVY-M

urlstring<uri>

Storefront URL for the selected market presentation.

Example: https://shop.example/products/merino-crew

image_urlstring<uri>

Primary image for the selected market presentation.

Example: https://cdn.cevoid.com/products/merino-crew/0.jpg

availabilityenum<string>

Availability for the selected market presentation.

Allowed values: IN_STOCK OUT_OF_STOCK
Example: IN_STOCK

idstringrequired

Cevoid product or variant ID.

Example: prd_abc123def456gh

typeenum<string>required

Product family.

Allowed value: PRODUCT
Example: PRODUCT

priceobject

Market-specific Product price range.

Properties (3)

currencystringrequired

ISO 4217 currency code.

Example: SEK

min_amountnumberrequired

Lowest Variant price.

Range: 0 <= x
Example: 799

max_amountnumberrequired

Highest Variant price.

Range: 0 <= x
Example: 999

Option 2: object

market_idstringrequired

Cevoid market ID for this product presentation.

Example: mar_sweden

external_idstring

Product identifier from the connected commerce platform.

Example: shopify_product_123

titlestring

Market-specific product title.

Example: Merino crew neck

variant_titlestring

Market-specific variant option label.

Example: Navy / M

skustring

Market-specific stock keeping unit.

Example: MERINO-NAVY-M

urlstring<uri>

Storefront URL for the selected market presentation.

Example: https://shop.example/products/merino-crew

image_urlstring<uri>

Primary image for the selected market presentation.

Example: https://cdn.cevoid.com/products/merino-crew/0.jpg

availabilityenum<string>

Availability for the selected market presentation.

Allowed values: IN_STOCK OUT_OF_STOCK
Example: IN_STOCK

idstringrequired

Cevoid product or variant ID.

Example: prd_abc123def456gh

typeenum<string>required

Purchasable Product variant.

Allowed value: VARIANT
Example: VARIANT

parent_product_idstringrequired

Cevoid product ID. Present when type is VARIANT.

Example: prd_abc123def456gh

priceobject

Market-specific Variant price.

Properties (3)

currencystringrequired

ISO 4217 currency code.

Example: SEK

amountnumberrequired

Current Variant price.

Range: 0 <= x
Example: 899

sale_amountnumber

Sale price when active.

Range: 0 <= x
Example: 799

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

404 Not found 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