Update Variant

Update variant basic information

curl --request PUT \
  --url https://api.komerza.com/stores/{storeId}/products/{productId}/variants/{variantId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "cost": 50000,
  "minimumQuantity": 50000,
  "maximumQuantity": 49999,
  "order": 5000,
  "type": 0,
  "stock": 1073741823,
  "stockMode": 0,
  "subscriptionPeriod": "<string>"
}
'

{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dateCreated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "cost": 50000,
    "deliveryTypes": [
      "<string>"
    ],
    "files": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "friendlyName": "<string>",
        "ipAddress": "<string>",
        "userId": "<string>"
      }
    ],
    "minimumQuantity": 123,
    "maximumQuantity": 123,
    "order": 123,
    "imageNames": [
      "<string>"
    ],
    "stock": 123,
    "stockMode": 0,
    "customFields": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "<string>",
        "identifier": "<string>",
        "type": "<string>",
        "isRequired": true,
        "options": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "customFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "label": "<string>",
            "value": "<string>",
            "order": 1073741823
          }
        ],
        "placeholder": "<string>",
        "hint": "<string>"
      }
    ],
    "dynamicUrl": "<string>",
    "deliveryMessage": "<string>",
    "metadata": "<string>"
  }
}

PUT

stores

{storeId}

products

{productId}

variants

{variantId}

Update variant basic information

curl --request PUT \
  --url https://api.komerza.com/stores/{storeId}/products/{productId}/variants/{variantId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "cost": 50000,
  "minimumQuantity": 50000,
  "maximumQuantity": 49999,
  "order": 5000,
  "type": 0,
  "stock": 1073741823,
  "stockMode": 0,
  "subscriptionPeriod": "<string>"
}
'

{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dateCreated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "cost": 50000,
    "deliveryTypes": [
      "<string>"
    ],
    "files": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "friendlyName": "<string>",
        "ipAddress": "<string>",
        "userId": "<string>"
      }
    ],
    "minimumQuantity": 123,
    "maximumQuantity": 123,
    "order": 123,
    "imageNames": [
      "<string>"
    ],
    "stock": 123,
    "stockMode": 0,
    "customFields": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "<string>",
        "identifier": "<string>",
        "type": "<string>",
        "isRequired": true,
        "options": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "customFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "label": "<string>",
            "value": "<string>",
            "order": 1073741823
          }
        ],
        "placeholder": "<string>",
        "hint": "<string>"
      }
    ],
    "dynamicUrl": "<string>",
    "deliveryMessage": "<string>",
    "metadata": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Your API key goes here

Path Parameters

storeId

string<uuid>

required

The store’s unique identifier.

productId

string<uuid>

required

The product’s unique identifier.

variantId

string<uuid>

required

The variant’s unique identifier.

Body

The form containing updated variant fields.

The form used to update a product variant's basic information.

name

string

required

The display name of the variant.

Required string length: 3 - 128

cost

number<double>

required

The cost of the variant (non-negative).

Required range: 0 <= x <= 100000

minimumQuantity

integer<int32>

required

Minimum quantity allowed per order (at least 1).

Required range: 1 <= x <= 100000

maximumQuantity

integer<int32>

required

Maximum quantity allowed per order. Set to -1 for unlimited.

Required range: -1 <= x <= 100000

order

integer<int32>

required

Sort order for display (at least 1).

Required range: 1 <= x <= 10000

type

enum<integer>

required

The type of product that is being sold

Available options:

0,

1

stock

integer<int32>

required

Stock quantity available (non-negative).

Required range: 0 <= x <= 2147483647

stockMode

enum<integer>

required

The stock calculation modes that are used

Available options:

0,

1,

2

subscriptionPeriod

string<date-span> | null

Subscription billing period. Null for one-time products.

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

Represents a configurable variant associated with a product, containing various properties such as pricing, stock, delivery options, and custom fields.

Show child attributes

data.id

string<uuid>

required

The unique identifier of the entity

data.dateCreated

string<date-time>

required

The date the entity was created in the database

data.name

string

required

The name of the variant.

Required string length: 3 - 128

data.productId

string<uuid>

required

Represents the unique identifier of the product associated with the variant.

data.storeId

string<uuid>

required

The unique identifier for the store associated with the variant.

data.cost

number<double>

required

The cost of the variant.

Required range: 0 <= x <= 100000

data.deliveryTypes

string[]

required

A list of delivery methods associated with the variant.

data.files

object[]

required

A collection of stored files associated with this variant.

Show child attributes

data.files.id

string<uuid>

required

The unique identifier of the entity

data.files.dateCreated

string<date-time>

required

The date the entity was created in the database

data.files.friendlyName

string

required

The friendly name of the file

Required string length: 1 - 128

data.files.ipAddress

string

required

The IP address which uploaded the file

Required string length: 1 - 45

data.files.userId

string

required

The ID of the user who uploaded the file

Required string length: 1 - 36

data.minimumQuantity

integer<int32>

required

The minimum quantity of the product variant required for a single order.

data.maximumQuantity

integer<int32>

required

The maximum quantity of the variant that can be purchased in a single order. A value of -1 indicates no limit.

data.order

integer<int32>

required

Indicates the display order of the variant in a sequence.

data.imageNames

string[]

required

A list of image file names associated with the variant.

data.stock

integer<int32>

required

Represents the quantity of items available for sale.

data.stockMode

enum<integer>

required

The stock calculation modes that are used

Available options:

0,

1,

2

data.customFields

object[]

required

Represents the collection of custom fields associated with the variant. Each custom field provides additional configuration or metadata related to the variant, such as labels, identifiers, or placeholders.

Show child attributes

data.customFields.id

string<uuid>

required

The unique identifier of the entity

data.customFields.dateCreated

string<date-time>

required

The date the entity was created in the database

data.customFields.variantId

string<uuid>

required

FK back to the parent Variant.

data.customFields.label

string

required

The display label for this custom field.

Required string length: 1 - 128

data.customFields.identifier

string

required

A machine-friendly identifier used in forms and storage.

Required string length: 1 - 64

data.customFields.type

string

required

The type of the field: "text", "textarea", "select", "checkbox", "radio", or "number".

Required string length: 1 - 256

data.customFields.isRequired

boolean

required

Whether filling out this field is mandatory.

data.customFields.options

object[]

required

The list of allowed options (only for select or radio fields).

Show child attributes

data.customFields.options.id

string<uuid>

required

The unique identifier of the entity

data.customFields.options.dateCreated

string<date-time>

required

The date the entity was created in the database

data.customFields.options.customFieldId

string<uuid>

required

FK back to the parent CustomField.

data.customFields.options.label

string

required

The user-facing label for this option.

Maximum string length: 128

data.customFields.options.value

string

required

The stored value for this option (often same as Label).

Maximum string length: 64

data.customFields.options.order

integer<int32>

required

Sort order among siblings.

Required range: 0 <= x <= 2147483647

data.customFields.placeholder

string | null

Placeholder text shown when the field is empty (for text/textarea).

Maximum string length: 256

data.customFields.hint

string | null

Help text displayed under the field.

Maximum string length: 512

data.dynamicUrl

string | null

Represents a dynamically generated or configurable URL associated with a variant.

Maximum string length: 2048

data.deliveryMessage

string | null

An optional message associated with the delivery of this variant.

Maximum string length: 4096

data.metadata

string | null

Miscellaneous metadata associated with the variant, this is used in migration to tie reviews/products

Maximum string length: 1000

Add License Keys

Update Delivery Settings

⌘I

API Documentation

Reference

User

Stores

Products

Categories

Variants

Coupons

Tickets

Customers

Orders

Reviews

Authorizations

Path Parameters

Body

Response