# Create Product

- **URL:** https://marketplace.gohighlevel.com/docs/ghl/products/create-product
- **Summary:** The 'Create Product' API allows adding a new product to the system. Use this endpoint to create a product with the specified details. Ensure that the required information is provided in the request payload.

[Skip to main content](https://marketplace.gohighlevel.com/docs/ghl/products/create-product#__docusaurus_skipToContent_fallback)

Version: v3

Create Product
==============

POST 

https://services.leadconnectorhq.com/products/

Copy for LLMView as MarkdownOpen in ClaudeOpen in ChatGPTOpen in Cursor

The "Create Product" API allows adding a new product to the system. Use this endpoint to create a product with the specified details. Ensure that the required information is provided in the request payload.

### Requirements

#### Scope(s)

`products.write`

#### Auth Method(s)

`OAuth Access Token``Private Integration Token`

#### Token Type(s)

`Sub-Account Token``Agency Token`

Request[​](https://marketplace.gohighlevel.com/docs/ghl/products/create-product#request "Direct link to request")

### Header Parameters

**Version** stringrequired

**Possible values:** \[`v3`\]

API Version

*   application/json

*   Body
*   Example (auto)

### Body**required**

**name**stringrequired

The name of the product.

**Example:** `Awesome Product`

**locationId**stringrequired

The unique identifier for the location.

**Example:** `3SwdhCsvxI8Au3KsPJt6`

**description**string

A brief description of the product.

**Example:** `Product description goes here.`

**productType**stringrequired

**Possible values:** \[`DIGITAL`, `PHYSICAL`, `SERVICE`, `PHYSICAL/DIGITAL`\]

**image**string

The URL for the product image.

**Example:** `https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png`

**statementDescriptor**string

The statement descriptor for the product.

**Example:** `abcde`

**availableInStore**boolean

Indicates whether the product is available in-store.

**Example:** `true`

**medias** object\[\]

An array of medias for the product.

*   Array \[\
    \
\
**id**stringrequired\
\
The unique identifier for the media.\
\
**Example:** `fzrgusiuu0m`\
\
**title**string\
\
The title of the media file.\
\
**Example:** `1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png`\
\
**url**stringrequired\
\
The URL where the media file is stored.\
\
**Example:** `https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png`\
\
**type**stringrequired\
\
The type of the media file (e.g., image, video will be supporting soon).\
\
**Possible values:** \[`image`, `video`\]\
\
**Example:** `image`\
\
**isFeatured**boolean\
\
Indicates whether the media is featured.\
\
**Example:** `true`\
\
**priceIds**array\[\]\
\
Mongo ObjectIds of the prices for which the media is assigned\
\
**Example:** `6578278e879ad2646715ba9c`\
\
*   \]
    

**variants** object\[\]

An array of variants for the product.

*   Array \[\
    \
\
**id**stringrequired\
\
A unique identifier for the variant.\
\
**Example:** `38s63qmxfr4`\
\
**name**stringrequired\
\
The name of the variant.\
\
**Example:** `Size`\
\
**options** object\[\]required\
\
An array of options for the variant.\
\
*   Array \[\
    \
\
**id**stringrequired\
\
The unique identifier for the option.\
\
**Example:** `h4z7u0im2q8`\
\
**name**stringrequired\
\
The name of the option.\
\
**Example:** `XL`\
\
*   \]\
    \
\
*   \]
    

**collectionIds**string\[\]

An array of category Ids for the product

**Example:** `["65d71377c326ea78e1c47df5","65d71377c326ea78e1c47d34"]`

**isTaxesEnabled**boolean

Are there any taxes attached to the product. If this is true, taxes array cannot be empty.

**Default value:** `false`

**Example:** `true`

**taxes**string\[\]

List of ids of Taxes attached to the Product. If taxes are passed, isTaxesEnabled should be true.

**Example:** `["654492a4e6bef380114de15a"]`

**automaticTaxCategoryId**string

Tax category ID for Automatic taxes calculation.

**Example:** `65d71377c326ea78e1c47df5`

**isLabelEnabled**boolean

Is the product label enabled. If this is true, label object cannot be empty.

**Default value:** `false`

**Example:** `true`

**label** object

Details for Product Label

**title**stringrequired

The content for the product label.

**Example:** `Featured`

**startDate**string

Start date in YYYY-MM-DDTHH:mm:ssZ format

**Example:** `2024-06-26T05:43:35.000Z`

**endDate**string

Start date in YYYY-MM-DDTHH:mm:ssZ format

**Example:** `2024-06-30T05:43:39.000Z`

**slug**string

The slug using which the product navigation will be handled

**Example:** `awesome-product`

**seo** object

SEO data for the product that will be displayed in the preview

**title**string

SEO title

**Example:** `Best Product - Buy Now`

**description**string

SEO description

**Example:** `This is the best product you can buy online with amazing features and great value`

**taxInclusive**boolean

Whether the taxes should be included in the purchase price

**Default value:** `false`

**Example:** `true`

    {  "name": "Awesome Product",  "locationId": "3SwdhCsvxI8Au3KsPJt6",  "description": "Product description goes here.",  "productType": "DIGITAL",  "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",  "statementDescriptor": "abcde",  "availableInStore": true,  "medias": [    {      "id": "fzrgusiuu0m",      "title": "1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png",      "url": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png",      "type": "image",      "isFeatured": true,      "priceIds": "6578278e879ad2646715ba9c"    }  ],  "variants": [    {      "id": "38s63qmxfr4",      "name": "Size",      "options": [        {          "id": "h4z7u0im2q8",          "name": "XL"        }      ]    }  ],  "collectionIds": [    "65d71377c326ea78e1c47df5",    "65d71377c326ea78e1c47d34"  ],  "isTaxesEnabled": true,  "taxes": [    "654492a4e6bef380114de15a"  ],  "automaticTaxCategoryId": "65d71377c326ea78e1c47df5",  "isLabelEnabled": true,  "label": {    "title": "Featured",    "startDate": "2024-06-26T05:43:35.000Z",    "endDate": "2024-06-30T05:43:39.000Z"  },  "slug": "awesome-product",  "seo": {    "title": "Best Product - Buy Now",    "description": "This is the best product you can buy online with amazing features and great value"  },  "taxInclusive": true}

Responses[​](https://marketplace.gohighlevel.com/docs/ghl/products/create-product#responses "Direct link to Responses")

*   201
*   400
*   401
*   422

Successful response

*   application/json

*   Schema
*   Example (auto)

**Schema**

**_id**stringrequired

The unique identifier for the product.

**Example:** `655b33a82209e60b6adb87a5`

**description**string

product description

**Example:** `This is a really awesome product`

**variants** object\[\]

An array of variants for the product.

*   Array \[\
    \
\
**id**stringrequired\
\
A unique identifier for the variant.\
\
**Example:** `38s63qmxfr4`\
\
**name**stringrequired\
\
The name of the variant.\
\
**Example:** `Size`\
\
**options** object\[\]required\
\
An array of options for the variant.\
\
*   Array \[\
    \
\
**id**stringrequired\
\
The unique identifier for the option.\
\
**Example:** `h4z7u0im2q8`\
\
**name**stringrequired\
\
The name of the option.\
\
**Example:** `XL`\
\
*   \]\
    \
\
*   \]
    

**locationId**stringrequired

The unique identifier for the location.

**Example:** `3SwdhCsvxI8Au3KsPJt6`

**name**stringrequired

The name of the product.

**Example:** `Awesome Product`

**productType**stringrequired

The type of the product (e.g., PHYSICAL).

**Example:** `PHYSICAL`

**availableInStore**boolean

Indicates whether the product is available in-store.

**Example:** `true`

**createdAt**string<date-time>required

The creation timestamp of the product.

**Example:** `2023-11-20T10:23:36.515Z`

**updatedAt**string<date-time>required

The last update timestamp of the product.

**Example:** `2024-01-23T09:57:04.846Z`

**statementDescriptor**string

The statement descriptor for the product.

**Example:** `abcde`

**image**string

The URL for the product image.

**Example:** `https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png`

**collectionIds**string\[\]

An array of category Ids for the product

**Example:** `["65d71377c326ea78e1c47df5","65d71377c326ea78e1c47d34"]`

**isTaxesEnabled**boolean

The field indicates whether taxes are enabled for the product or not.

**Default value:** `false`

**Example:** `true`

**taxes**string\[\]

An array of ids of Taxes attached to the Product. If the expand query includes tax, the taxes will be of type `ProductTaxDto`. Please refer to the `ProductTaxDto` for additional details.

**Example:** `["654492a4e6bef380114de15a"]`

**automaticTaxCategoryId**string

Tax category ID for Automatic taxes calculation.

**Example:** `65d71377c326ea78e1c47df5`

**label** object

The Product label details

**title**stringrequired

The content for the product label.

**Example:** `Featured`

**startDate**string

Start date in YYYY-MM-DDTHH:mm:ssZ format

**Example:** `2024-06-26T05:43:35.000Z`

**endDate**string

Start date in YYYY-MM-DDTHH:mm:ssZ format

**Example:** `2024-06-30T05:43:39.000Z`

**slug**string

The slug of the product by which the product will be navigated

**Example:** `washing-machine`

    {  "_id": "655b33a82209e60b6adb87a5",  "description": "This is a really awesome product",  "variants": [    {      "id": "38s63qmxfr4",      "name": "Size",      "options": [        {          "id": "h4z7u0im2q8",          "name": "XL"        }      ]    }  ],  "locationId": "3SwdhCsvxI8Au3KsPJt6",  "name": "Awesome Product",  "productType": "PHYSICAL",  "availableInStore": true,  "createdAt": "2023-11-20T10:23:36.515Z",  "updatedAt": "2024-01-23T09:57:04.846Z",  "statementDescriptor": "abcde",  "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",  "collectionIds": [    "65d71377c326ea78e1c47df5",    "65d71377c326ea78e1c47d34"  ],  "isTaxesEnabled": true,  "taxes": [    "654492a4e6bef380114de15a"  ],  "automaticTaxCategoryId": "65d71377c326ea78e1c47df5",  "label": {    "title": "Featured",    "startDate": "2024-06-26T05:43:35.000Z",    "endDate": "2024-06-30T05:43:39.000Z"  },  "slug": "washing-machine"}
> Common reference appendix (shared error/status catalog): see [../_shared-appendix.md](../_shared-appendix.md).
**name:** [Authorization](https://marketplace.gohighlevel.com/docs/ghl/products/products-api#authentication)
**type:** http**scopes:** `products.write`**scheme:** bearer**bearerFormat:** JWT**in:** header**description:** Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

*   curl
*   nodejs
*   python
*   php
*   java
*   go
*   ruby
*   powershell

*   CURL

    curl -L 'https://services.leadconnectorhq.com/products/' \-H 'Content-Type: application/json' \-H 'Accept: application/json' \-H 'Authorization: Bearer <Authorization>' \-d '{  "name": "Awesome Product",  "locationId": "3SwdhCsvxI8Au3KsPJt6",  "description": "Product description goes here.",  "productType": "DIGITAL",  "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",  "statementDescriptor": "abcde",  "availableInStore": true,  "medias": [    {      "id": "fzrgusiuu0m",      "title": "1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png",      "url": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png",      "type": "image",      "isFeatured": true,      "priceIds": "6578278e879ad2646715ba9c"    }  ],  "variants": [    {      "id": "38s63qmxfr4",      "name": "Size",      "options": [        {          "id": "h4z7u0im2q8",          "name": "XL"        }      ]    }  ],  "collectionIds": [    "65d71377c326ea78e1c47df5",    "65d71377c326ea78e1c47d34"  ],  "isTaxesEnabled": true,  "taxes": [    "654492a4e6bef380114de15a"  ],  "automaticTaxCategoryId": "65d71377c326ea78e1c47df5",  "isLabelEnabled": true,  "label": {    "title": "Featured",    "startDate": "2024-06-26T05:43:35.000Z",    "endDate": "2024-06-30T05:43:39.000Z"  },  "slug": "awesome-product",  "seo": {    "title": "Best Product - Buy Now",    "description": "This is the best product you can buy online with amazing features and great value"  },  "taxInclusive": true}'

RequestCollapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Security SchemeLocation-AccessAgency-Access

Bearer Token

Parameters

Version — headerrequired\---v3

Body required

{
  "name": "Awesome Product",  "locationId": "3SwdhCsvxI8Au3KsPJt6",  "description": "Product description goes here.",  "productType": "DIGITAL",  "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",  "statementDescriptor": "abcde",  "availableInStore": true,  "medias": \[    {      "id": "fzrgusiuu0m",      "title": "1dd7dcd0-e71d-4cf7-a06b-6d47723d6a29.png",      "url": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/sample.png",      "type": "image",      "isFeatured": true,      "priceIds": "6578278e879ad2646715ba9c"    }  \],  "variants": \[    {      "id": "38s63qmxfr4",      "name": "Size",      "options": \[        {          "id": "h4z7u0im2q8",          "name": "XL"        }      \]    }  \],  "collectionIds": \[    "65d71377c326ea78e1c47df5",    "65d71377c326ea78e1c47d34"  \],  "isTaxesEnabled": true,  "taxes": \[    "654492a4e6bef380114de15a"  \],  "automaticTaxCategoryId": "65d71377c326ea78e1c47df5",  "isLabelEnabled": true,  "label": {    "title": "Featured",    "startDate": "2024-06-26T05:43:35.000Z",    "endDate": "2024-06-30T05:43:39.000Z"  },  "slug": "awesome-product",  "seo": {    "title": "Best Product - Buy Now",    "description": "This is the best product you can buy online with amazing features and great value"  },  "taxInclusive": true
}
Send API Request

ResponseClear

Click the `Send API Request` button above and see the response here!