Create or update variant price

Creates a new price or updates an existing price for a product variant in a specific market and store group.

PUT/api/v1/{team_slug}/{app_slug}/products/{product_id}/variants/{variant_id}/prices
API
Management
Updated
Apr 26, 2026

management-api:PUT:/api/v1/{team_slug}/{app_slug}/products/{product_id}/variants/{variant_id}/prices

Creates a new price or updates an existing price for a product variant in a specific market and store group.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: PUT
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/prices
  • Summary: Create or update variant price
  • Description: Creates a new price or updates an existing price for a product variant in a specific market and store group.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters3 parameters
NameInRequiredTypeDescription
variant_idpathYesstringVariant ID
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
Request bodyDocumented body
  • Required: Yes
  • Description: Price data including market, store group, and pricing details
  • Content: application/json (object)

Input Price

PropertyTypeRequiredDetails
amount_cents_with_taxintegerNomin: 0
dont_update_price_if_on_salebooleanNoUsed to prevent overwriting price if on_sale.
market_slugstringYes-
on_salebooleanNo-
reference_price_with_taxintegerNomin: 0
sale_end_timestampstringNo-
sale_price_with_taxintegerNomin: 0
sale_start_timestampstringNo-
statusenum("active", "inactive", "draft")Yes-
store_group_slugstringYes-

Generated example (synthetic):

{
  "amount_cents_with_tax": 0,
  "dont_update_price_if_on_sale": false,
  "market_slug": "string",
  "on_sale": false,
  "reference_price_with_tax": 0,
  "sale_end_timestamp": "string",
  "sale_price_with_tax": 0,
  "sale_start_timestamp": "string",
  "status": "active",
  "store_group_slug": "string"
}
Responses4 statuses
StatusDescriptionContent
200Created or updated price with store group and market detailsapplication/json (object)
400Invalid request (e.g. bad UUID, validation error)application/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Product Price Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Product Variant Price With Store Group
PropertyTypeRequiredDetails
amount_cents_with_taxintegerNo-
created_atstringNo-
idstringNo-
marketobjectNo-
on_salebooleanNo-
reference_price_with_taxintegerNo-
sale_end_timestampstringNo-
sale_price_with_taxintegerNo-
sale_start_timestampstringNo-
statusenum("active", "inactive", "draft")No-
store_groupobjectNo-
updated_atstringNo-
Market
PropertyTypeRequiredDetails
activebooleanNo-
country_codesstring[]No-
created_atstringNo-
currency_codestringNo-
idstringNo-
localestringNo-
namestringNo-
slugstringNo-
updated_atstringNo-
Store Group
PropertyTypeRequiredDetails
country_of_salestringNo-
created_atstringNo-
descriptionstringNo-
idstringNo-
namestringNo-
slugstringNo-
store_typestringNo-
updated_atstringNo-
{
  "data": {
    "amount_cents_with_tax": 0,
    "created_at": "string",
    "id": "string",
    "market": {
      "active": false,
      "country_codes": [
        "string"
      ],
      "created_at": "string",
      "currency_code": "string",
      "id": "string",
      "locale": "string",
      "name": "string",
      "slug": "string",
      "updated_at": "string"
    },
    "on_sale": false,
    "reference_price_with_tax": 0,
    "sale_end_timestamp": "string",
    "sale_price_with_tax": 0,
    "sale_start_timestamp": "string",
    "status": "active",
    "store_group": {
      "country_of_sale": "string",
      "created_at": "string",
      "description": "string",
      "id": "string",
      "name": "string",
      "slug": "string",
      "store_type": "string",
      "updated_at": "string"
    },
    "updated_at": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: PUT
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/products/\{product_id\}/variants/\{variant_id\}/prices
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Variants
  • OpenAPI summary: Create or update variant price

Create or update variant price

# Create or update variant price Creates a new price or updates an existing price for a product variant in a specific market and store group.
PUT /api/v1/{team_slug}/{app_slug}/products/{product_id}/variants/{variant_id}/prices
Purpose

Creates a new price or updates an existing price for a product variant in a specific market and store group.

Required inputs

variant_id path app_slug path team_slug path

Primary response

200 ยท Created or updated price with store group and market details

Operation key

management-api:PUT:/api/v1/{team_slug}/{app_slug}/products/{product_id}/variants/{variant_id}/prices

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `PUT` - Path: `/api/v1/{team_slug}/{app_slug}/products/{product_id}/variants/{variant_id}/prices` - Summary: Create or update variant price - Description: Creates a new price or updates an existing price for a product variant in a specific market and store group. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PUT:/api/v1/{team_slug}/{app_slug}/products/{product_id}/variants/{variant_id}/prices` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | variant_id | path | Yes | string | Variant ID | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | ## Request body - Required: Yes - Description: Price data including market, store group, and pricing details - Content: application/json (object) ### Input Price | Property | Type | Required | Details | | --- | --- | --- | --- | | `amount_cents_with_tax` | integer | No | min: 0 | | `dont_update_price_if_on_sale` | boolean | No | Used to prevent overwriting price if on_sale. | | `market_slug` | string | Yes | - | | `on_sale` | boolean | No | - | | `reference_price_with_tax` | integer | No | min: 0 | | `sale_end_timestamp` | string | No | - | | `sale_price_with_tax` | integer | No | min: 0 | | `sale_start_timestamp` | string | No | - | | `status` | enum("active", "inactive", "draft") | Yes | - | | `store_group_slug` | string | Yes | - | **Generated example (synthetic):** ```json { "amount_cents_with_tax": 0, "dont_update_price_if_on_sale": false, "market_slug": "string", "on_sale": false, "reference_price_with_tax": 0, "sale_end_timestamp": "string", "sale_price_with_tax": 0, "sale_start_timestamp": "string", "status": "active", "store_group_slug": "string" } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Created or updated price with store group and market details | application/json (object) | | 400 | Invalid request (e.g. bad UUID, validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Product Price Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Product Variant Price With Store Group | Property | Type | Required | Details | | --- | --- | --- | --- | | `amount_cents_with_tax` | integer | No | - | | `created_at` | string | No | - | | `id` | string | No | - | | `market` | object | No | - | | `on_sale` | boolean | No | - | | `reference_price_with_tax` | integer | No | - | | `sale_end_timestamp` | string | No | - | | `sale_price_with_tax` | integer | No | - | | `sale_start_timestamp` | string | No | - | | `status` | enum("active", "inactive", "draft") | No | - | | `store_group` | object | No | - | | `updated_at` | string | No | - | ##### Market | Property | Type | Required | Details | | --- | --- | --- | --- | | `active` | boolean | No | - | | `country_codes` | string[] | No | - | | `created_at` | string | No | - | | `currency_code` | string | No | - | | `id` | string | No | - | | `locale` | string | No | - | | `name` | string | No | - | | `slug` | string | No | - | | `updated_at` | string | No | - | ##### Store Group | Property | Type | Required | Details | | --- | --- | --- | --- | | `country_of_sale` | string | No | - | | `created_at` | string | No | - | | `description` | string | No | - | | `id` | string | No | - | | `name` | string | No | - | | `slug` | string | No | - | | `store_type` | string | No | - | | `updated_at` | string | No | - |
Generated example (synthetic) ```json { "data": { "amount_cents_with_tax": 0, "created_at": "string", "id": "string", "market": { "active": false, "country_codes": [ "string" ], "created_at": "string", "currency_code": "string", "id": "string", "locale": "string", "name": "string", "slug": "string", "updated_at": "string" }, "on_sale": false, "reference_price_with_tax": 0, "sale_end_timestamp": "string", "sale_price_with_tax": 0, "sale_start_timestamp": "string", "status": "active", "store_group": { "country_of_sale": "string", "created_at": "string", "description": "string", "id": "string", "name": "string", "slug": "string", "store_type": "string", "updated_at": "string" }, "updated_at": "string" }, "details": [ "string" ], "success": false } ```
### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `PUT` - Path: `/api/v1/{team_slug}/{app_slug}/products/{product_id}/variants/{variant_id}/prices` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PUT:/api/v1/{team_slug}/{app_slug}/products/{product_id}/variants/{variant_id}/prices` - OpenAPI tag: Variants - OpenAPI summary: Create or update variant price