ProductBulkCreateInput

Input type for bulk product creation with all ProductCreate features.

input ProductBulkCreateInput {
  attributes: [AttributeValueInput!]
  variantAttributes: [ID!]
  productType: ID
  customFields: [AttributeValueInput!]
  publicationDate: Date
  category: ID
  chargeTaxes: Boolean
  collections: [ID!]
  currency: String
  description: String
  descriptionHtml: String
  isPublished: Boolean
  name: String
  slug: String
  taxCode: String
  seo: SeoInput
  weight: WeightScalar
  sku: String
  trackInventory: Boolean
  basePrice: PositiveDecimal
  costPrice: PositiveDecimal
  visibleInListings: Boolean
  overridePrice: Boolean
  overrideCurrency: Boolean
  subStatus: ProductSubStatusEnum
  subStatusReason: String
  isShippingRequired: Boolean
  isDigital: Boolean
  isPriceOverrideAllowed: Boolean
  dimensions: ProductDimensionsInput
  allowSellerVariants: Boolean
  seller: ID!
  stocks: [StockInput!]
  isAvailable: Boolean
  allowBackorders: Boolean
  startDate: Date
  externalSource: String
  externalId: String
  image: Upload
  productSource: ProductSourceEnum
}

Show more ↓

Fields

ProductBulkCreateInput.attributes ● [AttributeValueInput!] list input

List of attributes.

ProductBulkCreateInput.variantAttributes ● [ID!] list scalar

List of attributes to assign as variant attributes to this product.

ProductBulkCreateInput.productType ● ID scalar

ID of the type that product belongs to.

ProductBulkCreateInput.customFields ● [AttributeValueInput!] list input

List of custom fields.

ProductBulkCreateInput.publicationDate ● Date scalar

Publication date. ISO 8601 standard.

ProductBulkCreateInput.category ● ID scalar

ID of the product's category.

ProductBulkCreateInput.chargeTaxes ● Boolean scalar

Determine if taxes are being charged for the product.

ProductBulkCreateInput.collections ● [ID!] list scalar

List of IDs of collections that the product belongs to.

ProductBulkCreateInput.currency ● String scalar

Choose a currency to assign to the product prices.

ProductBulkCreateInput.description ● String scalar

Product description (plaintext, read-only).

ProductBulkCreateInput.descriptionHtml ● String scalar

Product description (html).

ProductBulkCreateInput.isPublished ● Boolean scalar

Determines if product is visible to customers.

ProductBulkCreateInput.name ● String scalar

Product name.

ProductBulkCreateInput.slug ● String scalar

Product slug.

ProductBulkCreateInput.taxCode ● String scalar

Tax rate for enabled tax gateway.

ProductBulkCreateInput.seo ● SeoInput input

Search engine optimization fields.

ProductBulkCreateInput.weight ● WeightScalar scalar

Weight of the Product.

ProductBulkCreateInput.sku ● String scalar

Stock keeping unit of a product. Note: this field is only used if a product doesn't use variants. DEPRECATED: All products are now configurable instead of simple. This field will be removed after 2024-07-01.

ProductBulkCreateInput.trackInventory ● Boolean scalar

Determines whether to track changes to this variant's inventory. If set to 'false', the product's stock quantity won't reduce when a customer purchases this item. However, even when 'false', you must assign a stock quantity to a warehouse to allow checkouts. Usually, this involves allocating a placeholder stock amount that matches the maximum quantity purchased at once. Note: this field is applicable only for simple products.DEPRECATED: All products are now configurable instead of simple. This field will be removed after 2024-07-01.

ProductBulkCreateInput.basePrice ● PositiveDecimal scalar

Default price for product variant. DEPRECATED: All products are now configurable instead of simple. This field will be removed after 2024-07-01.

ProductBulkCreateInput.costPrice ● PositiveDecimal scalar

Default cost price for product variant. DEPRECATED: All products are now configurable instead of simple. This field will be removed after 2024-07-01.

ProductBulkCreateInput.visibleInListings ● Boolean scalar

Determines if product is visible in product listings (doesn't apply to product collections).

ProductBulkCreateInput.overridePrice ● Boolean scalar

Override price for grouped products

ProductBulkCreateInput.overrideCurrency ● Boolean scalar

Override currency for product

ProductBulkCreateInput.subStatus ● ProductSubStatusEnum enum

Substatus the product is to be changed to.

ProductBulkCreateInput.subStatusReason ● String scalar

A reason for why the sub status changed, which will be displayed to the creator of the product.

ProductBulkCreateInput.isShippingRequired ● Boolean scalar

Set whether this product requires shipping by default, will be overridden by product type if provided

ProductBulkCreateInput.isDigital ● Boolean scalar

Set whether this product is digital by default, will be overridden by product type if provided

ProductBulkCreateInput.isPriceOverrideAllowed ● Boolean scalar

Set whether this product allows price overrides by default, will be controlled by product type if provided

ProductBulkCreateInput.dimensions ● ProductDimensionsInput input

Product dimensions.

ProductBulkCreateInput.allowSellerVariants ● Boolean scalar

When enabled, other sellers can create their own variants on this product (cross-sell). Requires marketplace-level enable_master_products to be True. Only the product owner can modify this setting.

ProductBulkCreateInput.seller ● ID! non-null scalar

ID of the seller that product belongs to.

ProductBulkCreateInput.stocks ● [StockInput!] list input

Stocks of a product available for sale. Note: this field is only used if a product doesn't use variants. DEPRECATED: All products are now configurable instead of simple. This field will be removed after 2024-07-01.

ProductBulkCreateInput.isAvailable ● Boolean scalar

Determine if product should be available for purchase.

ProductBulkCreateInput.allowBackorders ● Boolean scalar

Whether to allow backorders for this product variant, if backorders are permitted at the marketplace level

ProductBulkCreateInput.startDate ● Date scalar

A start date from which a product will be available for purchase. When not set and isAvailable is set to True, the current day is assumed.

ProductBulkCreateInput.externalSource ● String scalar

The external source identifier of a foreign system (e.g. nautical.fulfillment.shopify) if a product originated from that system, used in combination with provided externalId. If submitting externalSource, you must also provide an externalId argument. If these two are provided, the productCreate mutation will attempt to perform an upsert instead of a creation.

ProductBulkCreateInput.externalId ● String scalar

The external ID from a foreign system if a product originated from that system, used in combination with provided externalSource. If submitting externalId, you must also provide an externalSource argument. If these two are provided, the productCreate mutation will attempt to perform an upsert instead of a creation.

ProductBulkCreateInput.image ● Upload scalar

Represents an image file in a multipart request.

ProductBulkCreateInput.productSource ● ProductSourceEnum enum

Where the product was created (e.g dashboard, shopify, csv, api)

Member Of

productBulkCreate mutation