Sign in

v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB
Product

Bulk update products

Updates multiple products in one request. Requires the stores.products.update permission.

put/stores/{storeId}/products

Path parameters

storeIdstring uuid required

The ID of the store.

Request body

productIdsstring[] required

The list of product IDs to update

visibility0 | 1 | 2 | 3

List of product visibility (or privacy) levels

shouldBlockVirtualPrivateNetworksboolean nullable

Whether VPNs and proxies should be blocked from purchasing the products

blacklistedPaymentGatewaysstring[] nullable

The array of blacklisted payment methods for the products

isBestSellerboolean nullable

Whether to mark the products as bestsellers

descriptionstring nullable

The description of the products (supports markdown)

deliveryMessagestring nullable

The message to include in the delivery email when the product is delivered. This will be applied to ALL variants of the selected products.

affiliateDiscountMode0 | 1 | 2

Defines how affiliate discounts should be applied to a product.

customAffiliateDiscountPercentageinteger nullable

Custom affiliate discount percentage (0-100) when AffiliateDiscountMode is Custom

discordMode0 | 1

Determines when a customer is added to the Discord server and when they receive their role.

discordRequirement0 | 1 | 2

Determines whether Discord linking is required, optional, or disabled during checkout.

discordRoleIdstring nullable

Discord role ID to assign to all variants of the selected products. When set, all variants will be mapped to this Discord role.

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}