API Reference

Get products

get
https://api.sandbox.oysterskin.com/api/v1/products

Get paginated list of products with filtering options. Customers can optionally restrict the response to their personal recommendations by setting recommended_for_me=true.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
Defaults to 1

Page number for pagination

integer
Defaults to 15

Number of items per page

string

Search term for product name, description, or ingredients

string
enum

Filter by product status

Allowed:
integer

Filter by category ID

integer

Filter by brand ID

integer

Filter by vendor ID

boolean
enum

When set to true, return only products that the routine engine has recommended to the authenticated customer. If the customer has no recommendations yet, falls back to onboarding-based scoring (skin type, skin-care goals, and currency-aware budget via the user's spend_range). False-equivalent values are rejected; omit this parameter to disable personalized filtering.

Allowed:
string
enum

Filter by stock status

Allowed:
price_range
array of numbers
length between 2 and 2

Filter by price range [min, max]

price_range

Filter by ingredients (comma-separated or array)

Filter by allergens (comma-separated or array)

skin_types
array of integers

Filter by skin types (array of IDs)

skin_types
boolean

Filter products with discount

boolean

Filter products with images

string
enum

Filter by data source

Allowed:
string
enum

Sort field

Allowed:
string
enum
Defaults to desc

Sort order

Allowed:
Response

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?