Skip to content
Specs API

List products (paginated)

GET
/v1/products

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page
integer
default: 1 >= 1
per_page
integer
default: 50 >= 1 <= 100
locale
string
Allowed values: en-US pt-PT

Optional locale for product names; falls back to default locale.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Paginated list of products

object
items
required
Array<object>
object
id
required
integer
slug
required
string
name
string
nullable
gtin13
string
nullable
gtin14
string
nullable
mpn
string
nullable
brand
required
string
page
required
integer
per_page
required
integer
total
required
integer
hasNext
required
boolean

Headers

Section titled “Headers ”
X-Total-Count
integer

Total number of products available

Link
string

Pagination links (rel=“first”, “prev”, “next”, “last”)

401

Section titled “401 ”

Unauthorized

object
error
required
object
code
required
string
message
required
string