Skip to main content

ProductAddInput

Input type for adding new products

input ProductAddInput {
  brandId: ID!
  bulletPoints: [String!]
  categoryId: ID @deprecated
  colorId: ID @deprecated
  compositionLines: [CompositionLineInput!]
  compositionType: CompositionTypeEnum
  currencyCode: CurrencyCodeEnum
  customsInput: ProductCustomsInput
  description: String
  height: Decimal
  images: [ProductImageInput!]
  innerPack: Boolean
  innerPackInput: ProductInnerPackInput
  length: Decimal
  masterCarton: Boolean
  masterCartonInput: ProductMasterCartonInput
  name: String!
  packagingUrl: Url
  pallet: Boolean
  palletInput: ProductPalletInput
  parentId: ID
  partNumber: String
  price: Decimal @deprecated
  priceMap: BigDecimal
  priceMsrp: BigDecimal
  productAttributes: [ProductAttributeInput!]
  productEconomics: ProductEconomicsInput
  productTags: [ProductTagInput!]
  productType: ProductTypeEnum
  purchasingInput: ProductPurchasingInput @deprecated
  restockThreshold: Int
  ship: Boolean
  shippingInput: ProductShippingInput
  sizeId: ID @deprecated
  sku: String!
  sourcingMethod: ProductSourcingMethodEnum
  specsUrl: Url
  status: ProductStatusEnum @deprecated
  styleId: ID @deprecated
  uom: ProductUomEnum
  upc: String
  weight: Decimal
  width: Decimal
}

Fields

`ProductAddInput.brandId` ● `ID!` non-null scalar

The ID of the brand to which this product belongs. If not provided, the current brand will be used.

`ProductAddInput.bulletPoints` ● `[String!]` list scalar

The bullet points for this product. Bullet points are used to describe the product on the website.

`ProductAddInput.categoryId` ● `ID` deprecated scalar

DEPRECATED

Use productAttributes instead. This argument will be removed in the future.

The ID of the category to which this product belongs.

`ProductAddInput.colorId` ● `ID` deprecated scalar

DEPRECATED

Use productAttributes instead. This argument will be removed in the future.

`ProductAddInput.compositionLines` ● `[CompositionLineInput!]` list input

Composition lines to add inline. Each line defines a component product and quantity.

`ProductAddInput.compositionType` ● `CompositionTypeEnum` enum

Indicates the grouping nature for this composed product

`ProductAddInput.currencyCode` ● `CurrencyCodeEnum` enum

`ProductAddInput.customsInput` ● `ProductCustomsInput` input

`ProductAddInput.description` ● `String` scalar

`ProductAddInput.height` ● `Decimal` scalar

`ProductAddInput.images` ● `[ProductImageInput!]` list input

`ProductAddInput.innerPack` ● `Boolean` scalar

Whether this product has an inner pack. If true, the inner pack data must be provided.

`ProductAddInput.innerPackInput` ● `ProductInnerPackInput` input

`ProductAddInput.length` ● `Decimal` scalar

`ProductAddInput.masterCarton` ● `Boolean` scalar

Whether this product has a master carton. If true, the master carton data must be provided.

`ProductAddInput.masterCartonInput` ● `ProductMasterCartonInput` input

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

`ProductAddInput.packagingUrl` ● `Url` scalar

`ProductAddInput.pallet` ● `Boolean` scalar

Whether this product has a pallet. If true, the pallet data must be provided.

`ProductAddInput.palletInput` ● `ProductPalletInput` input

`ProductAddInput.parentId` ● `ID` scalar

The ID of the parent product. If provided, this product will be a variant of the parent product.

`ProductAddInput.partNumber` ● `String` scalar

`ProductAddInput.price` ● `Decimal` deprecated scalar

DEPRECATED

Will be removed in the future. Use the priceMsrp argument instead.

`ProductAddInput.priceMap` ● `BigDecimal` scalar

`ProductAddInput.priceMsrp` ● `BigDecimal` scalar

`ProductAddInput.productAttributes` ● `[ProductAttributeInput!]` list input

Product attributes to set. Each attribute is identified by its handle or definition ID.

`ProductAddInput.productEconomics` ● `ProductEconomicsInput` input

`ProductAddInput.productTags` ● `[ProductTagInput!]` list input

`ProductAddInput.productType` ● `ProductTypeEnum` enum

The type of product. If not provided, defaults to 'BASE_ITEM'.

`ProductAddInput.purchasingInput` ● `ProductPurchasingInput` deprecated input

DEPRECATED

Will be removed in the future. Use the productEconomics argument instead.

`ProductAddInput.restockThreshold` ● `Int` scalar

`ProductAddInput.ship` ● `Boolean` scalar

Whether this product is shippable. If false, the product will not be available for purchase.

`ProductAddInput.shippingInput` ● `ProductShippingInput` input

`ProductAddInput.sizeId` ● `ID` deprecated scalar

DEPRECATED

Use productAttributes instead. This argument will be removed in the future.

`ProductAddInput.sku` ● `String!` non-null scalar

`ProductAddInput.sourcingMethod` ● `ProductSourcingMethodEnum` enum

`ProductAddInput.specsUrl` ● `Url` scalar

`ProductAddInput.status` ● `ProductStatusEnum` deprecated enum

DEPRECATED

This argument will be removed in the future. Use archive/unarchive mutations to change product status.

`ProductAddInput.styleId` ● `ID` deprecated scalar

DEPRECATED

Use productAttributes instead. This argument will be removed in the future.

`ProductAddInput.uom` ● `ProductUomEnum` enum

`ProductAddInput.upc` ● `String` scalar

`ProductAddInput.weight` ● `Decimal` scalar

`ProductAddInput.width` ● `Decimal` scalar

Member Of

BulkAddProductsInput input

Fields
Member Of