Skip to main content

AddProductInput

Autogenerated input type of AddProduct

input AddProductInput {
  brandId: ID
  bulletPoints: [String!]
  categoryId: ID @deprecated
  clientMutationId: String
  colorId: ID @deprecated
  compositionLines: [CompositionLineInput!]
  compositionType: CompositionTypeEnum
  currencyCode: CurrencyCodeEnum
  customsInput: ProductCustomsInput
  description: String
  height: Decimal
  images: [ImageInput!]
  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​

AddProductInput.brandId ● ID scalar common​

The ID of the brand to which this product belongs.

AddProductInput.bulletPoints ● [String!] list scalar common​

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

AddProductInput.categoryId ● ID deprecated scalar common​

DEPRECATED

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

The ID of the category to which this product belongs.

AddProductInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

AddProductInput.colorId ● ID deprecated scalar common​

DEPRECATED

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

AddProductInput.compositionLines ● [CompositionLineInput!] list input products​

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

AddProductInput.compositionType ● CompositionTypeEnum enum products​

Indicates the grouping nature for this composed product

AddProductInput.currencyCode ● CurrencyCodeEnum enum common​

AddProductInput.customsInput ● ProductCustomsInput input products​

AddProductInput.description ● String scalar common​

AddProductInput.height ● Decimal scalar common​

AddProductInput.images ● [ImageInput!] list input products​

AddProductInput.innerPack ● Boolean scalar common​

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

AddProductInput.innerPackInput ● ProductInnerPackInput input products​

AddProductInput.length ● Decimal scalar common​

AddProductInput.masterCarton ● Boolean scalar common​

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

AddProductInput.masterCartonInput ● ProductMasterCartonInput input products​

AddProductInput.name ● String! non-null scalar common​

AddProductInput.packagingUrl ● Url scalar common​

AddProductInput.pallet ● Boolean scalar common​

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

AddProductInput.palletInput ● ProductPalletInput input products​

AddProductInput.parentId ● ID scalar common​

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

AddProductInput.partNumber ● String scalar common​

AddProductInput.price ● Decimal deprecated scalar common​

DEPRECATED

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

AddProductInput.priceMap ● BigDecimal scalar common​

AddProductInput.priceMsrp ● BigDecimal scalar common​

AddProductInput.productAttributes ● [ProductAttributeInput!] list input products​

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

AddProductInput.productEconomics ● ProductEconomicsInput input products​

AddProductInput.productTags ● [ProductTagInput!] list input products​

AddProductInput.productType ● ProductTypeEnum enum products​

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

AddProductInput.purchasingInput ● ProductPurchasingInput deprecated input products​

DEPRECATED

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

AddProductInput.restockThreshold ● Int scalar common​

AddProductInput.ship ● Boolean scalar common​

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

AddProductInput.shippingInput ● ProductShippingInput input products​

AddProductInput.sizeId ● ID deprecated scalar common​

DEPRECATED

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

AddProductInput.sku ● String! non-null scalar common​

AddProductInput.sourcingMethod ● ProductSourcingMethodEnum enum products​

AddProductInput.specsUrl ● Url scalar common​

AddProductInput.status ● ProductStatusEnum deprecated enum products​

DEPRECATED

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

AddProductInput.styleId ● ID deprecated scalar common​

DEPRECATED

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

AddProductInput.uom ● ProductUomEnum enum products​

AddProductInput.upc ● String scalar common​

AddProductInput.weight ● Decimal scalar common​

AddProductInput.width ● Decimal scalar common​

Member Of​

addProduct mutation