ProductCreateInput
No description
input ProductCreateInput {
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
}
Fields
ProductCreateInput.attributes ● [AttributeValueInput!] list input
List of attributes.
ProductCreateInput.variantAttributes ● [ID!] list scalar
List of attributes to assign as variant attributes to this product.
ProductCreateInput.productType ● ID scalar
ID of the type that product belongs to.
ProductCreateInput.customFields ● [AttributeValueInput!] list input
List of custom fields.
ProductCreateInput.publicationDate ● Date scalar
Publication date. ISO 8601 standard.
ProductCreateInput.category ● ID scalar
ID of the product's category.
ProductCreateInput.chargeTaxes ● Boolean scalar
Determine if taxes are being charged for the product.
ProductCreateInput.collections ● [ID!] list scalar
List of IDs of collections that the product belongs to.
ProductCreateInput.currency ● String scalar
Choose a currency to assign to the product prices.
ProductCreateInput.description ● String scalar
Product description (plaintext, read-only).
ProductCreateInput.descriptionHtml ● String scalar
Product description (html).
ProductCreateInput.isPublished ● Boolean scalar
Determines if product is visible to customers.
ProductCreateInput.name ● String scalar
Product name.
ProductCreateInput.slug ● String scalar
Product slug.
ProductCreateInput.taxCode ● String scalar
Tax rate for enabled tax gateway.
ProductCreateInput.seo ● SeoInput input
Search engine optimization fields.
ProductCreateInput.weight ● WeightScalar scalar
Weight of the Product.
ProductCreateInput.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.
ProductCreateInput.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.
ProductCreateInput.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.
ProductCreateInput.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.
ProductCreateInput.visibleInListings ● Boolean scalar
Determines if product is visible in product listings (doesn't apply to product collections).
ProductCreateInput.overridePrice ● Boolean scalar
Override price for grouped products
ProductCreateInput.overrideCurrency ● Boolean scalar
Override currency for product
ProductCreateInput.subStatus ● ProductSubStatusEnum enum
Substatus the product is to be changed to.
ProductCreateInput.subStatusReason ● String scalar
A reason for why the sub status changed, which will be displayed to the creator of the product.
ProductCreateInput.isShippingRequired ● Boolean scalar
Set whether this product requires shipping by default, will be overridden by product type if provided
ProductCreateInput.isDigital ● Boolean scalar
Set whether this product is digital by default, will be overridden by product type if provided
ProductCreateInput.isPriceOverrideAllowed ● Boolean scalar
Set whether this product allows price overrides by default, will be controlled by product type if provided
ProductCreateInput.dimensions ● ProductDimensionsInput input
Product dimensions.
ProductCreateInput.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.
ProductCreateInput.seller ● ID! non-null scalar
ID of the seller that product belongs to.
ProductCreateInput.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.
ProductCreateInput.isAvailable ● Boolean scalar
Determine if product should be available for purchase.
ProductCreateInput.allowBackorders ● Boolean scalar
Whether to allow backorders for this product variant, if backorders are permitted at the marketplace level
ProductCreateInput.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.
ProductCreateInput.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.
ProductCreateInput.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.
ProductCreateInput.image ● Upload scalar
Represents an image file in a multipart request.
ProductCreateInput.productSource ● ProductSourceEnum enum
Where the product was created (e.g dashboard, shopify, csv, api)
Member Of
productCreate mutation