v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Product

Create Product

Add a new product to a workspace

post/workspaces/{workspace_id}/products

Path parameters

workspace_idinteger required

Request body

Example request

{
  "product": {
    "product": {
      "name": "Sample Product",
      "current_path": null,
      "visible_in_store": true,
      "visible_in_customer_center": true,
      "seo_title": "Buy Sample Product Online",
      "seo_description": "This is a sample product.",
      "seo_image_id": null,
      "commissionable": true,
      "image_ids": [],
      "redirect_funnel_id": null,
      "cancellation_funnel_url": null,
      "tag_ids": [
        1,
        2,
        3
      ],
      "variant_properties": [
        {
          "id": 1,
          "name": "Size"
        },
        {
          "id": 2,
          "name": "Color"
        }
      ]
    }
  }
}

Response

Created

idinteger

public_idstring nullable

Product Public ID

workspace_idinteger

Workspace ID

namestring

Product name

current_pathstring nullable

Current Path

archivedboolean nullable

Archived

visible_in_storeboolean nullable

Visible in Store

visible_in_customer_centerboolean nullable

Visible in Customer Center

image_idstring nullable

Image

seo_titlestring nullable

A clear title without branding or mentioning the domain itself. Longer is better, but max is 60 characters.

seo_descriptionstring nullable

A clear SEO description, at least two sentences long. Longer is better, but max is 160 characters. You will find the actual user-facing description on the default variant of the product (see the Products::Variant resource).

seo_image_idstring nullable

SEO image

commissionableboolean nullable

Commissionable

{"stackTrail":"components:schemas:ProductAttributes:properties:image_ids","oasType":"schema","type":"unknown","description":"Images"}

default_variant_idinteger

The ID of the default variant of the product

{"stackTrail":"components:schemas:ProductAttributes:properties:variant_ids","oasType":"schema","type":"unknown","description":"Variant IDs"}

{"stackTrail":"components:schemas:ProductAttributes:properties:price_ids","oasType":"schema","type":"unknown","description":"Price IDs"}

{"stackTrail":"components:schemas:ProductAttributes:properties:tag_ids","oasType":"schema","type":"unknown","description":"Any valid array, empty or with valid tags will overwrite existing values. To avoid losing existing tags first use the Fetch Product endpoint, then be sure to include the existing tags in your payload along with any new addition(s)"}

redirect_funnel_idstring nullable

Redirect funnel

cancellation_funnel_urlstring nullable

Cancellation Funnel Url

created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

Example response

{
  "id": 22,
  "public_id": "RTWMAd",
  "workspace_id": 42000,
  "name": "Sample Product",
  "current_path": null,
  "archived": false,
  "visible_in_store": true,
  "visible_in_customer_center": true,
  "image_id": null,
  "seo_title": "Buy Sample Product Online",
  "seo_description": "This is a sample product.",
  "seo_image_id": null,
  "commissionable": true,
  "image_ids": [],
  "default_variant_id": 22,
  "variant_ids": [
    22
  ],
  "price_ids": [],
  "tag_ids": [],
  "redirect_funnel_id": null,
  "cancellation_funnel_url": null,
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "variant_properties": [
    {
      "id": 22,
      "name": "Color"
    }
  ]
}