API Reference

Variants

Product variants, the purchasable combinations of a product, each with its own SKU and prices.

Prefix /cdna-api/products ReferenceProductVariant model GuideProduct, description and variant
Variants in Postman

About variants

A variant is a product’s size, colour or other combination that is bought on its own. It has its own SKU, prices, weight and descriptions, and borrows its product’s categories and shipping category; it has no custom fields and no tax category of its own. A cart adds a variant by its SKU exactly as it adds a product.

List variants#

GET /cdna-api/products/product-variants

Lists variants. Without limit every match comes back. The example asks for one product’s.

Access
Admin users and integrations, with an OAuth access token or an API key.
Model
ProductVariant, in the Reference

Parameters

propertiesquery
selector
The fields and relations to return, such as {id,code,name,finalPrice,published,product{id,code}}.
filtersquery
name=value
Any stored field, or a relation with a dot, such as parent.id=12. Prefix the name with !, >, <, % or |. Use stored field names exactly as in the model, and compare totalCount with the unfiltered list's to confirm a filter applied.
orderByquery
string
field:ASC or field:DESC, comma-separated. Stored fields only.
limitquery
integer
Records per response. There is no default.
offsetquery
integer
Records to skip.

Example

List variants 
GET /cdna-api/products/product-variants?product.id=1&properties={id,code,name,finalPrice,published,product{id,code}} HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Response 200 OK 
{
  "result": "success",
  "totalCount": 1,
  "data": [
    {
      "id": 2,
      "code": "API-SANDBOX-MUG-BLUE",
      "name": "API sandbox mug, blue",
      "finalPrice": "14.0000",
      "published": "2026-10-18T01:26:49+00:00",
      "product": {
        "id": 1,
        "code": "API-SANDBOX-MUG"
      }
    }
  ]
}
Real response from this documentation site

Learn more

GuideFilters, ordering and paging FAQMy filter returned every record

Show a variant#

GET /cdna-api/products/product-variant/{id}

Reads one variant by its id.

Access
Admin users and integrations, with an OAuth access token or an API key.
Model
ProductVariant, in the Reference

Parameters

idpathrequired
integer
The variant id.
propertiesquery
selector
The fields and relations to return, such as {id,code,name,finalPrice,published,product{id,code}}.

Example

Show a variant 
GET /cdna-api/products/product-variant/2?properties={id,code,name,finalPrice,published,product{id,code}} HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Response 200 OK 
{
  "result": "success",
  "data": {
    "id": 2,
    "code": "API-SANDBOX-MUG-BLUE",
    "name": "API sandbox mug, blue",
    "finalPrice": "14.0000",
    "published": "2026-10-18T01:26:49+00:00",
    "product": {
      "id": 1,
      "code": "API-SANDBOX-MUG"
    }
  }
}
Real response from this documentation site

Learn more

GuideShaping the response with properties FAQMy properties fields come back as "Error: Getter for property … not found", or glued together

Create a variant#

POST /cdna-api/products/product-variant

Creates a variant.

Access
Admin users and integrations, with an OAuth access token or an API key.
Returns
The new variant, in the fields properties asks for, and a message.

Parameters

productbodyrequired
integer
The product it is a variant of.
codebodyrequired
string
The SKU. Unique across every product and variant.
descriptionsbodyrequired
list
The content per language: each with language, name and slug. At least one, in the site’s default language.
pricingsbodyrequired
list
One price row per currency: currency and basePrice, optionally specialPrice, rrp and costPrice. At least one, in the site’s default currency.
publishedbody
datetime
true publishes now, a future datetime schedules, null unpublishes. Needs the publish permission.

Example

Create a variant 
POST /cdna-api/products/product-variant?properties={id,code,name,published,finalPrice,product{id,code}} HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Content-Type: application/json

{
  "product": 1,
  "code": "API-SANDBOX-MUG-BLUE",
  "published": true,
  "descriptions": [
    { "language": 47, "name": "API sandbox mug, blue", "slug": "api-sandbox-mug-blue" }
  ],
  "pricings": [
    { "currency": 142, "basePrice": "14.00" }
  ]
}
Response 200 OK 
{
  "result": "success",
  "data": {
    "id": 2,
    "code": "API-SANDBOX-MUG-BLUE",
    "name": "API sandbox mug, blue",
    "published": "2026-10-18T01:26:49+00:00",
    "finalPrice": "14.00",
    "product": {
      "id": 1,
      "code": "API-SANDBOX-MUG"
    }
  },
  "message": "The Product Variant has been added successfully."
}
Real response from this documentation site

Learn more

FAQ"Could not find the referenced record with id 0"

Edit a variant#

PUT /cdna-api/products/product-variant/{id}

Changes a variant. Fields left out keep their values.

Access
Admin users and integrations, with an OAuth access token or an API key.
Returns
The saved variant under data.productVariant, and a message.

Parameters

idpathrequired
integer
The variant id.
purchasablebody
boolean
false keeps the product visible but not buyable.
code, pricings, descriptions, publishedbody
As for Create a variant.

Example

Edit a variant 
PUT /cdna-api/products/product-variant/8 HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Content-Type: application/json

{
  "purchasable": false
}

Learn more

FAQ"Could not find the referenced record with id 0"

Delete a variant#

DELETE /cdna-api/products/product-variant/{id}

Deletes a variant.

Access
Admin users and integrations, with an OAuth access token or an API key.

Parameters

idpathrequired
integer
The variant id.

Example

Delete a variant 
DELETE /cdna-api/products/product-variant/8 HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Learn more

GuideRetries and writes that may have applied FAQMy DELETE timed out: did it go through?

Duplicate a variant#

POST /cdna-api/products/duplicate-product-variant/{id}

Copies a variant with its descriptions and prices. The copy’s SKU and slug get a -copy-N suffix, and it is unpublished.

Access
Admin users and integrations, with an OAuth access token or an API key.
Returns
The copy under data.productVariant, and a message.

Parameters

idpathrequired
integer
The variant id.

Example

Duplicate a variant 
POST /cdna-api/products/duplicate-product-variant/8 HTTP/1.1
Host: hub.coredna.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json
Open in Postman docs