Create Product

Beta
POST/v1/catalog/products

Idempotent with Idempotency-Key header. Learn more

Creates a product and its backing inventory item.

The new item starts with zero on-hand inventory, and its pricing defaults to zero rates in the category's base unit unless unit_price or unit_cost is provided.

Permissions requiredValues:items:create
The role behind your API key or agent must grant every one of these permissions.
include[]optional arrayenumValues:product_lineproduct_line.unit_groupproduct_line.unit_group.base_unit

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

skustring

Stock keeping unit code for the product's item.

Must be unique within the account; creation fails with a conflict error if another item already uses it.

descriptionoptional string

Free-form description of the product.

notesoptional string

Free-form notes about the product.

typestringenumValues:saleserviceshipping

Product type code, which determines how the product behaves on orders and invoices.

  • sale: a standard sellable product.
  • service: a non-physical service line, such as labor or installation.
  • shipping: a shipping charge applied to an order.
  • credit: a credit applied against an order or invoice.
  • return: a returned product (RMA).
  • tax: a tax line.
product_line_idoptional string

ID of the product line to assign the product to.

category_idstring

ID of the item category for the product's item.

The category's unit group determines the default units used for the product's pricing rates and inventory tracking.

portal_visibilityoptional stringenumValues:visiblehidden

Whether the product is shown to buyers in the customer portal. Defaults to hidden.

  • visible: buyers can see and order the product in the portal.
  • hidden: the product is concealed from the portal but remains usable internally.

When omitted, the product is created hidden, so it must be set to visible before buyers can see it.

unit_priceoptional object

Initial selling price per unit.

When set, the numerator unit must be a currency unit and the denominator unit must not be. When omitted, the price is initialized to a zero rate in the category's base unit.

valuestring (decimal)

Decimal value of the rate, expressed as the amount of the numerator unit per one denominator unit.

numerator_unit_idstring

ID of the unit for the rate's numerator (e.g. the currency of a price).

denominator_unit_idstring

ID of the unit for the rate's denominator (the per-unit basis).

unit_costoptional object

Initial cost per unit.

The same unit rule as unit_price applies: the numerator unit must be a currency unit and the denominator unit must not be. When omitted, the cost is initialized to a zero rate in the category's base unit.

valuestring (decimal)

Decimal value of the rate, expressed as the amount of the numerator unit per one denominator unit.

numerator_unit_idstring

ID of the unit for the rate's numerator (e.g. the currency of a price).

denominator_unit_idstring

ID of the unit for the rate's denominator (the per-unit basis).

attribute_idsoptional array of string

Attribute IDs to connect to the product at creation time.

idstring

Product ID.

objectstringenumValues:product

Resource type identifier.

typestringenumValues:saleserviceshipping

Product type code, which determines how the product behaves on orders and invoices.

  • sale: a standard sellable product.
  • service: a non-physical service line, such as labor or installation.
  • shipping: a shipping charge applied to an order.
  • credit: a credit applied against an order or invoice.
  • return: a returned product (RMA).
  • tax: a tax line.
portal_visibilitystringenumValues:visiblehidden

Whether the product is shown to buyers in the customer portal.

  • visible: buyers can see and order the product in the portal.
  • hidden: the product is concealed from the portal but remains usable internally.
product_lineproduct_lineExpandablenullable

The product line this product is assigned to, if any.

idstring

Product line ID.

objectstringenumValues:product_line

Resource type identifier.

namestring

Display name of the product line.

descriptionstringnullable

Free-form description of the product line.

notesstringnullable

Free-form notes about the product line.

commission_policystringenumValues:commission_appliedcommission_exempt

Default commission policy for products in this product line.

  • commission_exempt: no commission applies to these products.
  • commission_applied: commission applies to these products, unless overridden elsewhere.
freight_policystringenumValues:free_freightbilled_freight

Default freight policy for products in this product line.

  • free_freight: these products do not incur a freight charge.
  • billed_freight: freight is billed for these products, unless overridden elsewhere.
ownerownernullable

Owner of the product line.

System-owned product lines are platform-provided and shared across all accounts; account-owned product lines are custom to your account.

Always returned as null in this endpoint.
unit_groupunit_groupExpandablenullable

Unit group associated with this product line.

The unit group determines the set of units available to products in this product line.

idstring

Unit group ID.

objectstringenumValues:unit_group

Resource type identifier.

namestring

Display name of the unit group.

Unique within the account.

notesstringnullable

Free-form notes about the unit group.

typestringenumValues:currencyquantitytime

Physical dimension shared by every unit in this group, such as mass, volume, or currency.

Only units of this dimension can belong to the group.

base_unitunitExpandablenullable

The reference unit designated for this group.

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

Always returned as null in this endpoint.
created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

associated_unitslistExpandablenullable

Units associated with this group, each with its own discount and customer portal visibility settings.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of unit_group_unit

Resources in this page.

idstring

Unit group unit ID.

objectstringenumValues:unit_group_unit

Resource type identifier.

unitunitnullable

The unit this association refers to.

Always returned as null in this endpoint.
discount_percentagenumber

Percentage discount applied to the unit's price when an order is placed in this unit (e.g. 10 is a 10% discount).

discount_fixednumber

Flat amount subtracted from the unit's price when an order is placed in this unit.

customer_portal_visibilitystringenumValues:visiblehidden

Whether this unit is shown to customers in the customer portal.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ownerownernullable

Owner of this resource.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

itemitemExpandablenullable

The inventory item backing this product, which holds its SKU, description, pricing, and attributes.

idstring

Item ID.

objectstringenumValues:item

Resource type identifier.

skustring

Stock keeping unit code, unique within the account.

descriptionstringnullable

Item description.

notesstringnullable

Free-form notes about the item.

typestringenumValues:productmaterialpart

What kind of item this is.

  • product: a finished product.
  • material: a raw material or component consumed in production.
  • part: a part used in production.
categoryitem_categoryExpandablenullable

The category this item belongs to.

The category's unit group determines the base unit the item's rates (unit_value, unit_cost, burn_rate) are expressed in.

idstring

Item category ID.

objectstringenumValues:item_category

Resource type identifier.

namestring

Display name of the item category.

notesstringnullable

Free-form notes about the item category.

typestringenumValues:material_categoryproduct_category

What kind of items this category groups.

An item can only be assigned to a category whose type matches the item's type.

  • material_category: groups raw materials and components (items of type material).
  • product_category: groups finished products and parts (items of type product or part).
ownerownernullable

Owner of the item category.

System-owned categories are platform defaults (the owner.type is system and owner.account is null); account-owned categories were created by your organization.

Always returned as null in this endpoint.
propertieslistExpandablenullable

Properties associated with this item category.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of property

Resources in this page.

idstring

Property ID.

objectstringenumValues:property

Resource type identifier.

namestring

Display name of the property, such as Color or Size.

attributeslistnullable

Attributes belonging to this property.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

unit_groupunit_groupExpandablenullable

Unit group associated with this item category.

This unit group determines the units of measure available to items in this category throughout your production process.

idstring

Unit group ID.

objectstringenumValues:unit_group

Resource type identifier.

namestring

Display name of the unit group.

Unique within the account.

notesstringnullable

Free-form notes about the unit group.

typestringenumValues:currencyquantitytime

Physical dimension shared by every unit in this group, such as mass, volume, or currency.

Only units of this dimension can belong to the group.

base_unitunitExpandablenullable

The reference unit designated for this group.

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownernullable

Owner of this resource.

Always returned as null in this endpoint.
created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

associated_unitslistExpandablenullable

Units associated with this group, each with its own discount and customer portal visibility settings.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of unit_group_unit

Resources in this page.

idstring

Unit group unit ID.

objectstringenumValues:unit_group_unit

Resource type identifier.

unitunitnullable

The unit this association refers to.

Always returned as null in this endpoint.
discount_percentagenumber

Percentage discount applied to the unit's price when an order is placed in this unit (e.g. 10 is a 10% discount).

discount_fixednumber

Flat amount subtracted from the unit's price when an order is placed in this unit.

customer_portal_visibilitystringenumValues:visiblehidden

Whether this unit is shown to customers in the customer portal.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ownerownernullable

Owner of this resource.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

unit_valuerateExpandablenullable

Selling value per unit, expressed as a rate (e.g. $25.50 / kg).

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Decimal value of the rate, as a string to preserve precision.

Expressed as the amount of the numerator unit per one denominator unit.

numerator_unitunitnullable

Unit of the rate's numerator (e.g. the currency of a price).

Always returned as null in this endpoint.
denominator_unitunitnullable

Unit of the rate's denominator (the per-unit basis, e.g. kilograms for a price per kilogram).

Always returned as null in this endpoint.
display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

unit_costrateExpandablenullable

Cost per unit, expressed as a rate (e.g. $10.00 / kg).

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Decimal value of the rate, as a string to preserve precision.

Expressed as the amount of the numerator unit per one denominator unit.

numerator_unitunitnullable

Unit of the rate's numerator (e.g. the currency of a price).

Always returned as null in this endpoint.
denominator_unitunitnullable

Unit of the rate's denominator (the per-unit basis, e.g. kilograms for a price per kilogram).

Always returned as null in this endpoint.
display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

burn_raterateExpandablenullable

Rate at which this item is consumed in production, expressed as a quantity over time (e.g. 100 kg / hr).

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Decimal value of the rate, as a string to preserve precision.

Expressed as the amount of the numerator unit per one denominator unit.

numerator_unitunitnullable

Unit of the rate's numerator (e.g. the currency of a price).

Always returned as null in this endpoint.
denominator_unitunitnullable

Unit of the rate's denominator (the per-unit basis, e.g. kilograms for a price per kilogram).

Always returned as null in this endpoint.
display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

attributeslistExpandablenullable

Attributes assigned to this item.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of attribute

Resources in this page.

idstring

Attribute ID.

objectstringenumValues:attribute

Resource type identifier.

valuestring

The selectable value this attribute represents, such as Red for a Color property or Large for a Size property.

colorstringenumValues:bluebrowndefault

Swatch color used to display this attribute in the UI.

The named colors are arbitrary display choices; default is a neutral fallback used when no specific swatch applies.

sort_orderinteger

Position of this attribute relative to its siblings within the property, starting at 1.

Positions are kept contiguous: creating, reordering, or deleting an attribute automatically shifts its siblings.

propertypropertynullable

The property this attribute belongs to.

Populated only when the attribute is returned under an item's attributes list.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

201

Successful response for Create Product