Skip to main content
GET
Get Products

Authorizations

Authorization
string
header
required

You can retrieve your API key from your dashboard under Account > Developers.

Path Parameters

shopId
integer
required

The shop ID.

Body

application/json
page
integer

Page number.

Example:

1

perPage
integer

Items per page, 1-100. Must be at least 1. Must not be greater than 100.

Example:

null

orderColumn
enum<string>
Available options:
id,
name,
price,
stock,
products_sold,
dashboard_order
Example:

null

orderDirection
enum<string>
Available options:
asc,
desc
Example:

null

type
enum<string>
Available options:
variant,
addon
Example:

null

ids
integer[]

Filter by product IDs.

Example:

null

paths
string[]

Filter by product paths.

Example:

null

name
string

Filter by product name.

Example:

null

variant_name
string

Filter by variant name.

Example:

null

visibilities
string[]
Example:

null

group_ids
integer[]

Filter by group IDs.

Example:

null

group_null
boolean

Only products without a group.

Example:

null

badge_text
string
Example:

null

status_text
string
Example:

null

deliverable
string

Filter by deliverable content.

Example:

null

deliverables_type
string
Example:

null

all
string

Include all relation data (variants, badges, tabs, custom fields, addons, upsells).

Example:

null

Response

200 - application/json
current_page
integer
Example:

1

data
object[]
Example:
first_page_url
string
Example:

"http://api.sellauth.test/v1/shops/1/products?page=1"

from
integer
Example:

1

last_page
integer
Example:

1

last_page_url
string
Example:

"http://api.sellauth.test/v1/shops/1/products?page=1"

Example:
next_page_url
string
Example:

null

path
string
Example:

"http://api.sellauth.test/v1/shops/1/products"

per_page
integer
Example:

20

prev_page_url
string
Example:

null

to
integer
Example:

1

total
integer
Example:

1