Skip to main content
PUT
Replaces all customizable badges on a product with the provided set.

Authorizations

Authorization
string
header
required

Your API key goes here

Path Parameters

storeId
string<uuid>
required

The ID of the store the product belongs to.

productId
string<uuid>
required

The ID of the product.

Body

application/json

The complete set of badges to apply.

label
string
required

The label text shown on the badge (e.g. "Best Seller").

Maximum string length: 32
order
integer<int32>
required

The display order of the badge relative to other badges on the same product.

Required range: 0 <= x <= 2147483647
color
string | null

The badge color as a hex value (e.g. "#22c55e") or a short named color. Optional.

Maximum string length: 9
Pattern: ^#([A-Fa-f0-9]{3,8})$|^[a-zA-Z]{1,9}$

Response

The object was successfully updated.

Represents a default generic response for API endpoints.

success
boolean
required

Indicates whether the operation or response was successful.

message
string | null

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

code
string | null

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

data
object[] | null

Represents the data associated with a response.

Last modified on August 2, 2026