Queries and mutations for managing Product Selections in the platform.
Queries
Query Product Selections
| Arguments | |
|---|---|
whereString | |
sortArray of String | |
limitInt | |
offsetInt | |
Get Product Selection
| Arguments | |
|---|---|
idString | Queries with specified ID |
keyString | Queries with specified key |
Query Product Selection Assignments
| Arguments | |
|---|---|
whereString | |
sortArray of String | |
limitInt | |
offsetInt | |
Mutations
Create Product Selection
Update Product Selection
| Arguments | |
|---|---|
versionLong | |
actionsArray of ProductSelectionUpdateAction | |
idString | Queries with specified ID |
keyString | Queries with specified key |
Delete Product Selection
| Arguments | |
|---|---|
versionLong | |
idString | Queries with specified ID |
keyString | Queries with specified key |
Output types
ProductSelection
keyString | User-defined unique identifier of the ProductSelection. |
nameString | Name of the ProductSelection. |
nameAllLocalesArray of LocalizedString | Name of the ProductSelection. |
productRefs | |
productCountInt | Number of Products that are currently assigned to this ProductSelection. |
custom | Custom Fields of the ProductSelection. |
mode | Specifies in which way the Products are assigned to the ProductSelection.
Currently, the only way of doing this is to specify each Product individually, either by including or excluding them explicitly. Can be Individual, or IndividualExclusion |
idString | Unique identifier of the ProductSelection. |
versionLong | Current version of the ProductSelection. |
createdAt | Date and time (UTC) the ProductSelection was initially created. |
lastModifiedAt | Date and time (UTC) the ProductSelection was last updated. |
createdBy | Present on resources created after 1/02/2019 except for events not tracked. |
lastModifiedBy | Present on resources updated after 1/02/2019 except for events not tracked. |
ProductOfSelectionQueryResult
offsetInt | |
countInt | |
totalLong | |
existsBoolean | |
resultsArray of ProductOfSelection |
ProductOfSelection
productRef | |
product | |
variantSelection | |
variantExclusion |
ProductVariantSelection
typeString | |
skusArray of String |
ProductVariantExclusion
IndividualExclusion ProductSelectionMode. Product Variants not listed remain available in the Product Selection.skusArray of String | Non-empty array of SKUs representing Product Variants to be excluded from the Product Selection with IndividualExclusion ProductSelectionMode. |
ProductSelectionMode
Individual- Mode of Product Selection used to include a specific list of individual Products
IndividualExclusion- Mode of Product Selection used to exclude a specific list of individual Products
ProductSelectionQueryResult
offsetInt | |
countInt | |
totalLong | |
existsBoolean | |
resultsArray of ProductSelection |
ProductAssignmentQueryResult
offsetInt | |
countInt | |
totalLong | |
existsBoolean | |
resultsArray of ProductAssignment |
ProductAssignment
productRef | |
product | |
productSelectionRef | |
productSelection | |
variantSelection | |
variantExclusion |
ProductVariantSelection
typeString | |
skusArray of String |
ProductVariantExclusion
IndividualExclusion ProductSelectionMode. Product Variants not listed remain available in the Product Selection.skusArray of String | Non-empty array of SKUs representing Product Variants to be excluded from the Product Selection with IndividualExclusion ProductSelectionMode. |
Input types
CreateProductSelectionDraft
keyString | |
nameArray of LocalizedStringItemInputType | |
mode | Can be Individual, or IndividualExclusion |
custom |
ProductSelectionMode
Individual- Mode of Product Selection used to include a specific list of individual Products
IndividualExclusion- Mode of Product Selection used to exclude a specific list of individual Products
ProductSelectionUpdateAction
addProduct | |
changeName | |
excludeProduct | |
removeProduct | |
setCustomField | |
setCustomType | |
setKey | |
setVariantExclusion | |
setVariantSelection |
Update actions
Add Product
Adds a Product to the Product Selection.
product | ResourceIdentifier of the Product |
variantSelection | Defines which Variants of the Product will be included in the Product Selection. If not supplied all Variants are deemed to be included. |
ProductVariantSelectionDraft
includeOnlyArray of String | |
includeAllExceptArray of String |
Change Name
nameArray of LocalizedStringItemInputType | The new name to be set for the ProductSelection. |
Exclude Product
product | |
variantExclusion |
ProductVariantExclusionDraft
skusArray of String |
Remove Product
product | ResourceIdentifier of the Product |
Set Custom Field
nameString | Name of the Custom Field. |
valueString | If value is absent or null, this field will be removed if it exists.
Removing a field that does not exist returns an InvalidOperation error.
If value is provided, it is set for the field defined by name. |
Set Custom Type
fieldsArray of CustomFieldInput | |
type | |
typeKeyString | |
typeIdString |
Set Key
keyString | If key is absent or null, the existing key, if any, will be removed. |
Set Variant Exclusion
IndividualExclusion ProductSelectionMode.product | ResourceIdentifier of the Product |
variantExclusion | Determines which Variants of the previously excluded Product are to be excluded from the Product Selection with IndividualExclusion ProductSelectionMode.
Leave it empty to unset an existing Variant Exclusion. |
ProductVariantExclusionDraft
skusArray of String |
Set Variant Selection
Individual ProductSelectionMode.product | ResourceIdentifier of the Product |
variantSelection | Determines which Variants of the previously added Product are to be included in, or excluded from, the Product Selection. Leave it empty to unset an existing Variant Selection. |
ProductVariantSelectionDraft
includeOnlyArray of String | |
includeAllExceptArray of String |