Update product (Vendor)

Update an existing product as a vendor.

Image URLs already stored for the product, or repeated within the request,
are ignored after trimming whitespace. Existing images retain their ordering
and mirrored local files; images_added counts only newly inserted images.
Explicit image removal happens before deduplication, so
remove_existing_images: true can replace images using the same URLs.

For bulk or shopify sources, sync_images: true reconciles the complete URL
array: retained images keep their IDs and local copies, missing images and
stored duplicates are removed, and the first image becomes primary. An empty
array clears the gallery. A missing or null array is rejected. Do not combine
reconciliation with explicit removal options. images_synced: true confirms
successful reconciliation.

A category or category_id that cannot be resolved, or that names a category
Oyster does not carry (hair care, makeup, fragrance, supplements, tools & devices,
baby, grooming), is declined: the product keeps its current category and the rest
of the edit is saved.

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

Product ID

Body Params
string

Product name

string

Brand name

integer

Brand ID

float

Product price

string

Currency code

string

Product description

string

Usage instructions

string

Product weight

string

Product volume

string

Stock keeping unit

float

Discount percentage

boolean

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

integer

Stock level

ingredients

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

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

Image URLs for bulk/shopify sources, otherwise uploaded image files.

images
boolean
Defaults to false

Reconcile a complete URL gallery for bulk/shopify sources. Requires images, allows an empty array, and cannot be combined with removal options.

boolean
Defaults to false

Delete all stored images before adding supplied images.

image_ids_to_remove
array of integers

Specific stored image IDs to remove.

image_ids_to_remove
string
enum
uri

Source URL

meta
object

Additional metadata

string
enum

Product status

Allowed:
boolean

Whether to auto-create brands

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
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