UpdateProductInput
Input parameter for the updateProduct
mutation.
- The caller must have permission to modify the underlying product, e.g. STANDARDPRODUCT_UPDATE for StandardProduct, VARIANTPRODUCT_UPDATE for VariantProduct, and GROUPPRODUCT_UPDATE for GroupProduct.
- The caller must have permission to view the result, e.g. STANDARDPRODUCT_VIEW for StandardProduct, VARIANTPRODUCT_VIEW for VariantProduct, and GROUPPRODUCT_VIEW for GroupProduct. If none of the required update permissions are assigned, an exception will be thrown, e.g. if the product ref is for a StandardProduct but STANDARDPRODUCT_UPDATE is not granted, then no product will be updated and the exception will be thrown. If none of the required viewing permissions are assigned, an exception will be thrown, e.g. if the product ref is for a StandardProduct but STANDARDPRODUCT_VIEW is not granted, then no product will be returned and the exception will be thrown.
- If the result contains multiple products with the same ref, they will be updated accordingly and an exception will be thrown.
During the
updateProduct
mutation, the following fields behave in an "UPSERT" or UPDATE / INSERT manner:
-
attributes
-name
is the unique key for the Attributetype
andvalue
. If an associated Attribute with a matchingname
already exists, then thetype
andvalue
fields will be updated, else it will be inserted. -
prices
-type
andcurrency
are the unique key for the Pricevalue
. If an associated Price with a matchingname
andtype
already exists, then thevalue
field will be updated, else it will be inserted.
Input Fields
String!
)
The unique reference identifier for the Product.
Max character limit: 100.
ProductCatalogueKey!
)
The Product Catalogue in which this Product is managed
String
)
The type of a Product (Standard, Variant or Group). Note that, this productType should not map to field type. The valid values are: STANDARD, VARIANT, or GROUP. Max character limit: 15.
String
)
Max character limit: 50.
String
)
Max character limit: 50.
String
)
The name of the Product
String
)
A short description of the Product (max 255 chars)
[AttributeInput]
)
A list of attributes associated with this Product. This can be used to extend the existing data structure with additional data for use in orchestration rules, etc.
[PriceInput]
)
A list of Prices for this Product
TaxTypeInput
)
The tax information for this Product