Create Product Type

curl --request POST \
  --url https://api.merchantops.ai/api/product-types/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "name": "<string>",
  "category_key": "<string>",
  "description": [
    {}
  ],
  "isActive": true,
  "properties": [
    {
      "key": "<string>",
      "ai_matching_guidance_override": "<string>",
      "display_group": "<string>",
      "display_order": 123,
      "enrichment_config_override": {
        "extraction_hint": "<string>",
        "generation_context_fields": [
          "<string>"
        ],
        "generation_prompt": "<string>",
        "llm_model": "<string>",
        "max_length": 123,
        "overwrite_merchant_input": true,
        "source_priority": [
          "<string>"
        ],
        "strategies": [
          "<string>"
        ]
      },
      "is_hidden": false,
      "prompt_name_override": "<string>"
    }
  ]
}
'

import requests

url = "https://api.merchantops.ai/api/product-types/"

payload = {
    "key": "<string>",
    "name": "<string>",
    "category_key": "<string>",
    "description": [{}],
    "isActive": True,
    "properties": [
        {
            "key": "<string>",
            "ai_matching_guidance_override": "<string>",
            "display_group": "<string>",
            "display_order": 123,
            "enrichment_config_override": {
                "extraction_hint": "<string>",
                "generation_context_fields": ["<string>"],
                "generation_prompt": "<string>",
                "llm_model": "<string>",
                "max_length": 123,
                "overwrite_merchant_input": True,
                "source_priority": ["<string>"],
                "strategies": ["<string>"]
            },
            "is_hidden": False,
            "prompt_name_override": "<string>"
        }
    ]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    key: '<string>',
    name: '<string>',
    category_key: '<string>',
    description: [{}],
    isActive: true,
    properties: [
      {
        key: '<string>',
        ai_matching_guidance_override: '<string>',
        display_group: '<string>',
        display_order: 123,
        enrichment_config_override: {
          extraction_hint: '<string>',
          generation_context_fields: ['<string>'],
          generation_prompt: '<string>',
          llm_model: '<string>',
          max_length: 123,
          overwrite_merchant_input: true,
          source_priority: ['<string>'],
          strategies: ['<string>']
        },
        is_hidden: false,
        prompt_name_override: '<string>'
      }
    ]
  })
};

fetch('https://api.merchantops.ai/api/product-types/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.merchantops.ai/api/product-types/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'key' => '<string>',
    'name' => '<string>',
    'category_key' => '<string>',
    'description' => [
        [
                
        ]
    ],
    'isActive' => true,
    'properties' => [
        [
                'key' => '<string>',
                'ai_matching_guidance_override' => '<string>',
                'display_group' => '<string>',
                'display_order' => 123,
                'enrichment_config_override' => [
                                'extraction_hint' => '<string>',
                                'generation_context_fields' => [
                                                                '<string>'
                                ],
                                'generation_prompt' => '<string>',
                                'llm_model' => '<string>',
                                'max_length' => 123,
                                'overwrite_merchant_input' => true,
                                'source_priority' => [
                                                                '<string>'
                                ],
                                'strategies' => [
                                                                '<string>'
                                ]
                ],
                'is_hidden' => false,
                'prompt_name_override' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.merchantops.ai/api/product-types/"

	payload := strings.NewReader("{\n  \"key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"category_key\": \"<string>\",\n  \"description\": [\n    {}\n  ],\n  \"isActive\": true,\n  \"properties\": [\n    {\n      \"key\": \"<string>\",\n      \"ai_matching_guidance_override\": \"<string>\",\n      \"display_group\": \"<string>\",\n      \"display_order\": 123,\n      \"enrichment_config_override\": {\n        \"extraction_hint\": \"<string>\",\n        \"generation_context_fields\": [\n          \"<string>\"\n        ],\n        \"generation_prompt\": \"<string>\",\n        \"llm_model\": \"<string>\",\n        \"max_length\": 123,\n        \"overwrite_merchant_input\": true,\n        \"source_priority\": [\n          \"<string>\"\n        ],\n        \"strategies\": [\n          \"<string>\"\n        ]\n      },\n      \"is_hidden\": false,\n      \"prompt_name_override\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.merchantops.ai/api/product-types/")
  .header("Content-Type", "application/json")
  .body("{\n  \"key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"category_key\": \"<string>\",\n  \"description\": [\n    {}\n  ],\n  \"isActive\": true,\n  \"properties\": [\n    {\n      \"key\": \"<string>\",\n      \"ai_matching_guidance_override\": \"<string>\",\n      \"display_group\": \"<string>\",\n      \"display_order\": 123,\n      \"enrichment_config_override\": {\n        \"extraction_hint\": \"<string>\",\n        \"generation_context_fields\": [\n          \"<string>\"\n        ],\n        \"generation_prompt\": \"<string>\",\n        \"llm_model\": \"<string>\",\n        \"max_length\": 123,\n        \"overwrite_merchant_input\": true,\n        \"source_priority\": [\n          \"<string>\"\n        ],\n        \"strategies\": [\n          \"<string>\"\n        ]\n      },\n      \"is_hidden\": false,\n      \"prompt_name_override\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.merchantops.ai/api/product-types/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"category_key\": \"<string>\",\n  \"description\": [\n    {}\n  ],\n  \"isActive\": true,\n  \"properties\": [\n    {\n      \"key\": \"<string>\",\n      \"ai_matching_guidance_override\": \"<string>\",\n      \"display_group\": \"<string>\",\n      \"display_order\": 123,\n      \"enrichment_config_override\": {\n        \"extraction_hint\": \"<string>\",\n        \"generation_context_fields\": [\n          \"<string>\"\n        ],\n        \"generation_prompt\": \"<string>\",\n        \"llm_model\": \"<string>\",\n        \"max_length\": 123,\n        \"overwrite_merchant_input\": true,\n        \"source_priority\": [\n          \"<string>\"\n        ],\n        \"strategies\": [\n          \"<string>\"\n        ]\n      },\n      \"is_hidden\": false,\n      \"prompt_name_override\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "key": "<string>",
  "name": "<string>",
  "category_key": "<string>",
  "createdAt": "<string>",
  "createdBy": "<string>",
  "description": [
    {}
  ],
  "isActive": true,
  "is_system": false,
  "lastModifiedAt": "<string>",
  "lastModifiedBy": "<string>",
  "propertyCount": 0,
  "propertyKeys": [
    "<string>"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

POST

api

product-types

Create Product Type

curl --request POST \
  --url https://api.merchantops.ai/api/product-types/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "name": "<string>",
  "category_key": "<string>",
  "description": [
    {}
  ],
  "isActive": true,
  "properties": [
    {
      "key": "<string>",
      "ai_matching_guidance_override": "<string>",
      "display_group": "<string>",
      "display_order": 123,
      "enrichment_config_override": {
        "extraction_hint": "<string>",
        "generation_context_fields": [
          "<string>"
        ],
        "generation_prompt": "<string>",
        "llm_model": "<string>",
        "max_length": 123,
        "overwrite_merchant_input": true,
        "source_priority": [
          "<string>"
        ],
        "strategies": [
          "<string>"
        ]
      },
      "is_hidden": false,
      "prompt_name_override": "<string>"
    }
  ]
}
'

import requests

url = "https://api.merchantops.ai/api/product-types/"

payload = {
    "key": "<string>",
    "name": "<string>",
    "category_key": "<string>",
    "description": [{}],
    "isActive": True,
    "properties": [
        {
            "key": "<string>",
            "ai_matching_guidance_override": "<string>",
            "display_group": "<string>",
            "display_order": 123,
            "enrichment_config_override": {
                "extraction_hint": "<string>",
                "generation_context_fields": ["<string>"],
                "generation_prompt": "<string>",
                "llm_model": "<string>",
                "max_length": 123,
                "overwrite_merchant_input": True,
                "source_priority": ["<string>"],
                "strategies": ["<string>"]
            },
            "is_hidden": False,
            "prompt_name_override": "<string>"
        }
    ]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    key: '<string>',
    name: '<string>',
    category_key: '<string>',
    description: [{}],
    isActive: true,
    properties: [
      {
        key: '<string>',
        ai_matching_guidance_override: '<string>',
        display_group: '<string>',
        display_order: 123,
        enrichment_config_override: {
          extraction_hint: '<string>',
          generation_context_fields: ['<string>'],
          generation_prompt: '<string>',
          llm_model: '<string>',
          max_length: 123,
          overwrite_merchant_input: true,
          source_priority: ['<string>'],
          strategies: ['<string>']
        },
        is_hidden: false,
        prompt_name_override: '<string>'
      }
    ]
  })
};

fetch('https://api.merchantops.ai/api/product-types/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.merchantops.ai/api/product-types/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'key' => '<string>',
    'name' => '<string>',
    'category_key' => '<string>',
    'description' => [
        [
                
        ]
    ],
    'isActive' => true,
    'properties' => [
        [
                'key' => '<string>',
                'ai_matching_guidance_override' => '<string>',
                'display_group' => '<string>',
                'display_order' => 123,
                'enrichment_config_override' => [
                                'extraction_hint' => '<string>',
                                'generation_context_fields' => [
                                                                '<string>'
                                ],
                                'generation_prompt' => '<string>',
                                'llm_model' => '<string>',
                                'max_length' => 123,
                                'overwrite_merchant_input' => true,
                                'source_priority' => [
                                                                '<string>'
                                ],
                                'strategies' => [
                                                                '<string>'
                                ]
                ],
                'is_hidden' => false,
                'prompt_name_override' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.merchantops.ai/api/product-types/"

	payload := strings.NewReader("{\n  \"key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"category_key\": \"<string>\",\n  \"description\": [\n    {}\n  ],\n  \"isActive\": true,\n  \"properties\": [\n    {\n      \"key\": \"<string>\",\n      \"ai_matching_guidance_override\": \"<string>\",\n      \"display_group\": \"<string>\",\n      \"display_order\": 123,\n      \"enrichment_config_override\": {\n        \"extraction_hint\": \"<string>\",\n        \"generation_context_fields\": [\n          \"<string>\"\n        ],\n        \"generation_prompt\": \"<string>\",\n        \"llm_model\": \"<string>\",\n        \"max_length\": 123,\n        \"overwrite_merchant_input\": true,\n        \"source_priority\": [\n          \"<string>\"\n        ],\n        \"strategies\": [\n          \"<string>\"\n        ]\n      },\n      \"is_hidden\": false,\n      \"prompt_name_override\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.merchantops.ai/api/product-types/")
  .header("Content-Type", "application/json")
  .body("{\n  \"key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"category_key\": \"<string>\",\n  \"description\": [\n    {}\n  ],\n  \"isActive\": true,\n  \"properties\": [\n    {\n      \"key\": \"<string>\",\n      \"ai_matching_guidance_override\": \"<string>\",\n      \"display_group\": \"<string>\",\n      \"display_order\": 123,\n      \"enrichment_config_override\": {\n        \"extraction_hint\": \"<string>\",\n        \"generation_context_fields\": [\n          \"<string>\"\n        ],\n        \"generation_prompt\": \"<string>\",\n        \"llm_model\": \"<string>\",\n        \"max_length\": 123,\n        \"overwrite_merchant_input\": true,\n        \"source_priority\": [\n          \"<string>\"\n        ],\n        \"strategies\": [\n          \"<string>\"\n        ]\n      },\n      \"is_hidden\": false,\n      \"prompt_name_override\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.merchantops.ai/api/product-types/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"category_key\": \"<string>\",\n  \"description\": [\n    {}\n  ],\n  \"isActive\": true,\n  \"properties\": [\n    {\n      \"key\": \"<string>\",\n      \"ai_matching_guidance_override\": \"<string>\",\n      \"display_group\": \"<string>\",\n      \"display_order\": 123,\n      \"enrichment_config_override\": {\n        \"extraction_hint\": \"<string>\",\n        \"generation_context_fields\": [\n          \"<string>\"\n        ],\n        \"generation_prompt\": \"<string>\",\n        \"llm_model\": \"<string>\",\n        \"max_length\": 123,\n        \"overwrite_merchant_input\": true,\n        \"source_priority\": [\n          \"<string>\"\n        ],\n        \"strategies\": [\n          \"<string>\"\n        ]\n      },\n      \"is_hidden\": false,\n      \"prompt_name_override\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "key": "<string>",
  "name": "<string>",
  "category_key": "<string>",
  "createdAt": "<string>",
  "createdBy": "<string>",
  "description": [
    {}
  ],
  "isActive": true,
  "is_system": false,
  "lastModifiedAt": "<string>",
  "lastModifiedBy": "<string>",
  "propertyCount": 0,
  "propertyKeys": [
    "<string>"
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Headers

authorization

string | null

X-Organization-ID

string | null

Cookies

stytch_session

string | null

Body

application/json

Request model for creating a ProductType.

key

string

required

Unique identifier (lowercase with underscores)

name

string

required

Human-readable name

category_key

string | null

Key into product_type_categories (e.g. 'apparel'). Drives 3-tier prompt resolution.

description

Description · object[] | null

Localized descriptions

Show child attributes

isActive

boolean

default:true

Active status

properties

PropertyReferenceDict · object[]

Property references

Show child attributes

Response

Successful Response

Response model for a single ProductType.

string

required

MongoDB ObjectId as string

key

string

required

Unique identifier

name

string

required

Human-readable name

category_key

string | null

Key into product_type_categories — links this ProductType to a Category for 3-tier prompt resolution.

createdAt

string | null

Creation timestamp

createdBy

string | null

User who created this

description

Description · object[] | null

Localized descriptions

Show child attributes

isActive

boolean

default:true

Active status

is_system

boolean

default:false

System-managed ProductType

lastModifiedAt

string | null

Last modification timestamp

lastModifiedBy

string | null

User who last modified this

propertyCount

integer

default:0

Number of properties

propertyKeys

string[]

List of property keys

Brands

Catalog

Jobs

Product Lakehouse

MAP Pricing

Pricing

Product Type Categories

Product Types

Products

Variants

Property Definitions

Create Product Type

Headers

Cookies

Body

Response