barcodeProducts

Access product data from the Erudus data pool.

Typical usage involves calling the List Products endpoint to find products of interest and those that have recently been updated. The Get Product end point can then be called to obtain the complete data set for a product.

circle-exclamation

Product data is returned in JSON format inside the data element. A full product specification includes data structured inside several sub-sections and one or more inner components. The data values are collected together in related sections, for example "allergens" or "nutrients".

Each product complies to a specification type schema. Each product can therefore contain different sets of attributes depending on its type and whether data has been provided by the manufacturer of the product.

List Products

get

Get a paginated list of products. Use next in response to get cursor value for next page.

Authorizations
AuthorizationstringRequired

You can retrieve your token by visiting your dashboard and clicking Manage API tokens.

Query parameters
sortstringOptional

Sort results by changed_at, manufacturer_product_name. Prefixing with a hyphen will reverse order. Defaults to '-changed_at'.

Example: manufacturer_product_name
filter[manufacturer]integerOptional

Filter by ID of manufacturer.

Example: 23
filter[brand]integerOptional

Filter by ID of brand.

Example: 2
filter[label]integerOptional

Filter by ID of label.

Example: 3
filter[manufacturer_product_code]stringOptional

Filter by manufacturer product code.

Example: PR300
filter[changed_at]stringOptional

Filter by date product changed equal to (eq:), greater than (gt:) or less than a date (lt:).

Example: gt:2024-10-12
filter[status]stringOptional

Filter by product's current status, i.e. published or archived. Defaults to 'published,archived'.

Example: published
cursorstringOptional

Cursor hash value for next page.

Example: eyJjaGFuZ2VkX2F0IjoiMjAyNS0wNC0yMiAwODoxMjowOCIsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0
limitintegerOptional

Number of records per page.

Example: 0
countintegerOptional

Flag to request return of count value for query.

Example: 0
Responses
chevron-right
200Success
application/json
Responseone of
or
get
/v2/products
200Success

Get Product

get

Retrieve data for a single product using the unique Erudus ID reference.

Authorizations
AuthorizationstringRequired

You can retrieve your token by visiting your dashboard and clicking Manage API tokens.

Path parameters
productstringRequired

The Erudus ID of the product.

Example: 7bc42964412a4566b3daa77bd6daf275
Query parameters
versionstringOptional

Get a specific version of the product.

Example: version=1.1
outputstringOptional

Sets an alternative output format to raw, flat or ungroup.

Example: output=ungroup
Responses
chevron-right
200Success
application/json
get
/v2/products/{product}

Get Product by GTIN

get

Performs a lookup using the Outer GTIN (traded unit GTIN).

Authorizations
AuthorizationstringRequired

You can retrieve your token by visiting your dashboard and clicking Manage API tokens.

Path parameters
gtinstringRequired

The Outer GTIN of the product.

Example: 05010052076644
Responses
chevron-right
200Success
application/json
get
/v2/products/gtin/{gtin}

Get Product PDF

get

Download Product PDF.

This will return the Erudus PDF product specification.

Authorizations
AuthorizationstringRequired

You can retrieve your token by visiting your dashboard and clicking Manage API tokens.

Path parameters
productstringRequired

The Erudus ID of the product.

Example: 7bc42964412a4566b3daa77bd6daf275
Query parameters
versionstringOptional

Get a specific version of the product.

Example: version=1.1
Responses
get
/v2/products/{product}/pdf
401Error

Last updated