Create product (Vendor)

Create a new product as a vendor.

category and category_id are resolved against the canonical Oyster taxonomy.
Names are matched insensitively to case and punctuation, and known older vendor
names are accepted, but a value that cannot be resolved — including a retired
category id — is rejected rather than filed as uncategorised. The error names the
value and, where there is an obvious one, suggests a real category. Leave both
empty to have the product classified automatically.

Oyster lists face and body skincare only. A category outside that range (shampoo,
conditioner, styling, makeup, fragrance, supplements, tools & devices, baby, grooming)
is rejected with an error saying so, and a product left blank that the classifier
later files under one of them is removed rather than listed. The same rule applies
to every row of a bulk upload.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

Vendor ID

string
required

Product name

string

Brand name (will create if doesn't exist)

integer

Existing brand ID

float
required

Product price

string

Currency code

string

Product description

string

Usage instructions

string

Product weight

string

Product volume. When omitted or 0, a size stated in the product name (e.g. "… 200ml") is used.

string
required

Stock keeping unit

float

Discount percentage

integer

Stock level

boolean

Flag this product as a best seller (boosts recommendation ranking).

ingredients

Product ingredients (array of strings or semicolon-separated string). An element that is itself a list (two or more commas, or bullets) is split. A placeholder list carrying a disclaimer such as "refer to the product packaging" is stored as only the actives it names.

string

Comma-separated tags

allergens

Product allergens (array of strings or comma-separated string)

integer

Category ID

skin_types
array of integers

Array of skin type IDs

skin_types
images
array of files
required

Product images

uri

Source URL

meta
object

Additional metadata

string
enum

Product status

Allowed:
boolean

Whether to auto-create brands

Responses

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