Magidoc

ProductInput
Input Object

The properties of the new Product.

Fields

#

attributes

Product-level attributes (e.g., brand, condition). Unlike variant-level `options` (which vary per variant), these apply to the product as a whole.

autoCreateShippingProfile

Whether to automatically create a shipping profile if one does not exist. When true, uses the product weight (and dimensions, if supplied) to create or find a matching shipping profile.

description

Non-null

The description of the Product. Description cannot be blank and must be less than 1000 characters.

dimensions

Package dimensions for the Product. When provided, `weight` and `weightUnit` are required. Markets that require dimensional weight (e.g. AU) need this to be set.

externalId

hazardousMaterial

The hazardous material information of the Product.

id

Specifies the Product to update in productUpdate or creates a new product if not present.

offerable

Whether the product is offerable.

options

List of AttributeInput associated with the Product

productCategory

Non-null

The ProductCategoryInput associated with the Product.

shippingProfileId

The id of an existing ShippingProfile to associate with this Product. If provided, no shipping profile lookup or creation is performed, and `weight`/`weightUnit`/`dimensions` are ignored. The profile must belong to the caller or be a system default.

shippingProfileOptions

Options for auto-created shipping profiles. Only used when autoCreateShippingProfile is true.

title

Non-null

The title of the Product. Title cannot be blank and must be less than 1000 characters.

variants

The ProductVariantInput associated with the Product.

weight

The weight of the Product. Must be greater than 0 when provided. Optional. If `shippingProfileId` is provided, the supplied profile is used directly and `weight` is ignored. If neither `shippingProfileId` nor `weight` is provided, the Product is assigned a default "undefined" shipping profile, and the seller must configure one before the Product can be activated or assigned to a livestream.

weightUnit

The weight unit of the Product. Required when `weight` is provided.

Usages

#

References

#

  • Argument input of field productCreate from type Mutation
  • Argument input of field productUpdate from type Mutation