Skip to content

Catalogs API

Create a catalog variant

POSThttps://email.growthdept.ai/api/catalog-variants

Creates a variant of an item in the same catalog. Its id is $custom:::<catalog_type>:::<external_id>; an existing id answers 409.

The request body can be up to 5 MB.

Rate limits

Burst: 75/s

Steady: 750/m

Tier L. See rate limits for how requests are counted.

Scopes

catalogs:write

Operation id

create_catalog_variant The same operation as in Klaviyo's API. OpenAPI document

Query parameters

array of strings

Attributes of catalog-variant resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

Body

Send application/vnd.api+json or application/json.

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      catalog-variant
    • idstring

    • attributesobjectrequired

      attributes: 15 fields
      • external_idstringrequired

      • catalog_typestringcan be null

      • integration_typestring

      • titlestringrequired

      • descriptionstringrequired

      • skustringrequired

      • inventory_policyobject

      • inventory_quantitynumberrequired

      • pricenumberrequired

      • urlstringrequired

      • image_full_urlstringcan be null

      • image_thumbnail_urlstringcan be null

      • imagesarray of strings

      • custom_metadataobject

      • publishedbooleancan be null

    • relationshipsobject

      relationships: 1 field
      • itemobjectrequired

        item: 1 field
        • dataobjectrequired

          data: 2 fields
          • typestringrequired

            catalog-item
          • idstringrequired

    • metaobject

Edit the example. The code samples use what you type here.

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

201Success

Response body

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      catalog-variant
    • idstringrequired

    • attributesobjectrequired

      attributes: 15 fields
      • external_idstringcan be null

      • titlestringcan be null

      • descriptionstringcan be null

      • skustringcan be null

      • inventory_policyintegercan be null

        012
      • inventory_quantitynumbercan be null

      • pricenumbercan be null

      • urlstringcan be null

      • image_full_urlstringcan be null

      • image_thumbnail_urlstringcan be null

      • imagesarray of stringscan be null

      • custom_metadataobjectcan be null

      • publishedbooleancan be null

      • createdstring (date-time)can be null

      • updatedstring (date-time)can be null

    • relationshipsobject

      relationships: 1 field
      • itemobject

        item: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            catalog-item
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 1 field
    • selfstring (uri)required

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject