Skip to content
Specs API

Retrieve product specs by slug (returns JSON-LD)

GET
/v1/specs/{slug}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
slug
required
string

Query Parameters

Section titled “Query Parameters ”
locale
string
Allowed values: en-US pt-PT

Optional locale. If absent, Accept-Language header is used.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Product specs in JSON-LD (schema.org ProductModel)

object
@context
required
string
Example
https://schema.org
@type
required
string
Example
ProductModel
name
required
string
sku
required
string
category
string
brand
required
object
@type
required
string
Example
Brand
name
required
string
gtin13
string
gtin14
string
mpn
string
additionalProperty
required
Array<object>
object
@type
required
string
Example
PropertyValue
name
required
string
value
required
string
unitCode
string
unitText
string
inLanguage
required
string

400

Section titled “400 ”

Invalid request (bad locale, etc.)

object
error
required
object
code
required
string
message
required
string

401

Section titled “401 ”

Unauthorized (when API_KEY is set on the server)

object
error
required
object
code
required
string
message
required
string

404

Section titled “404 ”

Product not found

object
error
required
object
code
required
string
message
required
string