productsAdd
Create a new Product.
Auth · x-app-token · required permission manageProducts
Related: productsEdit, productsRemove, products
productsAdd(name: String, shortName: String, slug: String, categoryId: String, type: String, description: String, barcodes: [String], unitPrice: Float, salePrice: Float, compareAtPrice: Float, code: String, costPrice: Float, currency: String, mpn: String, gtin: String, requireShipping: Boolean, channels: [String], unlimitedQuantity: Boolean, saleStart: Date, saleEnd: Date, maxPerOrder: Int, maxPerCustomer: Int, isAvailable: Boolean, hideQuantity: Boolean, customFieldsData: JSON, attachment: AttachmentInput, attachmentMore: [AttachmentInput], media: [AttachmentInput], vendorId: String, uom: String, subUoms: JSON, taxType: String, taxCode: String, sku: String, externalUrl: String, source: String, status: String, productOptions: JSON, productVariants: JSON, priceRange: JSON, hasVariants: Boolean, weight: Float, weightUnit: String, dimensions: JSON, inventory: JSON, seo: JSON): ProductArguments
Display name.
Short label for compact UI (cards, tags).
URL-friendly identifier. Auto-generated from name when omitted.
ProductCategory this product belongs to.
Product type / kind, e.g. product, service.
Long-form description (may contain HTML).
Barcode values associated with this product.
Regular unit price, in currency.
Discounted price, when on sale.
Original price to show struck through next to a discounted price.
Stable code, unique within the workspace. Auto-generated when omitted.
Internal cost price, for margin reporting.
ISO currency code for all price fields.
Manufacturer part number.
Global Trade Item Number (barcode standard).
Whether this product requires physical shipping.
Sales channels to publish this product to.
When true, stock is not tracked. Default: false.
When salePrice becomes active.
When salePrice expires.
Maximum quantity allowed in a single order.
Maximum quantity allowed per customer overall.
Whether the product can currently be purchased. Default: true.
When true, hides remaining stock count from customers.
Custom field values keyed by field id. See Field.
Primary product image.
Additional images.
Combined media gallery (images and other attachments).
Supplying Company id, when tracked.
Base unit of measure, e.g. piece, kg.
Alternate units of measure with conversion factors.
Tax classification for this product.
Tax code passed to external tax calculation.
Stock keeping unit, separate from code.
Link to the product on an external storefront, when synced.
Origin system for imported/synced products.
Lifecycle status, e.g. active, disabled, draft. Default: active.
Option definitions (e.g. color, size) used to generate variants, as JSON.
Purchasable variants, each with its own price and stock, as JSON.
Min/max price across variants, as JSON. Usually computed — set explicitly only to override.
Whether this product is sold via productVariants rather than a single price.
Shipping weight, in weightUnit.
Unit for weight, e.g. kg, lb.
Physical package dimensions, as JSON.
Stock tracking configuration, as JSON.
SEO title, description, slug, and keywords, as JSON.
Returns
Display name.
Short label for compact UI (cards, tags).
URL-friendly identifier.
Lifecycle status, e.g. active, disabled, draft.
Stable SKU-like code, unique within the workspace.
Product type / kind, e.g. product, service.
Long-form description (may contain HTML).
Barcode values associated with this product.
Regular unit price, in currency.
Discounted price, when on sale. Falls back to unitPrice when unset.
Internal cost price, for margin reporting.
ISO currency code for all price fields.
ProductCategory this product belongs to.
Custom field values keyed by field id. See Field.
Custom field values keyed by stable field code.
Tag ids attached to this product.
Primary product image.
Additional images.
Combined media gallery (images and other attachments).
Supplying Company id, when tracked.
Base unit of measure, e.g. piece, kg.
Alternate units of measure with conversion factors.
Tax classification for this product.
Tax code passed to external tax calculation.
Stock keeping unit, separate from code.
Link to the product on an external storefront, when synced.
Origin system for imported/synced products (e.g. a connected store platform).
Manufacturer part number.
Global Trade Item Number (barcode standard).
Whether this product requires physical shipping.
Sales channels this product is published to.
When true, stock is not tracked and the product is always orderable.
When the salePrice becomes active.
When the salePrice expires.
Maximum quantity allowed in a single order.
Maximum quantity allowed per customer overall.
Whether the product can currently be purchased.
When true, hides remaining stock count from customers.
Option definitions (e.g. color, size) used to generate productVariants.
Purchasable variants, each with its own price and stock.
Min/max price across productVariants, when hasVariants is true.
Whether this product is sold via productVariants rather than a single price.
Whether the catalog integration flagged an issue with this product (e.g. missing required field for a channel).
Shipping weight, in weightUnit.
Unit for weight, e.g. kg, lb.
Physical package dimensions.
Stock tracking configuration and current quantity.
SEO title, description, slug, and keywords for storefront pages.