v1

latestOpenAPI 3.0.42026-07-2685196386.6 KB
Product

Update product affiliate discount

Updates affiliate discount configuration of a product. Requires the stores.products.update permission.

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

Path parameters

storeIdstring uuid required

The ID of the store.

productIdstring uuid required

The ID of the product to update.

Request body

affiliateDiscountMode0 | 1 | 2 required

Defines how affiliate discounts should be applied to a product.

customAffiliateDiscountPercentageinteger nullable

Custom affiliate discount percentage (0-100) when AffiliateDiscountMode is set to Custom. If null or when mode is not Custom, this value is ignored and the affiliate's PercentageOff is used.

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}