Skip to main content

CreateProductInput

A new product with its variants.

input CreateProductInput {
  baseUOMId: ID
  brandId: ID
  categoryIds: [ID!]
  description: String
  imageUrls: [String!]!
  inventoryUOMId: ID
  isTaxExempt: Boolean
  name: String!
  primaryCategoryId: ID
  purchaseTaxGroupId: String
  purchaseUOMId: ID
  salesUOMId: ID
  status: ProductStatus!
  tags: [String!]!
  taxExemptReason: String
  taxGroupId: String
  taxRateId: String
  variants: [CreateProductVariantInput!]
}

Fields

`CreateProductInput.baseUOMId` ● `ID` scalar

The ID of the base unit of measure.

`CreateProductInput.brandId` ● `ID` scalar

The ID of the brand.

`CreateProductInput.categoryIds` ● `[ID!]` list scalar

The IDs of the categories the product is in.

`CreateProductInput.description` ● `String` scalar

What the product is.

`CreateProductInput.imageUrls` ● `[String!]!` non-null scalar

The URLs of the product images.

`CreateProductInput.inventoryUOMId` ● `ID` scalar

The ID of the unit of measure stock is kept in.

`CreateProductInput.isTaxExempt` ● `Boolean` scalar

True when the product is exempt from tax.

`CreateProductInput.name` ● `String!` non-null scalar

The name of the product.

`CreateProductInput.primaryCategoryId` ● `ID` scalar

The ID of the main category.

`CreateProductInput.purchaseTaxGroupId` ● `String` scalar

The tax group used when buying the product, on purchase orders and supplier bills. An empty string clears it.

`CreateProductInput.purchaseUOMId` ● `ID` scalar

The ID of the unit of measure used for purchases.

`CreateProductInput.salesUOMId` ● `ID` scalar

The ID of the unit of measure used for sales.

`CreateProductInput.status` ● `ProductStatus!` non-null enum

The status of the product.

`CreateProductInput.tags` ● `[String!]!` non-null scalar

Tags on the product.

`CreateProductInput.taxExemptReason` ● `String` scalar

Why the product is exempt from tax.

`CreateProductInput.taxGroupId` ● `String` scalar

The ID of the tax group.

`CreateProductInput.taxRateId` ● `String` scalar

The IDs of the tax rates on the product, as one comma-separated string.

`CreateProductInput.variants` ● `[CreateProductVariantInput!]` list input

The variants of the product.

Member Of

createProduct mutation

Fields
Member Of