v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB

Product

Update product

Updates basic information of a product. Requires the stores.products.update permission.

put/stores/{storeId}/products/{productId}

Path parameters

storeIdstring uuid required

The ID of the store.

productIdstring uuid required

The ID of the product to update.

Request body

namestring required

The name of the product, this is displayed publicly on the store page and marketplace

descriptionstring required

The description of the product, supports markdown and images from IMGBB only

isBestSellerboolean required

Whether the product should be marked as the bestseller on the user's store page, does nothing for the marketplace

slugstring nullable

The slug of the product, if null then the ID is used

visibility0 | 1 | 2 | 3 required

List of product visibility (or privacy) levels

metadatastring nullable

Custom metadata set by either the user or the system to store additional information about the product

Response

The object was successfully updated.

successboolean required

Indicates whether the operation or response was successful.

messagestring nullable

A descriptive message providing additional context or information about the response.

codestring nullable

The error code (if there was an error) to use when referencing the error

{"stackTrail":"components:schemas:ObjectResponse:properties:data","oasType":"schema","type":"unknown","description":"Represents the data associated with a response.","nullable":true}