novomind iSHOP GraphQL API Reference
Congratulations! You found the documentation to the novomind iSHOP GraphQL API (in short: Shop API) which provides queries and mutations to the public resources in the novomind iSHOP.
API Endpoints
# Stable API, only accessible from within the novomind network:
https://novosales-hl-prod.kubfra-ishop.novomind.com/api/managment/
# Your API endpoint!:
https://<your server>/api/managment/
Headers
# Please check the documentation on how to get the token
Authorization: Bearer <YOUR_TOKEN_HERE>Version
47
Queries
_service
Response
Returns a _Service!
Example
Query
query _service {
_service {
sdl
}
}
Response
{"data": {"_service": {"sdl": "abc123"}}}
abTest_findAbTests
Description
Finds all AB-Tests for a specific MCS.
Response
Returns an AbTestFindPayload!
Arguments
| Name | Description |
|---|---|
filter - AbTestFilterInput!
|
Filter Information. Default = {status: []} |
paging - AbTestPagingInput!
|
Paging Information. Default = {sorting: {sortColumn: NAME, sortOrder: ASC}, paging: {limit: 100, offset: 0}} |
Example
Query
query AbTest_findAbTests(
$filter: AbTestFilterInput!,
$paging: AbTestPagingInput!
) {
abTest_findAbTests(
filter: $filter,
paging: $paging
) {
entries {
id
version
mcs {
...McsFragment
}
name
description
hypothesis
startDate
endDate
status
scenarios {
...AbTestScenarioFragment
}
deleted
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
totalCount
}
}
Variables
{
"filter": {"status": [""]},
"paging": {
"sorting": {"sortColumn": "NAME", "sortOrder": "ASC"},
"paging": {"limit": 100, "offset": 0}
}
}
Response
{
"data": {
"abTest_findAbTests": {
"entries": [AbTest],
"totalCount": 123
}
}
}
abtest_isAbTestUsed
Description
Check if A/B test is used by in any place or not
Response
Returns an AbTestUsedStatus!
Arguments
| Name | Description |
|---|---|
input - AbTestDeleteFilterInput
|
Example
Query
query Abtest_isAbTestUsed($input: AbTestDeleteFilterInput) {
abtest_isAbTestUsed(input: $input)
}
Variables
{"input": AbTestDeleteFilterInput}
Response
{"data": {"abtest_isAbTestUsed": "NONE"}}
aihub_checkStatus
Response
Returns a CheckAiHubStatusPayload!
Example
Query
query Aihub_checkStatus {
aihub_checkStatus {
aiHubActive
translationProviderConfigured
}
}
Response
{
"data": {
"aihub_checkStatus": {
"aiHubActive": false,
"translationProviderConfigured": true
}
}
}
aihub_generateImageDescriptions
Response
Returns a GenerateImageDescriptionsPayload!
Arguments
| Name | Description |
|---|---|
input - GenerateImageDescriptionsInput!
|
Example
Query
query Aihub_generateImageDescriptions($input: GenerateImageDescriptionsInput!) {
aihub_generateImageDescriptions(input: $input) {
errorMessage
entries {
identifier
imageDescriptions {
...AiGeneratedImageDescriptionFragment
}
}
}
}
Variables
{"input": GenerateImageDescriptionsInput}
Response
{
"data": {
"aihub_generateImageDescriptions": {
"errorMessage": "xyz789",
"entries": [DescriptionsForImage]
}
}
}
aihub_generateSynonyms
Response
Returns a GenerateSynonymsPayload!
Arguments
| Name | Description |
|---|---|
input - GenerateSynonymsInput!
|
Example
Query
query Aihub_generateSynonyms($input: GenerateSynonymsInput!) {
aihub_generateSynonyms(input: $input) {
errorMessage
entries {
searchTerm
synonyms {
...AiGeneratedSynonymFragment
}
}
}
}
Variables
{"input": GenerateSynonymsInput}
Response
{
"data": {
"aihub_generateSynonyms": {
"errorMessage": "xyz789",
"entries": [SynonymsForSearchTerm]
}
}
}
aihub_generateTranslations
Response
Returns a GenerateTranslationsPayload!
Arguments
| Name | Description |
|---|---|
input - GenerateTranslationsInput!
|
Example
Query
query Aihub_generateTranslations($input: GenerateTranslationsInput!) {
aihub_generateTranslations(input: $input) {
errorMessage
entries {
identifier
translations {
...AiGeneratedTranslationFragment
}
}
}
}
Variables
{"input": GenerateTranslationsInput}
Response
{
"data": {
"aihub_generateTranslations": {
"errorMessage": "abc123",
"entries": [TranslationsForInput]
}
}
}
assetFormat_findAssetFormats
Response
Returns [AssetFormat!]!
Example
Query
query AssetFormat_findAssetFormats {
assetFormat_findAssetFormats {
id
version
name
width
height
}
}
Response
{
"data": {
"assetFormat_findAssetFormats": [
{
"id": "4",
"version": {},
"name": "abc123",
"width": 987,
"height": 123
}
]
}
}
asset_checkIfAssetsIsInUse
Description
Check if assets are used in contents, promotions, brands or links
Response
Returns [AssetDeleteModel!]!
Arguments
| Name | Description |
|---|---|
input - [Long!]!
|
Example
Query
query Asset_checkIfAssetsIsInUse($input: [Long!]!) {
asset_checkIfAssetsIsInUse(input: $input) {
assetId
isInUse
}
}
Variables
{"input": [{}]}
Response
{"data": {"asset_checkIfAssetsIsInUse": [{"assetId": {}, "isInUse": true}]}}
asset_checkIfOptimizationEnabled
Description
Check if image optimization enabled
Response
Returns an AssetOptimizationEnabledPayload!
Example
Query
query Asset_checkIfOptimizationEnabled {
asset_checkIfOptimizationEnabled {
isOptimizationEnabled
}
}
Response
{"data": {"asset_checkIfOptimizationEnabled": {"isOptimizationEnabled": true}}}
asset_findAssets
Description
Finds assets regarding to input data
Response
Returns an Assets!
Arguments
| Name | Description |
|---|---|
input - AssetSearchFilterInput!
|
Default = {currentUserOnly: false, assetCategories: [IMAGE, VIDEO, PDF, STATIC_CONTENT, ZIP, OFFICE, OTHERS], sorting: {sortOrder: DESC, sortColumn: INFO}, paging: {limit: 100, offset: 0}} |
Example
Query
query Asset_findAssets($input: AssetSearchFilterInput!) {
asset_findAssets(input: $input) {
entries {
id
version
name
mcs {
...McsFragment
}
contentType
assetCategory
size
keywords
url
uploadedDate
lastModified
uploadedUser {
...UserInformationFragment
}
editedUser {
...UserInformationFragment
}
assetType
}
totalCount
maxAssetSize
}
}
Variables
{
"input": {
"currentUserOnly": "false",
"assetCategories": [
"IMAGE",
"VIDEO",
"PDF",
"STATIC_CONTENT",
"ZIP",
"OFFICE",
"OTHERS"
],
"sorting": {"sortOrder": "DESC", "sortColumn": "INFO"},
"paging": {"limit": 100, "offset": 0}
}
}
Response
{
"data": {
"asset_findAssets": {
"entries": [Asset],
"totalCount": 987,
"maxAssetSize": {}
}
}
}
asset_findSearchSuggest
Description
Finds keywords for search suggestions
Response
Returns a SearchSuggestResult!
Arguments
| Name | Description |
|---|---|
input - AssetSearchFilterInput!
|
Default = {currentUserOnly: false, assetCategories: [IMAGE, VIDEO, PDF, STATIC_CONTENT, ZIP, OFFICE, OTHERS], sorting: {sortOrder: DESC, sortColumn: INFO}, paging: {limit: 100, offset: 0}} |
Example
Query
query Asset_findSearchSuggest($input: AssetSearchFilterInput!) {
asset_findSearchSuggest(input: $input) {
elements
totalCount
}
}
Variables
{
"input": {
"currentUserOnly": "false",
"assetCategories": [
"IMAGE",
"VIDEO",
"PDF",
"STATIC_CONTENT",
"ZIP",
"OFFICE",
"OTHERS"
],
"sorting": {"sortOrder": "DESC", "sortColumn": "INFO"},
"paging": {"limit": 100, "offset": 0}
}
}
Response
{
"data": {
"asset_findSearchSuggest": {
"elements": ["xyz789"],
"totalCount": 987
}
}
}
campaign_findCampaigns
Description
Find all campaigns in a single MCS.
Response
Returns a CampaignFindPayload!
Arguments
| Name | Description |
|---|---|
paging - CampaignPagingInput!
|
Paging and sorting parameters to use. Default = {pagingInput: {limit: 100, offset: 0}, sortInput: {sortOrder: ASC, sortType: INFO}} |
filter - CampaignFilterInput!
|
The filter parameters to search for. Default = {} |
Example
Query
query Campaign_findCampaigns(
$paging: CampaignPagingInput!,
$filter: CampaignFilterInput!
) {
campaign_findCampaigns(
paging: $paging,
filter: $filter
) {
totalCount
entries {
id
version
name
mcs {
...McsFragment
}
startDate
endDate
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
status
references {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
}
}
}
Variables
{
"paging": {
"pagingInput": {"limit": 100, "offset": 0},
"sortInput": {"sortOrder": "ASC", "sortType": "INFO"}
},
"filter": {}
}
Response
{
"data": {
"campaign_findCampaigns": {
"totalCount": 123,
"entries": [Campaign]
}
}
}
campaign_validateCampaignUpdate
Response
Returns a CampaignValidateUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - CampaignValidateUpdateInput!
|
Example
Query
query Campaign_validateCampaignUpdate($input: CampaignValidateUpdateInput!) {
campaign_validateCampaignUpdate(input: $input) {
campaign {
id
version
name
mcs {
...McsFragment
}
startDate
endDate
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
status
references {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
}
affectedContents {
contentsWithSameValidity {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
contentsWithHoles {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
followupOverwrittenByCampaign {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
previousOverwrittenByCampaign {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
ongoingOverwrittenByCampaignAfterExtendingEndDate {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
ongoingOverwrittenByCampaignAfterShorteningEndDate {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
ongoingOverwrittenByCampaignAfterExtendingStartDate {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
ongoingOverwrittenByCampaignAfterShorteningStartDate {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
followupOverwritesForCampaign {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
previousOverwritesForCampaign {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
ongoingOverwritesForCampaignAfterExtendingEndDate {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
ongoingOverwritesForCampaignAfterShorteningEndDate {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
ongoingOverwritesForCampaignAfterExtendingStartDate {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
ongoingOverwritesForCampaignAfterShorteningStartDate {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
followupContents {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
}
}
}
Variables
{"input": CampaignValidateUpdateInput}
Response
{
"data": {
"campaign_validateCampaignUpdate": {
"campaign": Campaign,
"affectedContents": AffectedContents
}
}
}
cip_findConnectedIProductsStatus
Description
Preview voucher codes
Response
Returns a ConnectedIProductsStatusFindPayload!
Arguments
| Name | Description |
|---|---|
paging - ConnectedIProductsPagingInput!
|
Paging and sorting. Default = {sortOn: {sortOrder: ASC, sortColumn: PRODUCT_ID}, paging: {limit: 100, offset: 0}} |
filter - ConnectedIProductsFilterInput!
|
Filter use cases by product ids or use cases ids. Default = {} |
Example
Query
query Cip_findConnectedIProductsStatus(
$paging: ConnectedIProductsPagingInput!,
$filter: ConnectedIProductsFilterInput!
) {
cip_findConnectedIProductsStatus(
paging: $paging,
filter: $filter
) {
entries {
id
version
productId
useCaseId
active
}
totalCount
}
}
Variables
{
"paging": {
"sortOn": {"sortOrder": "ASC", "sortColumn": "PRODUCT_ID"},
"paging": {"limit": 100, "offset": 0}
},
"filter": {}
}
Response
{
"data": {
"cip_findConnectedIProductsStatus": {
"entries": [ConnectedIProductStatus],
"totalCount": 123
}
}
}
cms_findContentTimeline
Response
Returns a ContentTimelineFindPayload!
Arguments
| Name | Description |
|---|---|
filter - ContentTimelineFilterInput!
|
|
paging - ContentTimelinePagingInput!
|
Default = {paging: {limit: 100, offset: 0}, sorting: {sortColumn: TIME, sortOrder: ASC}} |
Example
Query
query Cms_findContentTimeline(
$filter: ContentTimelineFilterInput!,
$paging: ContentTimelinePagingInput!
) {
cms_findContentTimeline(
filter: $filter,
paging: $paging
) {
entries {
... on InheritedTimelineEvent {
...InheritedTimelineEventFragment
}
... on AbTimelineEvent {
...AbTimelineEventFragment
}
... on ContentTimelineEvent {
...ContentTimelineEventFragment
}
... on PreviousTimelineEvent {
...PreviousTimelineEventFragment
}
... on NextTimelineEvent {
...NextTimelineEventFragment
}
}
totalCount
}
}
Variables
{
"filter": ContentTimelineFilterInput,
"paging": {
"paging": {"limit": 100, "offset": 0},
"sorting": {"sortColumn": "TIME", "sortOrder": "ASC"}
}
}
Response
{
"data": {
"cms_findContentTimeline": {
"entries": [InheritedTimelineEvent],
"totalCount": 987
}
}
}
cms_findGrid
Does not work properly, use other cms_findGrid instead.
Response
Returns a GridPayload!
Arguments
| Name | Description |
|---|---|
filter - [GridFilterOperation!]!
|
Default = [] |
sort - [GridSortOperation!]!
|
Default = [] |
paging - Paging!
|
Default = {limit: 100, offset: 0} |
Example
Query
query Cms_findGrid(
$filter: [GridFilterOperation!]!,
$sort: [GridSortOperation!]!,
$paging: Paging!
) {
cms_findGrid(
filter: $filter,
sort: $sort,
paging: $paging
) {
entries {
id
version
name
timeValidity {
...DateRangeFragment
}
mcs {
...McsFragment
}
inherited
abScenario {
...AbTestScenarioFragment
}
audit {
...BackofficeUserInfoAuditFragment
}
gridElements {
...GridElementPayloadFragment
}
}
totalCount
}
}
Variables
{"filter": [""], "sort": [""], "paging": {"limit": 100, "offset": 0}}
Response
{
"data": {
"cms_findGrid": {"entries": [Grid], "totalCount": 987}
}
}
cms_findGridElementContainer
Does not work properly, use other cms_findGridElementContainer instead.
Response
Returns a GridElementContainerPayload!
Arguments
| Name | Description |
|---|---|
filter - [GridElementContainerFilterOperation!]!
|
Default = [] |
sort - [GridElementContainerSortOperation!]!
|
Default = [] |
paging - Paging!
|
Default = {limit: 100, offset: 0} |
Example
Query
query Cms_findGridElementContainer(
$filter: [GridElementContainerFilterOperation!]!,
$sort: [GridElementContainerSortOperation!]!,
$paging: Paging!
) {
cms_findGridElementContainer(
filter: $filter,
sort: $sort,
paging: $paging
) {
entries {
id
version
timeValidity {
... on Campaign {
...CampaignFragment
}
... on DateRange {
...DateRangeFragment
}
}
mcs {
...McsFragment
}
inherited
customerSegments {
...CustomerSegmentFragment
}
teaser {
...TeaserFragment
}
}
totalCount
}
}
Variables
{"filter": [""], "sort": [""], "paging": {"limit": 100, "offset": 0}}
Response
{
"data": {
"cms_findGridElementContainer": {
"entries": [GridElementContainer],
"totalCount": 123
}
}
}
cms_findGridTemplates
Response
Returns a GridTemplateFindPayload
Arguments
| Name | Description |
|---|---|
filter - GridTemplateFilterInput!
|
Default = {onlyCurrentUser: false} |
paging - GridTemplatePagingInput!
|
Default = {paging: {limit: 100, offset: 0}, sortOn: {sortOrder: ASC, sortColumn: INFO}} |
Example
Query
query Cms_findGridTemplates(
$filter: GridTemplateFilterInput!,
$paging: GridTemplatePagingInput!
) {
cms_findGridTemplates(
filter: $filter,
paging: $paging
) {
entries {
id
version
mcs {
...McsFragment
}
inherited
name
template {
...TeaserTemplateFragment
}
containers {
...GridTemplateContainerFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
totalCount
}
}
Variables
{
"filter": {"onlyCurrentUser": "false"},
"paging": {
"paging": {"limit": 100, "offset": 0},
"sortOn": {"sortOrder": "ASC", "sortColumn": "INFO"}
}
}
Response
{
"data": {
"cms_findGridTemplates": {
"entries": [GridTemplate],
"totalCount": 987
}
}
}
cms_findMostDefinedGrid
Response
Returns a Grid
Arguments
| Name | Description |
|---|---|
input - FindGridInput!
|
Example
Query
query Cms_findMostDefinedGrid($input: FindGridInput!) {
cms_findMostDefinedGrid(input: $input) {
id
version
name
timeValidity {
from
to
}
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
inherited
abScenario {
id
version
mcs {
...McsFragment
}
name
weight
trackingCode
defaultScenario
winning
abTest {
...AbTestFragment
}
}
audit {
created
updated
createdBy {
...UserInformationFragment
}
updatedBy {
...UserInformationFragment
}
}
gridElements {
entries {
...GridElementFragment
}
totalCount
}
}
}
Variables
{"input": FindGridInput}
Response
{
"data": {
"cms_findMostDefinedGrid": {
"id": "4",
"version": {},
"name": "abc123",
"timeValidity": DateRange,
"mcs": Mcs,
"inherited": false,
"abScenario": AbTestScenario,
"audit": BackofficeUserInfoAudit,
"gridElements": GridElementPayload
}
}
}
cms_findMostDefinedGridElementContainers
Description
Most defined for GridElementContainers:
- First by MultiChannelSelector.
- Then by CustomerSegment.
- Finally by time.
Response
Returns [GridElementContainer!]!
Arguments
| Name | Description |
|---|---|
input - FindGridElementContainerInput!
|
Example
Query
query Cms_findMostDefinedGridElementContainers($input: FindGridElementContainerInput!) {
cms_findMostDefinedGridElementContainers(input: $input) {
id
version
timeValidity {
... on Campaign {
...CampaignFragment
}
... on DateRange {
...DateRangeFragment
}
}
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
inherited
customerSegments {
id
version
name
mcs {
...McsFragment
}
description
deleted
type
dynamic
conditions {
...ComplexConditionFragment
}
group {
...CustomerSegmentGroupFragment
}
brokenInheritanceFrom
isStandardCustomerSegment
}
teaser {
id
version
teaserTemplate {
...TeaserTemplateFragment
}
name
trackingCode
searchable
values {
...DynamicTeaserAttributeFragment
}
type {
...ContentTypeFragment
}
mcs {
...McsFragment
}
pageName
pageType
customerSegments {
...CustomerSegmentFragment
}
timeValidity {
... on Campaign {
...CampaignFragment
}
... on DateRange {
...DateRangeFragment
}
}
}
}
}
Variables
{"input": FindGridElementContainerInput}
Response
{
"data": {
"cms_findMostDefinedGridElementContainers": [
{
"id": 4,
"version": {},
"timeValidity": Campaign,
"mcs": Mcs,
"inherited": true,
"customerSegments": [CustomerSegment],
"teaser": Teaser
}
]
}
}
cms_findTemplateType
Response
Returns a TemplateTypeFindPayload!
Arguments
| Name | Description |
|---|---|
filter - TemplateTypeFilterInput!
|
Default = {name: ""} |
paging - TemplateTypePagingInput!
|
Default = {paging: {limit: 100, offset: 0}, sortOn: {sortOrder: ASC, sortType: NAME}} |
Example
Query
query Cms_findTemplateType(
$filter: TemplateTypeFilterInput!,
$paging: TemplateTypePagingInput!
) {
cms_findTemplateType(
filter: $filter,
paging: $paging
) {
entries {
id
version
name
}
totalCount
}
}
Variables
{
"filter": {"name": ""},
"paging": {
"paging": {"limit": 100, "offset": 0},
"sortOn": {"sortOrder": "ASC", "sortType": "NAME"}
}
}
Response
{
"data": {
"cms_findTemplateType": {
"entries": [TeaserTemplate],
"totalCount": 123
}
}
}
condition_findCustomerSegmentConditionOwner
Description
Finds Condition types for customer segment Owner.
Response
Returns a ConditionTypeFindPayload!
Example
Query
query Condition_findCustomerSegmentConditionOwner {
condition_findCustomerSegmentConditionOwner {
elements {
id
displayName
description
}
totalCount
}
}
Response
{
"data": {
"condition_findCustomerSegmentConditionOwner": {
"elements": [ConditionType],
"totalCount": 987
}
}
}
condition_findDataExportConditions
Description
Find condition types for Data export owner.
Response
Returns a ConditionTypeFindPayload!
Example
Query
query Condition_findDataExportConditions {
condition_findDataExportConditions {
elements {
id
displayName
description
}
totalCount
}
}
Response
{
"data": {
"condition_findDataExportConditions": {
"elements": [ConditionType],
"totalCount": 987
}
}
}
condition_findFilterCategoryConditions
Description
Find condition types for filter category owner.
Response
Returns a ConditionTypeFindPayload!
Example
Query
query Condition_findFilterCategoryConditions {
condition_findFilterCategoryConditions {
elements {
id
displayName
description
}
totalCount
}
}
Response
{
"data": {
"condition_findFilterCategoryConditions": {
"elements": [ConditionType],
"totalCount": 987
}
}
}
condition_findFilterLevelConditions
Description
Find condition types for filter level owner.
Response
Returns a ConditionTypeFindPayload!
Example
Query
query Condition_findFilterLevelConditions {
condition_findFilterLevelConditions {
elements {
id
displayName
description
}
totalCount
}
}
Response
{
"data": {
"condition_findFilterLevelConditions": {
"elements": [ConditionType],
"totalCount": 987
}
}
}
condition_findPromotionConditionOwner
Description
Find Condition types for promotion Owner.
Response
Returns a ConditionTypeFindPayload!
Example
Query
query Condition_findPromotionConditionOwner {
condition_findPromotionConditionOwner {
elements {
id
displayName
description
}
totalCount
}
}
Response
{
"data": {
"condition_findPromotionConditionOwner": {
"elements": [ConditionType],
"totalCount": 123
}
}
}
condition_findSmartCategoryConditionOwner
Description
Find condition types for smart category owner.
Response
Returns a ConditionTypeFindPayload!
Example
Query
query Condition_findSmartCategoryConditionOwner {
condition_findSmartCategoryConditionOwner {
elements {
id
displayName
description
}
totalCount
}
}
Response
{
"data": {
"condition_findSmartCategoryConditionOwner": {
"elements": [ConditionType],
"totalCount": 987
}
}
}
condition_findTouchpointConditionOwner
Description
Finds Condition types for touchpoint Owner.
Response
Returns a ConditionTypeFindPayload!
Example
Query
query Condition_findTouchpointConditionOwner {
condition_findTouchpointConditionOwner {
elements {
id
displayName
description
}
totalCount
}
}
Response
{
"data": {
"condition_findTouchpointConditionOwner": {
"elements": [ConditionType],
"totalCount": 123
}
}
}
configuration_findConfigurations
Response
Returns a ConfigurationFindPayload!
Arguments
| Name | Description |
|---|---|
filter - ConfigurationFilterInput!
|
The filter configurations to search for. Default = {} |
paging - ConfigurationPagingInput!
|
The pagination and sorting input. Default = {sortingInput: {sortColumn: INFO, sortOrder: DESC}, pagingInput: {limit: 100, offset: 0}} |
Example
Query
query Configuration_findConfigurations(
$filter: ConfigurationFilterInput!,
$paging: ConfigurationPagingInput!
) {
configuration_findConfigurations(
filter: $filter,
paging: $paging
) {
totalCount
entries {
id
version
mcs {
...McsFragment
}
configKey
configValue
}
}
}
Variables
{
"filter": {},
"paging": {
"sortingInput": {"sortColumn": "INFO", "sortOrder": "DESC"},
"pagingInput": {"limit": 100, "offset": 0}
}
}
Response
{
"data": {
"configuration_findConfigurations": {
"totalCount": 123,
"entries": [Configuration]
}
}
}
core_boVersion
Description
Version of bo-core
Response
Returns a String!
Example
Query
query Core_boVersion {
core_boVersion
}
Response
{"data": {"core_boVersion": "abc123"}}
core_checkUrlValidity
Description
Checks if the given url is valid and reachable.
core_environment
Description
System environment (e.g. dev, integ, live)
Response
Returns a String!
Example
Query
query Core_environment {
core_environment
}
Response
{"data": {"core_environment": "xyz789"}}
core_findAllMcs
Description
Finds all undeleted MultiChannelSelectors in the shop.
Response
Returns [Mcs!]!
Example
Query
query Core_findAllMcs(
$offset: Int!,
$limit: Int!
) {
core_findAllMcs(
offset: $offset,
limit: $limit
) {
id
version
mcsString
displayString
deleted
parent
parentMcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
internalName
ishopBackoffice
mcs {
complete
brand
channel
country
currency
language
store
}
}
}
Variables
{"offset": 0, "limit": 200}
Response
{
"data": {
"core_findAllMcs": [
{
"id": 4,
"version": {},
"mcsString": "xyz789",
"displayString": "abc123",
"deleted": false,
"parent": true,
"parentMcs": Mcs,
"internalName": "xyz789",
"ishopBackoffice": true,
"mcs": BackofficeMultiChannelSelector
}
]
}
}
core_findAllUsersInformation
Description
Finds all users.
Response
Returns a UsersFindPayload!
Arguments
| Name | Description |
|---|---|
paging - UserInformationPagingInput!
|
Default = {sortInput: {sortOrder: ASC, sortColumn: NAME}, pagingInput: {limit: 100, offset: 0}} |
filter - UserInformationFilterInput!
|
The filter parameters to search for. Default = {} |
Example
Query
query Core_findAllUsersInformation(
$paging: UserInformationPagingInput!,
$filter: UserInformationFilterInput!
) {
core_findAllUsersInformation(
paging: $paging,
filter: $filter
) {
entries {
id
version
name
email
settings {
...UserSettingsFragment
}
userRoles {
...UserRoleEntityFragment
}
isSystemUser
}
totalCount
}
}
Variables
{
"paging": {
"sortInput": {"sortOrder": "ASC", "sortColumn": "NAME"},
"pagingInput": {"limit": 100, "offset": 0}
},
"filter": {}
}
Response
{
"data": {
"core_findAllUsersInformation": {
"entries": [UserInformation],
"totalCount": 123
}
}
}
core_findArticle
Description
Find articles by their article identifier.
Response
Returns an ArticleFindPayload!
Arguments
| Name | Description |
|---|---|
filter - FindArticleFilterInput!
|
Input information. |
Example
Query
query Core_findArticle($filter: FindArticleFilterInput!) {
core_findArticle(filter: $filter) {
entries {
articleIdentifier
totalNumberOfItems
items {
...Item_2Fragment
}
}
}
}
Variables
{"filter": FindArticleFilterInput}
Response
{"data": {"core_findArticle": {"entries": [Article]}}}
core_findArticles
Description
!!! DEPRECATED: Use core_findArticle instead. Find a single Article by its Articlenumber. Might still return multiple results, as the article might be a product, but results are always items.
Response
Returns an ArticlesResultItem!
Example
Query
query Core_findArticles(
$id: String!,
$paging: Paging!
) {
core_findArticles(
id: $id,
paging: $paging
) {
total
items {
... on Item {
...ItemFragment
}
... on UnknownItem {
...UnknownItemFragment
}
}
}
}
Variables
{
"id": "xyz789",
"paging": {"limit": 100, "offset": 0}
}
Response
{
"data": {
"core_findArticles": {"total": 987, "items": [Item]}
}
}
core_findBrands
Description
Find all brands in a single MCS.
Response
Returns a BrandFindPayload!
Arguments
| Name | Description |
|---|---|
paging - BrandPagingInput!
|
Paging and sorting parameters to use |
filter - BrandFilterInput!
|
The filter parameters to search for |
Example
Query
query Core_findBrands(
$paging: BrandPagingInput!,
$filter: BrandFilterInput!
) {
core_findBrands(
paging: $paging,
filter: $filter
) {
totalCount
entries {
id
version
mcs {
...McsFragment
}
name
valid
updatedBy {
...UserInformationFragment
}
status
images {
...BrandImageFragment
}
links {
...BrandAttributeLinkFragment
}
parameters {
...BrandParameterFragment
}
}
}
}
Variables
{
"paging": BrandPagingInput,
"filter": BrandFilterInput
}
Response
{
"data": {
"core_findBrands": {
"totalCount": 123,
"entries": [BrandEntity]
}
}
}
core_findCategory
Description
Find all categories that fit the given filter
Response
Returns [BackofficeCategory]!
Arguments
| Name | Description |
|---|---|
input - BackofficeCategoryInput!
|
A Filter describing categories |
Example
Query
query Core_findCategory($input: BackofficeCategoryInput!) {
core_findCategory(input: $input) {
id
version
simpleId
name
nameWithLocale
primaryId
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
ranking
path
url
valid
smart
parents {
id
version
simpleId
name
nameWithLocale
primaryId
mcs {
...McsFragment
}
ranking
path
url
valid
smart
parents {
...BackofficeCategoryFragment
}
online
childrenCount
childCategories {
...BackofficeCategoryFragment
}
status
}
online
childrenCount
childCategories {
id
version
simpleId
name
nameWithLocale
primaryId
mcs {
...McsFragment
}
ranking
path
url
valid
smart
parents {
...BackofficeCategoryFragment
}
online
childrenCount
childCategories {
...BackofficeCategoryFragment
}
status
}
status
}
}
Variables
{"input": BackofficeCategoryInput}
Response
{
"data": {
"core_findCategory": [
{
"id": "4",
"version": {},
"simpleId": "abc123",
"name": "xyz789",
"nameWithLocale": "xyz789",
"primaryId": "xyz789",
"mcs": Mcs,
"ranking": 987,
"path": "abc123",
"url": "xyz789",
"valid": false,
"smart": true,
"parents": [BackofficeCategory],
"online": false,
"childrenCount": 987,
"childCategories": [BackofficeCategory],
"status": "INVALID"
}
]
}
}
core_findCategoryTree
Description
Returns the root of the category tree
Response
Returns a BackofficeCategory!
Example
Query
query Core_findCategoryTree {
core_findCategoryTree {
id
version
simpleId
name
nameWithLocale
primaryId
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
ranking
path
url
valid
smart
parents {
id
version
simpleId
name
nameWithLocale
primaryId
mcs {
...McsFragment
}
ranking
path
url
valid
smart
parents {
...BackofficeCategoryFragment
}
online
childrenCount
childCategories {
...BackofficeCategoryFragment
}
status
}
online
childrenCount
childCategories {
id
version
simpleId
name
nameWithLocale
primaryId
mcs {
...McsFragment
}
ranking
path
url
valid
smart
parents {
...BackofficeCategoryFragment
}
online
childrenCount
childCategories {
...BackofficeCategoryFragment
}
status
}
status
}
}
Response
{
"data": {
"core_findCategoryTree": {
"id": 4,
"version": {},
"simpleId": "abc123",
"name": "abc123",
"nameWithLocale": "abc123",
"primaryId": "xyz789",
"mcs": Mcs,
"ranking": 987,
"path": "xyz789",
"url": "abc123",
"valid": true,
"smart": false,
"parents": [BackofficeCategory],
"online": false,
"childrenCount": 123,
"childCategories": [BackofficeCategory],
"status": "INVALID"
}
}
}
core_findChildrenWitParent
Response
Returns [BackofficeCategory]!
Arguments
| Name | Description |
|---|---|
input - ParentInput!
|
Category simple ids to load their children |
Example
Query
query Core_findChildrenWitParent($input: ParentInput!) {
core_findChildrenWitParent(input: $input) {
id
version
simpleId
name
nameWithLocale
primaryId
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
ranking
path
url
valid
smart
parents {
id
version
simpleId
name
nameWithLocale
primaryId
mcs {
...McsFragment
}
ranking
path
url
valid
smart
parents {
...BackofficeCategoryFragment
}
online
childrenCount
childCategories {
...BackofficeCategoryFragment
}
status
}
online
childrenCount
childCategories {
id
version
simpleId
name
nameWithLocale
primaryId
mcs {
...McsFragment
}
ranking
path
url
valid
smart
parents {
...BackofficeCategoryFragment
}
online
childrenCount
childCategories {
...BackofficeCategoryFragment
}
status
}
status
}
}
Variables
{"input": ParentInput}
Response
{
"data": {
"core_findChildrenWitParent": [
{
"id": "4",
"version": {},
"simpleId": "abc123",
"name": "xyz789",
"nameWithLocale": "abc123",
"primaryId": "xyz789",
"mcs": Mcs,
"ranking": 987,
"path": "xyz789",
"url": "abc123",
"valid": false,
"smart": true,
"parents": [BackofficeCategory],
"online": true,
"childrenCount": 123,
"childCategories": [BackofficeCategory],
"status": "INVALID"
}
]
}
}
core_findCompleteMcs
Description
Finds all undeleted complete (=frontend) MultiChannelSelectors in the shop.
Response
Returns [Mcs!]!
Example
Query
query Core_findCompleteMcs(
$offset: Int!,
$limit: Int!
) {
core_findCompleteMcs(
offset: $offset,
limit: $limit
) {
id
version
mcsString
displayString
deleted
parent
parentMcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
internalName
ishopBackoffice
mcs {
complete
brand
channel
country
currency
language
store
}
}
}
Variables
{"offset": 0, "limit": 200}
Response
{
"data": {
"core_findCompleteMcs": [
{
"id": "4",
"version": {},
"mcsString": "xyz789",
"displayString": "xyz789",
"deleted": true,
"parent": false,
"parentMcs": Mcs,
"internalName": "xyz789",
"ishopBackoffice": false,
"mcs": BackofficeMultiChannelSelector
}
]
}
}
core_findGoogleCategories
Description
Find all google categories
Response
Returns a GoogleCategoryFindPayload!
Arguments
| Name | Description |
|---|---|
paging - GoogleCategoryPagingInput!
|
Paging and sorting parameters to use. Default = {pagingInput: {limit: 100, offset: 0}, sortInput: {sortOrder: ASC, sortType: NAME}} |
filter - GoogleCategoryFilterInput!
|
The filter parameters to search for. Default = {} |
Example
Query
query Core_findGoogleCategories(
$paging: GoogleCategoryPagingInput!,
$filter: GoogleCategoryFilterInput!
) {
core_findGoogleCategories(
paging: $paging,
filter: $filter
) {
totalCount
entries {
id
version
name
createdDate
level
hasChildren
parentCategory {
...GoogleCategoryFragment
}
ancestors {
...GoogleCategoryFragment
}
children {
...GoogleCategoryFragment
}
}
}
}
Variables
{
"paging": {
"pagingInput": {"limit": 100, "offset": 0},
"sortInput": {"sortOrder": "ASC", "sortType": "NAME"}
},
"filter": {}
}
Response
{
"data": {
"core_findGoogleCategories": {
"totalCount": 987,
"entries": [GoogleCategory]
}
}
}
core_findMcs
Description
Finds a MultiChannelSelectors using its displaystring. Can find deleted MCS.
Response
Returns a Mcs
Example
Query
query Core_findMcs {
core_findMcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
internalName
ishopBackoffice
mcs {
complete
brand
channel
country
currency
language
store
}
}
}
Response
{
"data": {
"core_findMcs": {
"id": 4,
"version": {},
"mcsString": "xyz789",
"displayString": "xyz789",
"deleted": true,
"parent": false,
"parentMcs": Mcs,
"internalName": "xyz789",
"ishopBackoffice": true,
"mcs": BackofficeMultiChannelSelector
}
}
}
core_findPages
No longer supported
Description
DEPRECATED DO NOT USE
Response
Returns a PageSearchPayload!
Arguments
| Name | Description |
|---|---|
paging - PagePagingInput!
|
Default = {paging: {limit: 100, offset: 0}, sortInput: {sortOrder: ASC, sortType: NAME}} |
filter - PageFilterInput!
|
Default = {} |
Example
Query
query Core_findPages(
$paging: PagePagingInput!,
$filter: PageFilterInput!
) {
core_findPages(
paging: $paging,
filter: $filter
) {
entries {
id
version
name
valid
referenceType
}
totalCount
}
}
Variables
{
"paging": {
"paging": {"limit": 100, "offset": 0},
"sortInput": {"sortOrder": "ASC", "sortType": "NAME"}
},
"filter": {}
}
Response
{
"data": {
"core_findPages": {
"entries": [Page],
"totalCount": 987
}
}
}
core_findUrlParameterTemplates
Description
Find all url parameter templates in a single MCS.
Response
Returns an UrlParameterTemplateFindPayload!
Arguments
| Name | Description |
|---|---|
paging - UrlParameterTemplatePagingInput!
|
Paging and sorting parameters to use. Default = {pagingInput: {limit: 100, offset: 0}, sortInput: {sortOrder: ASC, sortType: INFO}} |
filter - UrlParameterTemplateFilterInput!
|
The filter parameters to search for. Default = {} |
Example
Query
query Core_findUrlParameterTemplates(
$paging: UrlParameterTemplatePagingInput!,
$filter: UrlParameterTemplateFilterInput!
) {
core_findUrlParameterTemplates(
paging: $paging,
filter: $filter
) {
totalCount
entries {
id
version
mcs {
...McsFragment
}
name
template
}
}
}
Variables
{
"paging": {
"pagingInput": {"limit": 100, "offset": 0},
"sortInput": {"sortOrder": "ASC", "sortType": "INFO"}
},
"filter": {}
}
Response
{
"data": {
"core_findUrlParameterTemplates": {
"totalCount": 987,
"entries": [UrlParameterTemplateEntity]
}
}
}
core_findUserInformation
Description
Get all relevant information for the current user
Response
Returns a QueryUserInformationPayload!
Example
Query
query Core_findUserInformation {
core_findUserInformation {
information {
id
version
name
email
settings {
...UserSettingsFragment
}
userRoles {
...UserRoleEntityFragment
}
isSystemUser
}
}
}
Response
{
"data": {
"core_findUserInformation": {
"information": UserInformation
}
}
}
core_getAdditionalHtmlStyles
Description
get HtmlEditorStyles for the current Mcs
Response
Returns an AdditionalHtmlStylesGetPayload!
Example
Query
query Core_getAdditionalHtmlStyles {
core_getAdditionalHtmlStyles {
additionalStyles
}
}
Response
{
"data": {
"core_getAdditionalHtmlStyles": {
"additionalStyles": "abc123"
}
}
}
core_searchArticle
Description
Search articles with filter options. The resulting entries are sorted by the search engine.
Response
Returns an ArticleSearchPayload!
Arguments
| Name | Description |
|---|---|
filter - SearchArticleFilterInput!
|
Filter information. |
paging - Paging!
|
Paging information. |
Example
Query
query Core_searchArticle(
$filter: SearchArticleFilterInput!,
$paging: Paging!
) {
core_searchArticle(
filter: $filter,
paging: $paging
) {
totalCount
entries {
articles {
...ArticleFragment
}
}
}
}
Variables
{
"filter": SearchArticleFilterInput,
"paging": Paging
}
Response
{
"data": {
"core_searchArticle": {
"totalCount": 123,
"entries": [ArticleSearchEntry]
}
}
}
core_searchArticles
Description
!!! DEPRECATED: Use core_searchArticle instead. Search through all articles with a search string
Response
Returns an ArticlesResultItem!
Arguments
| Name | Description |
|---|---|
input - ArticleSearchInput!
|
The input containing the relevant search terms |
Example
Query
query Core_searchArticles($input: ArticleSearchInput!) {
core_searchArticles(input: $input) {
total
items {
... on Item {
...ItemFragment
}
... on UnknownItem {
...UnknownItemFragment
}
}
}
}
Variables
{"input": ArticleSearchInput}
Response
{
"data": {
"core_searchArticles": {"total": 987, "items": [Item]}
}
}
core_searchCategoryTree
Description
Returns the root of the category tree given a search term input
Response
Returns a BackofficeCategory
Arguments
| Name | Description |
|---|---|
searchTerm - String!
|
The filtering search term. |
Example
Query
query Core_searchCategoryTree($searchTerm: String!) {
core_searchCategoryTree(searchTerm: $searchTerm) {
id
version
simpleId
name
nameWithLocale
primaryId
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
ranking
path
url
valid
smart
parents {
id
version
simpleId
name
nameWithLocale
primaryId
mcs {
...McsFragment
}
ranking
path
url
valid
smart
parents {
...BackofficeCategoryFragment
}
online
childrenCount
childCategories {
...BackofficeCategoryFragment
}
status
}
online
childrenCount
childCategories {
id
version
simpleId
name
nameWithLocale
primaryId
mcs {
...McsFragment
}
ranking
path
url
valid
smart
parents {
...BackofficeCategoryFragment
}
online
childrenCount
childCategories {
...BackofficeCategoryFragment
}
status
}
status
}
}
Variables
{"searchTerm": "xyz789"}
Response
{
"data": {
"core_searchCategoryTree": {
"id": 4,
"version": {},
"simpleId": "xyz789",
"name": "xyz789",
"nameWithLocale": "abc123",
"primaryId": "xyz789",
"mcs": Mcs,
"ranking": 123,
"path": "xyz789",
"url": "xyz789",
"valid": false,
"smart": true,
"parents": [BackofficeCategory],
"online": false,
"childrenCount": 987,
"childCategories": [BackofficeCategory],
"status": "INVALID"
}
}
}
core_smartProductCinemaPreview
Response
Returns a SmartProductCinemaPreviewPayload!
Arguments
| Name | Description |
|---|---|
input - SmartProductCinemaPreviewInput!
|
Example
Query
query Core_smartProductCinemaPreview($input: SmartProductCinemaPreviewInput!) {
core_smartProductCinemaPreview(input: $input) {
entries {
product {
...ProductFragment
}
items {
...Item_2Fragment
}
}
totalCount
}
}
Variables
{"input": SmartProductCinemaPreviewInput}
Response
{
"data": {
"core_smartProductCinemaPreview": {
"entries": [SearchResultEntry],
"totalCount": 123
}
}
}
core_userRights
Description
Get all rights for the current user and the selected MCS
Response
Returns a QueryUserRightsPayload!
Example
Query
query Core_userRights {
core_userRights {
allowedMenuEntries
allowedMcss {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
allowedMcsUserRights {
id
version
name
privileges
rightType
parentId
rightGroup {
...RightGroupEntityFragment
}
parent
}
}
}
Response
{
"data": {
"core_userRights": {
"allowedMenuEntries": ["Marketing"],
"allowedMcss": [Mcs],
"allowedMcsUserRights": [RightEntity]
}
}
}
dashboard_find404ErrorCount
Description
Find count of 404 error pages
Response
Returns a WidgetKpiData!
Arguments
| Name | Description |
|---|---|
input - DashboardFilterInput!
|
The filter object containing all needed restrictions |
Example
Query
query Dashboard_find404ErrorCount($input: DashboardFilterInput!) {
dashboard_find404ErrorCount(input: $input) {
label
totalCount
unit
values {
value
}
}
}
Variables
{"input": DashboardFilterInput}
Response
{
"data": {
"dashboard_find404ErrorCount": {
"label": "xyz789",
"totalCount": 123.45,
"unit": "xyz789",
"values": [KpiValue]
}
}
}
dashboard_findConversionRate
Description
Find line graph of conversion rate
Response
Returns a WidgetKpiData!
Arguments
| Name | Description |
|---|---|
input - DashboardFilterInput!
|
The filter object containing all needed restrictions |
Example
Query
query Dashboard_findConversionRate($input: DashboardFilterInput!) {
dashboard_findConversionRate(input: $input) {
label
totalCount
unit
values {
value
}
}
}
Variables
{"input": DashboardFilterInput}
Response
{
"data": {
"dashboard_findConversionRate": {
"label": "abc123",
"totalCount": 987.65,
"unit": "abc123",
"values": [KpiValue]
}
}
}
dashboard_findKpi
Description
Find line graph of specific requested metric
Response
Returns a WidgetKpiData!
Arguments
| Name | Description |
|---|---|
input - DashboardFilterInput!
|
The filter object containing all needed restrictions |
Example
Query
query Dashboard_findKpi($input: DashboardFilterInput!) {
dashboard_findKpi(input: $input) {
label
totalCount
unit
values {
value
}
}
}
Variables
{"input": DashboardFilterInput}
Response
{
"data": {
"dashboard_findKpi": {
"label": "abc123",
"totalCount": 987.65,
"unit": "xyz789",
"values": [KpiValue]
}
}
}
dashboard_findValidCategories
Description
Find pie chart of valid/invalid categories
Response
Returns a WidgetKpiData!
Arguments
| Name | Description |
|---|---|
input - DashboardFilterInput!
|
The filter object containing all needed restrictions |
Example
Query
query Dashboard_findValidCategories($input: DashboardFilterInput!) {
dashboard_findValidCategories(input: $input) {
label
totalCount
unit
values {
value
}
}
}
Variables
{"input": DashboardFilterInput}
Response
{
"data": {
"dashboard_findValidCategories": {
"label": "abc123",
"totalCount": 123.45,
"unit": "xyz789",
"values": [KpiValue]
}
}
}
dashboard_findValidProducts
Description
Find pie chart of valid/invalid products
Response
Returns a WidgetKpiData!
Arguments
| Name | Description |
|---|---|
input - DashboardFilterInput!
|
The filter object containing all needed restrictions |
Example
Query
query Dashboard_findValidProducts($input: DashboardFilterInput!) {
dashboard_findValidProducts(input: $input) {
label
totalCount
unit
values {
value
}
}
}
Variables
{"input": DashboardFilterInput}
Response
{
"data": {
"dashboard_findValidProducts": {
"label": "xyz789",
"totalCount": 123.45,
"unit": "xyz789",
"values": [KpiValue]
}
}
}
dashboard_findValidSkus
Description
Find pie chart of valid/invalid skus
Response
Returns a WidgetKpiData!
Arguments
| Name | Description |
|---|---|
input - DashboardFilterInput!
|
The filter object containing all needed restrictions |
Example
Query
query Dashboard_findValidSkus($input: DashboardFilterInput!) {
dashboard_findValidSkus(input: $input) {
label
totalCount
unit
values {
value
}
}
}
Variables
{"input": DashboardFilterInput}
Response
{
"data": {
"dashboard_findValidSkus": {
"label": "abc123",
"totalCount": 123.45,
"unit": "abc123",
"values": [KpiValue]
}
}
}
dataExport_findArticleIgnoreLists
Description
Finds all article ignore lists
Response
Returns an ArticleIgnoreListsFindPayload!
Arguments
| Name | Description |
|---|---|
filter - ArticleIgnoreListsFilterInput!
|
The filter parameters to search for. Default = {} |
paging - ArticleIgnoreListPagingInput!
|
Paging and sorting parameters to use. Default = {pagingInput: {limit: 100, offset: 0}, sortInput: {sortOrder: ASC, sortColumn: NAME}} |
Example
Query
query DataExport_findArticleIgnoreLists(
$filter: ArticleIgnoreListsFilterInput!,
$paging: ArticleIgnoreListPagingInput!
) {
dataExport_findArticleIgnoreLists(
filter: $filter,
paging: $paging
) {
entries {
id
version
mcs {
...McsFragment
}
name
granularity
articles {
...ArticleFragment
}
}
totalCount
}
}
Variables
{
"filter": {},
"paging": {
"pagingInput": {"limit": 100, "offset": 0},
"sortInput": {"sortOrder": "ASC", "sortColumn": "NAME"}
}
}
Response
{
"data": {
"dataExport_findArticleIgnoreLists": {
"entries": [DataExportArticleIgnoreList],
"totalCount": 987
}
}
}
dataExport_findBaseUrl
Description
Get data export base URL
Response
Returns a BaseUrlPayload!
Example
Query
query DataExport_findBaseUrl {
dataExport_findBaseUrl {
baseUrl
}
}
Response
{
"data": {
"dataExport_findBaseUrl": {
"baseUrl": "abc123"
}
}
}
dataExport_findCategoryIgnoreLists
Description
Finds all category ignore lists
Response
Returns a CategoryIgnoreListsFindPayload!
Arguments
| Name | Description |
|---|---|
filter - CategoryIgnoreListsFilterInput!
|
The filter parameters to search for. Default = {} |
paging - CategoryIgnoreListPagingInput!
|
Paging and sorting parameters to use. Default = {pagingInput: {limit: 100, offset: 0}, sortInput: {sortOrder: ASC, sortColumn: NAME}} |
Example
Query
query DataExport_findCategoryIgnoreLists(
$filter: CategoryIgnoreListsFilterInput!,
$paging: CategoryIgnoreListPagingInput!
) {
dataExport_findCategoryIgnoreLists(
filter: $filter,
paging: $paging
) {
entries {
id
version
mcs {
...McsFragment
}
name
exportCategories {
...LinkToCategoryTreeEntryFragment
}
}
totalCount
}
}
Variables
{
"filter": {},
"paging": {
"pagingInput": {"limit": 100, "offset": 0},
"sortInput": {"sortOrder": "ASC", "sortColumn": "NAME"}
}
}
Response
{
"data": {
"dataExport_findCategoryIgnoreLists": {
"entries": [DataExportCategoryIgnoreList],
"totalCount": 987
}
}
}
dataExport_findDataExports
Description
Finds all data exports in a certain complete MCS
Response
Returns a DataExportFindPayload!
Arguments
| Name | Description |
|---|---|
filter - DataExportsFilterInput!
|
The filter parameters to search for. Default = {} |
paging - DataExportsPagingInput!
|
Paging and sorting parameters to use. Default = {pagingInput: {limit: 100, offset: 0}, sortInput: {sortOrder: ASC, sortColumn: NAME}} |
Example
Query
query DataExport_findDataExports(
$filter: DataExportsFilterInput!,
$paging: DataExportsPagingInput!
) {
dataExport_findDataExports(
filter: $filter,
paging: $paging
) {
entries {
id
version
name
mcs {
...McsFragment
}
email
lastExecutionDate
nextExecutionDate
granularity
status
compressionType
exportType {
... on HttpType {
...HttpTypeFragment
}
... on FtpType {
...FtpTypeFragment
}
}
articlesIgnoreList {
...DataExportArticleIgnoreListFragment
}
categoriesIgnoreList {
...DataExportCategoryIgnoreListFragment
}
exportFormat {
...DataExportFormatFragment
}
conditions {
...ComplexConditionFragment
}
replacementList {
...DataExportReplacementListFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
totalCount
}
}
Variables
{
"filter": {},
"paging": {
"pagingInput": {"limit": 100, "offset": 0},
"sortInput": {"sortOrder": "ASC", "sortColumn": "NAME"}
}
}
Response
{
"data": {
"dataExport_findDataExports": {
"entries": [DataExportEntity],
"totalCount": 987
}
}
}
dataExport_findFormatList
Description
Finds all format lists
Response
Returns a FormatListsFindPayload!
Arguments
| Name | Description |
|---|---|
filter - FormatListsFilterInput!
|
The filter parameters to search for. Default = {} |
paging - FormatListPagingInput!
|
Paging and sorting parameters to use. Default = {pagingInput: {limit: 100, offset: 0}, sortInput: {sortOrder: ASC, sortColumn: NAME}} |
Example
Query
query DataExport_findFormatList(
$filter: FormatListsFilterInput!,
$paging: FormatListPagingInput!
) {
dataExport_findFormatList(
filter: $filter,
paging: $paging
) {
entries {
id
version
mcs {
...McsFragment
}
name
templateFormat
readOnly
}
totalCount
}
}
Variables
{
"filter": {},
"paging": {
"pagingInput": {"limit": 100, "offset": 0},
"sortInput": {"sortOrder": "ASC", "sortColumn": "NAME"}
}
}
Response
{
"data": {
"dataExport_findFormatList": {
"entries": [DataExportFormat],
"totalCount": 987
}
}
}
dataExport_findReplacementList
Description
Finds all replacement lists
Response
Returns a ReplacementListFindPayload!
Arguments
| Name | Description |
|---|---|
filter - ReplacementListFilterInput!
|
The filter parameters to search for. Default = {} |
paging - ReplacementListPagingInput!
|
Paging and sorting parameters to use. Default = {pagingInput: {limit: 100, offset: 0}, sortInput: {sortOrder: ASC, sortColumn: NAME}} |
Example
Query
query DataExport_findReplacementList(
$filter: ReplacementListFilterInput!,
$paging: ReplacementListPagingInput!
) {
dataExport_findReplacementList(
filter: $filter,
paging: $paging
) {
entries {
id
version
mcs {
...McsFragment
}
name
values {
...DataExportReplacementFragment
}
}
totalCount
}
}
Variables
{
"filter": {},
"paging": {
"pagingInput": {"limit": 100, "offset": 0},
"sortInput": {"sortOrder": "ASC", "sortColumn": "NAME"}
}
}
Response
{
"data": {
"dataExport_findReplacementList": {
"entries": [DataExportReplacementList],
"totalCount": 987
}
}
}
dataExport_findSupportedFields
Response
Returns a FieldNamesFindPayload
Arguments
| Name | Description |
|---|---|
filter - FieldNamesFilterInput!
|
Default = {} |
paging - FieldNamesPagingInput!
|
Default = {paging: {limit: 100, offset: 0}} |
Example
Query
query DataExport_findSupportedFields(
$filter: FieldNamesFilterInput!,
$paging: FieldNamesPagingInput!
) {
dataExport_findSupportedFields(
filter: $filter,
paging: $paging
) {
entries
}
}
Variables
{"filter": {}, "paging": {"paging": {"limit": 100, "offset": 0}}}
Response
{
"data": {
"dataExport_findSupportedFields": {
"entries": ["abc123"]
}
}
}
dataExport_previewDataExport
Description
Preview data export
Response
Returns a DataExportPreviewPayload!
Arguments
| Name | Description |
|---|---|
input - DataExportPreviewInput!
|
Example
Query
query DataExport_previewDataExport($input: DataExportPreviewInput!) {
dataExport_previewDataExport(input: $input) {
fileContent
}
}
Variables
{"input": DataExportPreviewInput}
Response
{
"data": {
"dataExport_previewDataExport": {
"fileContent": "xyz789"
}
}
}
deprecated_core_findContentTreeRootNodes
Description
Filter only on root level.
Response
Returns a ContentTreeNodeFindPayload!
Arguments
| Name | Description |
|---|---|
paging - ContentTreeNodePagingInput!
|
Paging and sorting parameters to use. Default = {pagingInput: {limit: 100, offset: 0}, sortInput: {sortOrder: ASC, sortType: NAME}} |
filter - ContentTreeNodeFilterInput!
|
The filter parameters to search for. Default = {} |
Example
Query
query Deprecated_core_findContentTreeRootNodes(
$paging: ContentTreeNodePagingInput!,
$filter: ContentTreeNodeFilterInput!
) {
deprecated_core_findContentTreeRootNodes(
paging: $paging,
filter: $filter
) {
totalCount
entries {
id
version
name
mcs {
...McsFragment
}
parentNode
parentNodeNode {
...ContentTreeNodeFragment
}
hasChildren
children {
...ContentTreeNodeFragment
}
childrenCount
pageId
}
}
}
Variables
{
"paging": {
"pagingInput": {"limit": 100, "offset": 0},
"sortInput": {"sortOrder": "ASC", "sortType": "NAME"}
},
"filter": {}
}
Response
{
"data": {
"deprecated_core_findContentTreeRootNodes": {
"totalCount": 987,
"entries": [ContentTreeNode]
}
}
}
deprecated_core_searchContentTreeNodes
Description
Filter the complete tree.
Response
Returns a ContentTreeNodeFindPayload!
Arguments
| Name | Description |
|---|---|
paging - ContentTreeNodePagingInput!
|
Paging and sorting parameters to use. Default = {pagingInput: {limit: 100, offset: 0}, sortInput: {sortOrder: ASC, sortType: NAME}} |
filter - ContentTreeNodeFilterInput!
|
The filter parameters to search for. Default = {} |
Example
Query
query Deprecated_core_searchContentTreeNodes(
$paging: ContentTreeNodePagingInput!,
$filter: ContentTreeNodeFilterInput!
) {
deprecated_core_searchContentTreeNodes(
paging: $paging,
filter: $filter
) {
totalCount
entries {
id
version
name
mcs {
...McsFragment
}
parentNode
parentNodeNode {
...ContentTreeNodeFragment
}
hasChildren
children {
...ContentTreeNodeFragment
}
childrenCount
pageId
}
}
}
Variables
{
"paging": {
"pagingInput": {"limit": 100, "offset": 0},
"sortInput": {"sortOrder": "ASC", "sortType": "NAME"}
},
"filter": {}
}
Response
{
"data": {
"deprecated_core_searchContentTreeNodes": {
"totalCount": 123,
"entries": [ContentTreeNode]
}
}
}
deprecated_parameter_findGlobalParameterValues
Description
Filters global parameters by the given search input and returns the results and their values.
Response
Returns a GlobalParameter!
Arguments
| Name | Description |
|---|---|
searchParameterInput - GlobalParameterSearchInput!
|
The filter parameters to search for |
attributeDescriptionName - String!
|
The attribute description name to filter by |
Example
Query
query Deprecated_parameter_findGlobalParameterValues(
$searchParameterInput: GlobalParameterSearchInput!,
$attributeDescriptionName: String!
) {
deprecated_parameter_findGlobalParameterValues(
searchParameterInput: $searchParameterInput,
attributeDescriptionName: $attributeDescriptionName
) {
id
version
name
parameters {
entries {
...GlobalParameterAttributeFragment
}
totalCount
}
allowedValues {
valueKey
displayNames {
...MapTypeFragment
}
}
options {
id
version
value
displayNames {
...MapTypeFragment
}
}
}
}
Variables
{
"searchParameterInput": GlobalParameterSearchInput,
"attributeDescriptionName": "abc123"
}
Response
{
"data": {
"deprecated_parameter_findGlobalParameterValues": {
"id": 4,
"version": {},
"name": "abc123",
"parameters": GlobalParameterAttributes,
"allowedValues": [AllowedValue],
"options": [AttributeOption]
}
}
}
deprecated_search_findAdaptiveSearchActivation
Description
Returns the global parameter describing if adaptive search is activated.
Response
Returns a GlobalParameter!
Arguments
| Name | Description |
|---|---|
searchParameterInput - GlobalParameterSearchInput!
|
Additional filter parameters, containing at least the MCS |
Example
Query
query Deprecated_search_findAdaptiveSearchActivation($searchParameterInput: GlobalParameterSearchInput!) {
deprecated_search_findAdaptiveSearchActivation(searchParameterInput: $searchParameterInput) {
id
version
name
parameters {
entries {
...GlobalParameterAttributeFragment
}
totalCount
}
allowedValues {
valueKey
displayNames {
...MapTypeFragment
}
}
options {
id
version
value
displayNames {
...MapTypeFragment
}
}
}
}
Variables
{"searchParameterInput": GlobalParameterSearchInput}
Response
{
"data": {
"deprecated_search_findAdaptiveSearchActivation": {
"id": "4",
"version": {},
"name": "abc123",
"parameters": GlobalParameterAttributes,
"allowedValues": [AllowedValue],
"options": [AttributeOption]
}
}
}
deprecated_search_findAdaptiveSearchKpi
Description
Returns global parameters describing KPIs for the adaptive search.
Response
Returns a GlobalParameter!
Arguments
| Name | Description |
|---|---|
searchParameterInput - GlobalParameterSearchInput!
|
Additional filter parameters, containing at least the MCS |
Example
Query
query Deprecated_search_findAdaptiveSearchKpi($searchParameterInput: GlobalParameterSearchInput!) {
deprecated_search_findAdaptiveSearchKpi(searchParameterInput: $searchParameterInput) {
id
version
name
parameters {
entries {
...GlobalParameterAttributeFragment
}
totalCount
}
allowedValues {
valueKey
displayNames {
...MapTypeFragment
}
}
options {
id
version
value
displayNames {
...MapTypeFragment
}
}
}
}
Variables
{"searchParameterInput": GlobalParameterSearchInput}
Response
{
"data": {
"deprecated_search_findAdaptiveSearchKpi": {
"id": "4",
"version": {},
"name": "xyz789",
"parameters": GlobalParameterAttributes,
"allowedValues": [AllowedValue],
"options": [AttributeOption]
}
}
}
deprecated_search_findAdaptiveSearchRatio
Description
Returns the global parameter describing the adaptive search ratio.
Response
Returns a GlobalParameter!
Arguments
| Name | Description |
|---|---|
searchParameterInput - GlobalParameterSearchInput!
|
Additional filter parameters, containing at least the MCS |
Example
Query
query Deprecated_search_findAdaptiveSearchRatio($searchParameterInput: GlobalParameterSearchInput!) {
deprecated_search_findAdaptiveSearchRatio(searchParameterInput: $searchParameterInput) {
id
version
name
parameters {
entries {
...GlobalParameterAttributeFragment
}
totalCount
}
allowedValues {
valueKey
displayNames {
...MapTypeFragment
}
}
options {
id
version
value
displayNames {
...MapTypeFragment
}
}
}
}
Variables
{"searchParameterInput": GlobalParameterSearchInput}
Response
{
"data": {
"deprecated_search_findAdaptiveSearchRatio": {
"id": 4,
"version": {},
"name": "xyz789",
"parameters": GlobalParameterAttributes,
"allowedValues": [AllowedValue],
"options": [AttributeOption]
}
}
}
deprecated_search_findSearchSuggestBlacklist
Description
Find search suggest blacklist values.
Response
Returns a GlobalParameter!
Arguments
| Name | Description |
|---|---|
searchParameterInput - GlobalParameterSearchInput!
|
Description of of a global parameter to find the correct blacklist values. |
Example
Query
query Deprecated_search_findSearchSuggestBlacklist($searchParameterInput: GlobalParameterSearchInput!) {
deprecated_search_findSearchSuggestBlacklist(searchParameterInput: $searchParameterInput) {
id
version
name
parameters {
entries {
...GlobalParameterAttributeFragment
}
totalCount
}
allowedValues {
valueKey
displayNames {
...MapTypeFragment
}
}
options {
id
version
value
displayNames {
...MapTypeFragment
}
}
}
}
Variables
{"searchParameterInput": GlobalParameterSearchInput}
Response
{
"data": {
"deprecated_search_findSearchSuggestBlacklist": {
"id": "4",
"version": {},
"name": "abc123",
"parameters": GlobalParameterAttributes,
"allowedValues": [AllowedValue],
"options": [AttributeOption]
}
}
}
deprecated_search_findSearchSuggestWhitelist
Description
Find search suggest whitelist values.
Response
Returns a GlobalParameter!
Arguments
| Name | Description |
|---|---|
searchParameterInput - GlobalParameterSearchInput!
|
Description of of a global parameter to find the correct whitelist values. |
Example
Query
query Deprecated_search_findSearchSuggestWhitelist($searchParameterInput: GlobalParameterSearchInput!) {
deprecated_search_findSearchSuggestWhitelist(searchParameterInput: $searchParameterInput) {
id
version
name
parameters {
entries {
...GlobalParameterAttributeFragment
}
totalCount
}
allowedValues {
valueKey
displayNames {
...MapTypeFragment
}
}
options {
id
version
value
displayNames {
...MapTypeFragment
}
}
}
}
Variables
{"searchParameterInput": GlobalParameterSearchInput}
Response
{
"data": {
"deprecated_search_findSearchSuggestWhitelist": {
"id": 4,
"version": {},
"name": "abc123",
"parameters": GlobalParameterAttributes,
"allowedValues": [AllowedValue],
"options": [AttributeOption]
}
}
}
filters_findFilters
Description
Finds all filters in a certain MCS.
Response
Returns a FilterFindPayload!
Arguments
| Name | Description |
|---|---|
paging - FiltersPagingInput!
|
Default = {pagingInput: {limit: 100, offset: 0}, sortInput: {sortOrder: ASC, sortColumn: DISPLAY_NAME}} |
filter - FiltersFilterInput!
|
The filter parameters to search for. Default = {} |
Example
Query
query Filters_findFilters(
$paging: FiltersPagingInput!,
$filter: FiltersFilterInput!
) {
filters_findFilters(
paging: $paging,
filter: $filter
) {
entries {
id
displayName
}
totalCount
}
}
Variables
{
"paging": {
"pagingInput": {"limit": 100, "offset": 0},
"sortInput": {"sortOrder": "ASC", "sortColumn": "DISPLAY_NAME"}
},
"filter": {}
}
Response
{
"data": {
"filters_findFilters": {
"entries": [SmartFilter],
"totalCount": 123
}
}
}
marketing_articleListScorePreview
Response
Returns an ArticleListScorePreviewPayload!
Arguments
| Name | Description |
|---|---|
input - ArticleListScorePreviewInput!
|
|
paging - Paging!
|
Default = {limit: 100, offset: 0} |
Example
Query
query Marketing_articleListScorePreview(
$input: ArticleListScorePreviewInput!,
$paging: Paging!
) {
marketing_articleListScorePreview(
input: $input,
paging: $paging
) {
entries {
product {
...ProductFragment
}
items {
...Item_2Fragment
}
articleScore
}
totalCount
}
}
Variables
{
"input": ArticleListScorePreviewInput,
"paging": {"limit": 100, "offset": 0}
}
Response
{
"data": {
"marketing_articleListScorePreview": {
"entries": [ScoredPreviewEntry],
"totalCount": 123
}
}
}
marketing_findArticleListScore
Description
Find all articleScores in a single MCS.
Response
Returns an ArticleListScoreFindPayload!
Arguments
| Name | Description |
|---|---|
filter - ArticleListScoreFilterInput!
|
Default = {ids: [], hideStandard: false} |
paging - ArticleListScorePagingInput!
|
Default = {paging: {limit: 100, offset: 0}, sorting: {sortOrder: ASC, sortType: INFO}} |
Example
Query
query Marketing_findArticleListScore(
$filter: ArticleListScoreFilterInput!,
$paging: ArticleListScorePagingInput!
) {
marketing_findArticleListScore(
filter: $filter,
paging: $paging
) {
totalCount
entries {
id
version
mcs {
...McsFragment
}
name
isInherited
articleListScoreCards {
... on ArticleListScoreCardDirectValue {
...ArticleListScoreCardDirectValueFragment
}
... on ArticleListScoreCardBoolean {
...ArticleListScoreCardBooleanFragment
}
... on ArticleListScoreCardCategory {
...ArticleListScoreCardCategoryFragment
}
... on ArticleListScoreCardBrand {
...ArticleListScoreCardBrandFragment
}
... on ArticleListScoreCardDouble {
...ArticleListScoreCardDoubleFragment
}
... on ArticleListScoreCardInt {
...ArticleListScoreCardIntFragment
}
... on ArticleListScoreCardString {
...ArticleListScoreCardStringFragment
}
}
references {
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on LegacyContentReference {
...LegacyContentReferenceFragment
}
}
}
}
}
Variables
{
"filter": {"ids": [""], "hideStandard": "false"},
"paging": {
"paging": {"limit": 100, "offset": 0},
"sorting": {"sortOrder": "ASC", "sortType": "INFO"}
}
}
Response
{
"data": {
"marketing_findArticleListScore": {
"totalCount": 987,
"entries": [ArticleListScore]
}
}
}
metadata_findArticleListScoreCardAttributes
Description
retrieve a list of all article list score types that can be used in Score cards
Response
Returns an ArticleListScoreCardAttributeFindPayload!
Arguments
| Name | Description |
|---|---|
paging - Paging!
|
Default = {limit: 100, offset: 0} |
sorting - ArticleListScoreCardAttributeSortingInput!
|
Default = {sortOrder: ASC, sortType: INFO} |
Example
Query
query Metadata_findArticleListScoreCardAttributes(
$paging: Paging!,
$sorting: ArticleListScoreCardAttributeSortingInput!
) {
metadata_findArticleListScoreCardAttributes(
paging: $paging,
sorting: $sorting
) {
entries {
id
version
mcs {
...McsFragment
}
level
dataType
displayName
dataSource
}
totalCount
}
}
Variables
{
"paging": {"limit": 100, "offset": 0},
"sorting": {"sortOrder": "ASC", "sortType": "INFO"}
}
Response
{
"data": {
"metadata_findArticleListScoreCardAttributes": {
"entries": [ArticleListScoreCardAttribute],
"totalCount": 123
}
}
}
metadata_findBrandParameterTypes
Response
Returns an AttributeTypeFindPayload!
Arguments
| Name | Description |
|---|---|
filter - AttributeTypeFilterInput!
|
Default = {} |
Example
Query
query Metadata_findBrandParameterTypes($filter: AttributeTypeFilterInput!) {
metadata_findBrandParameterTypes(filter: $filter) {
entries {
id
version
key
displayName
group {
...AttributeDefinitionGroupFragment
}
abTestable
customerSegmentsAllowed
exportable
linkable
standard
mandatory
helpText
hasHelpText
mutationCommandType
allowedValues {
...AllowedValueFragment
}
searchable
valueType
}
totalCount
}
}
Variables
{"filter": {}}
Response
{
"data": {
"metadata_findBrandParameterTypes": {
"entries": [AttributeDescriptionType],
"totalCount": 987
}
}
}
metadata_findCategoryParameterTypes
Response
Returns an AttributeTypeFindPayload!
Arguments
| Name | Description |
|---|---|
filter - AttributeTypeFilterInput!
|
Default = {} |
Example
Query
query Metadata_findCategoryParameterTypes($filter: AttributeTypeFilterInput!) {
metadata_findCategoryParameterTypes(filter: $filter) {
entries {
id
version
key
displayName
group {
...AttributeDefinitionGroupFragment
}
abTestable
customerSegmentsAllowed
exportable
linkable
standard
mandatory
helpText
hasHelpText
mutationCommandType
allowedValues {
...AllowedValueFragment
}
searchable
valueType
}
totalCount
}
}
Variables
{"filter": {}}
Response
{
"data": {
"metadata_findCategoryParameterTypes": {
"entries": [AttributeDescriptionType],
"totalCount": 987
}
}
}
metadata_findContentTypes
Response
Returns a ContentTypeFindPayload!
Arguments
| Name | Description |
|---|---|
filter - ContentTypeFilterInput!
|
Default = {} |
Example
Query
query Metadata_findContentTypes($filter: ContentTypeFilterInput!) {
metadata_findContentTypes(filter: $filter) {
entries {
id
version
name
icon
teaserTemplates {
...TeaserTemplateFragment
}
attributes {
...AttributeDescriptionTypeFragment
}
}
totalCount
}
}
Variables
{"filter": {}}
Response
{
"data": {
"metadata_findContentTypes": {
"entries": [ContentType],
"totalCount": 987
}
}
}
metadata_findGlobalParameterTypes
Response
Returns an AttributeTypeFindPayload!
Arguments
| Name | Description |
|---|---|
filter - AttributeTypeFilterInput!
|
Default = {} |
Example
Query
query Metadata_findGlobalParameterTypes($filter: AttributeTypeFilterInput!) {
metadata_findGlobalParameterTypes(filter: $filter) {
entries {
id
version
key
displayName
group {
...AttributeDefinitionGroupFragment
}
abTestable
customerSegmentsAllowed
exportable
linkable
standard
mandatory
helpText
hasHelpText
mutationCommandType
allowedValues {
...AllowedValueFragment
}
searchable
valueType
}
totalCount
}
}
Variables
{"filter": {}}
Response
{
"data": {
"metadata_findGlobalParameterTypes": {
"entries": [AttributeDescriptionType],
"totalCount": 987
}
}
}
metadata_findPageParameterTypes
Response
Returns an AttributeTypeFindPayload!
Arguments
| Name | Description |
|---|---|
filter - AttributeTypeFilterInput!
|
Default = {} |
Example
Query
query Metadata_findPageParameterTypes($filter: AttributeTypeFilterInput!) {
metadata_findPageParameterTypes(filter: $filter) {
entries {
id
version
key
displayName
group {
...AttributeDefinitionGroupFragment
}
abTestable
customerSegmentsAllowed
exportable
linkable
standard
mandatory
helpText
hasHelpText
mutationCommandType
allowedValues {
...AllowedValueFragment
}
searchable
valueType
}
totalCount
}
}
Variables
{"filter": {}}
Response
{
"data": {
"metadata_findPageParameterTypes": {
"entries": [AttributeDescriptionType],
"totalCount": 123
}
}
}
metadata_findRasterParameterTypes
Response
Returns an AttributeTypeFindPayload!
Arguments
| Name | Description |
|---|---|
filter - AttributeTypeFilterInput!
|
Default = {} |
Example
Query
query Metadata_findRasterParameterTypes($filter: AttributeTypeFilterInput!) {
metadata_findRasterParameterTypes(filter: $filter) {
entries {
id
version
key
displayName
group {
...AttributeDefinitionGroupFragment
}
abTestable
customerSegmentsAllowed
exportable
linkable
standard
mandatory
helpText
hasHelpText
mutationCommandType
allowedValues {
...AllowedValueFragment
}
searchable
valueType
}
totalCount
}
}
Variables
{"filter": {}}
Response
{
"data": {
"metadata_findRasterParameterTypes": {
"entries": [AttributeDescriptionType],
"totalCount": 123
}
}
}
osb_findBySimpleId
Description
Finds all iShopObjects by its simple ID.]
Response
Returns a FindBySimpleIdPayload!
Arguments
| Name | Description |
|---|---|
filter - FindBySimpleIdFilterInput!
|
Example
Query
query Osb_findBySimpleId($filter: FindBySimpleIdFilterInput!) {
osb_findBySimpleId(filter: $filter) {
osbIShopObjects {
... on OsbCategory {
...OsbCategoryFragment
}
... on OsbProduct {
...OsbProductFragment
}
... on OsbItem {
...OsbItemFragment
}
}
}
}
Variables
{"filter": FindBySimpleIdFilterInput}
Response
{
"data": {
"osb_findBySimpleId": {
"osbIShopObjects": [OsbCategory]
}
}
}
osb_findByType
Description
Find all iShopObjects by its type. Sorted by simple ID.
Response
Returns a FindByTypePayload!
Arguments
| Name | Description |
|---|---|
filter - FindByTypeFilterInput!
|
|
paging - Paging!
|
Default = {limit: 100, offset: 0} |
Example
Query
query Osb_findByType(
$filter: FindByTypeFilterInput!,
$paging: Paging!
) {
osb_findByType(
filter: $filter,
paging: $paging
) {
totalCount
osbIShopObjects {
... on OsbCategory {
...OsbCategoryFragment
}
... on OsbProduct {
...OsbProductFragment
}
... on OsbItem {
...OsbItemFragment
}
}
}
}
Variables
{
"filter": FindByTypeFilterInput,
"paging": {"limit": 100, "offset": 0}
}
Response
{
"data": {
"osb_findByType": {
"totalCount": 123,
"osbIShopObjects": [OsbCategory]
}
}
}
osb_findInAttribute
Description
Find all iShopObjects in the ObjectStorage with a given attribute definition. Sorted by simple Id.
Response
Returns a FindInAttributePayload!
Arguments
| Name | Description |
|---|---|
filter - FindInAttributeFilterInput!
|
|
paging - Paging!
|
Default = {limit: 100, offset: 0} |
Example
Query
query Osb_findInAttribute(
$filter: FindInAttributeFilterInput!,
$paging: Paging!
) {
osb_findInAttribute(
filter: $filter,
paging: $paging
) {
totalCount
osbIShopObjects {
... on OsbCategory {
...OsbCategoryFragment
}
... on OsbProduct {
...OsbProductFragment
}
... on OsbItem {
...OsbItemFragment
}
}
}
}
Variables
{
"filter": FindInAttributeFilterInput,
"paging": {"limit": 100, "offset": 0}
}
Response
{
"data": {
"osb_findInAttribute": {
"totalCount": 123,
"osbIShopObjects": [OsbCategory]
}
}
}
osb_findInIndex
Description
Find in index with given parameters. Sorted by simple ID of product.
Response
Returns a FindInIndexPayload!
Arguments
| Name | Description |
|---|---|
filter - FindInIndexFilterInput!
|
|
paging - Paging!
|
Default = {limit: 100, offset: 0} |
Example
Query
query Osb_findInIndex(
$filter: FindInIndexFilterInput!,
$paging: Paging!
) {
osb_findInIndex(
filter: $filter,
paging: $paging
) {
totalCount
searchResults {
product {
...OsbProductFragment
}
items {
...OsbItemFragment
}
}
}
}
Variables
{
"filter": FindInIndexFilterInput,
"paging": {"limit": 100, "offset": 0}
}
Response
{
"data": {
"osb_findInIndex": {
"totalCount": 987,
"searchResults": [OsbSearchResult]
}
}
}
osb_findRootCategory
Description
Find root categories.
Response
Returns a FindRootCategoryPayload!
Arguments
| Name | Description |
|---|---|
filter - FindRootCategoryFilterInput!
|
Example
Query
query Osb_findRootCategory($filter: FindRootCategoryFilterInput!) {
osb_findRootCategory(filter: $filter) {
rootCategory {
simpleId
fullyQualifiedId
attributes {
...OsbAttributeFragment
}
ancestorCategories {
...OsbCategoryFragment
}
childCategories {
...OsbCategoryFragment
}
products {
...OsbProductOfCategoryPayloadFragment
}
}
}
}
Variables
{"filter": FindRootCategoryFilterInput}
Response
{
"data": {
"osb_findRootCategory": {
"rootCategory": [OsbCategory]
}
}
}
parameter_findBrandParameter
Description
Finds all brand parameters in a certain MCS
Response
Returns a BrandParameterFindPayload!
Arguments
| Name | Description |
|---|---|
paging - ParameterPagingInput!
|
The paging and sorting parameters to use. Default = {paging: {limit: 100, offset: 0}, sorting: {sortOrder: ASC, sortColumn: INFO}} |
filter - BrandParameterFilterInput!
|
The filter parameters to search for. Default = {} |
Example
Query
query Parameter_findBrandParameter(
$paging: ParameterPagingInput!,
$filter: BrandParameterFilterInput!
) {
parameter_findBrandParameter(
paging: $paging,
filter: $filter
) {
entries {
id
version
mcs {
...McsFragment
}
brand {
...BrandEntityFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
inherited
parameterType {
...AttributeDescriptionTypeFragment
}
attributeName
attributeValue {
...DynamicAttributeValueFragment
}
description
overwrites {
...BrandParameterFragment
}
}
totalCount
}
}
Variables
{
"paging": {
"paging": {"limit": 100, "offset": 0},
"sorting": {"sortOrder": "ASC", "sortColumn": "INFO"}
},
"filter": {}
}
Response
{
"data": {
"parameter_findBrandParameter": {
"entries": [BrandParameter],
"totalCount": 987
}
}
}
parameter_findCategoryParameter
Response
Returns a CategoryParameterFindPayload!
Arguments
| Name | Description |
|---|---|
filter - CategoryParameterFilterInput!
|
Default = {showLinkedParameter: true} |
paging - ParameterPagingInput!
|
Default = {paging: {limit: 100, offset: 0}, sorting: {sortOrder: ASC, sortColumn: INFO}} |
Example
Query
query Parameter_findCategoryParameter(
$filter: CategoryParameterFilterInput!,
$paging: ParameterPagingInput!
) {
parameter_findCategoryParameter(
filter: $filter,
paging: $paging
) {
entries {
id
version
category {
...GraphQlCategoryFragment
}
categoryTreeEntry {
...CategoryTreeEntryFragment
}
mcs {
...McsFragment
}
inherited
overwrites {
...CategoryParameterFragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeValue {
...DynamicAttributeValueFragment
}
linkedToCategories {
...CategoryParameterLinkTargetsFragment
}
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
totalCount
}
}
Variables
{
"filter": {"showLinkedParameter": "true"},
"paging": {
"paging": {"limit": 100, "offset": 0},
"sorting": {"sortOrder": "ASC", "sortColumn": "INFO"}
}
}
Response
{
"data": {
"parameter_findCategoryParameter": {
"entries": [CategoryParameter],
"totalCount": 987
}
}
}
parameter_findContentTreeParameter
Response
Returns a ContentTreeParameterFindPayload!
Arguments
| Name | Description |
|---|---|
filter - ContentTreeParameterFilterInput!
|
Default = {showLinkedParameter: true} |
paging - ParameterPagingInput!
|
Default = {paging: {limit: 100, offset: 0}, sorting: {sortOrder: ASC, sortColumn: INFO}} |
Example
Query
query Parameter_findContentTreeParameter(
$filter: ContentTreeParameterFilterInput!,
$paging: ParameterPagingInput!
) {
parameter_findContentTreeParameter(
filter: $filter,
paging: $paging
) {
entries {
id
version
contentPage {
...CuratedPageFragment
}
page {
...PageFragment
}
mcs {
...McsFragment
}
inherited
overwrites {
...PageParameterFragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeValue {
...DynamicAttributeValueFragment
}
linkTo {
...ContentParameterLinkTargetsFragment
}
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
pageType
}
totalCount
}
}
Variables
{
"filter": {"showLinkedParameter": "true"},
"paging": {
"paging": {"limit": 100, "offset": 0},
"sorting": {"sortOrder": "ASC", "sortColumn": "INFO"}
}
}
Response
{
"data": {
"parameter_findContentTreeParameter": {
"entries": [ContentTreeParameter],
"totalCount": 987
}
}
}
parameter_findGlobalParameter
Response
Returns a GlobalParameterFindPayload!
Arguments
| Name | Description |
|---|---|
filter - GlobalParameterFilterInput2!
|
Default = {} |
paging - ParameterPagingInput!
|
Default = {paging: {limit: 100, offset: 0}, sorting: {sortOrder: ASC, sortColumn: INFO}} |
Example
Query
query Parameter_findGlobalParameter(
$filter: GlobalParameterFilterInput2!,
$paging: ParameterPagingInput!
) {
parameter_findGlobalParameter(
filter: $filter,
paging: $paging
) {
entries {
id
version
mcs {
...McsFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
inherited
overwrites {
...GlobalParameter_2Fragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeName
attributeValue {
...DynamicAttributeValueFragment
}
description
}
totalCount
}
}
Variables
{
"filter": {},
"paging": {
"paging": {"limit": 100, "offset": 0},
"sorting": {"sortOrder": "ASC", "sortColumn": "INFO"}
}
}
Response
{
"data": {
"parameter_findGlobalParameter": {
"entries": [GlobalParameter_2],
"totalCount": 123
}
}
}
parameter_findPageParameter
Response
Returns a PageParameterFindPayload!
Arguments
| Name | Description |
|---|---|
filter - PageParameterFilterInput!
|
Default = {showLinkedParameter: true} |
paging - ParameterPagingInput!
|
Default = {paging: {limit: 100, offset: 0}, sorting: {sortOrder: ASC, sortColumn: INFO}} |
Example
Query
query Parameter_findPageParameter(
$filter: PageParameterFilterInput!,
$paging: ParameterPagingInput!
) {
parameter_findPageParameter(
filter: $filter,
paging: $paging
) {
entries {
id
version
page {
...PageFragment
}
mcs {
...McsFragment
}
inherited
overwrites {
...PageParameterFragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeValue {
...DynamicAttributeValueFragment
}
linkTo {
...PageParameterLinkTargetsFragment
}
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
pageType
}
totalCount
}
}
Variables
{
"filter": {"showLinkedParameter": "true"},
"paging": {
"paging": {"limit": 100, "offset": 0},
"sorting": {"sortOrder": "ASC", "sortColumn": "INFO"}
}
}
Response
{
"data": {
"parameter_findPageParameter": {
"entries": [PageParameter],
"totalCount": 987
}
}
}
personalization_findCustomerSegmentGroups
Description
Finds all customer segment groups in a certain MCS.
Response
Returns a CustomerSegmentGroupFindPayload
Arguments
| Name | Description |
|---|---|
paging - CustomerSegmentGroupPagingInput!
|
Paging and sorting parameters to use |
filter - CustomerSegmentGroupFilter!
|
The filter parameters to search for |
Example
Query
query Personalization_findCustomerSegmentGroups(
$paging: CustomerSegmentGroupPagingInput!,
$filter: CustomerSegmentGroupFilter!
) {
personalization_findCustomerSegmentGroups(
paging: $paging,
filter: $filter
) {
entries {
id
version
name
mcs {
...McsFragment
}
segments {
...CustomerSegmentFragment
}
priority
dynamic
}
totalCount
}
}
Variables
{
"paging": CustomerSegmentGroupPagingInput,
"filter": CustomerSegmentGroupFilter
}
Response
{
"data": {
"personalization_findCustomerSegmentGroups": {
"entries": [CustomerSegmentGroup],
"totalCount": 123
}
}
}
personalization_findCustomerSegments
Description
Finds all customer segments in a certain MCS.
Response
Returns a CustomerSegmentFindPayload!
Example
Query
query Personalization_findCustomerSegments {
personalization_findCustomerSegments {
entries {
id
version
name
mcs {
...McsFragment
}
description
deleted
type
dynamic
conditions {
...ComplexConditionFragment
}
group {
...CustomerSegmentGroupFragment
}
brokenInheritanceFrom
isStandardCustomerSegment
}
totalCount
}
}
Response
{
"data": {
"personalization_findCustomerSegments": {
"entries": [CustomerSegment],
"totalCount": 987
}
}
}
personalization_findMatchingTouchpoints
Description
Find Touchpoints with matching url/referrer to the input
Response
Returns [String!]!
Arguments
| Name | Description |
|---|---|
input - TouchPointTestingInput!
|
Testing parameters to find matching touchpoints |
Example
Query
query Personalization_findMatchingTouchpoints($input: TouchPointTestingInput!) {
personalization_findMatchingTouchpoints(input: $input)
}
Variables
{"input": TouchPointTestingInput}
Response
{
"data": {
"personalization_findMatchingTouchpoints": [
"abc123"
]
}
}
personalization_findStandardCustomerSegment
Response
Returns a CustomerSegment!
Example
Query
query Personalization_findStandardCustomerSegment {
personalization_findStandardCustomerSegment {
id
version
name
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
description
deleted
type
dynamic
conditions {
id
version
conditions {
... on ComplexCondition {
...ComplexConditionFragment
}
... on SimpleCondition {
...SimpleConditionFragment
}
}
operator
}
group {
id
version
name
mcs {
...McsFragment
}
segments {
...CustomerSegmentFragment
}
priority
dynamic
}
brokenInheritanceFrom
isStandardCustomerSegment
}
}
Response
{
"data": {
"personalization_findStandardCustomerSegment": {
"id": 4,
"version": {},
"name": "abc123",
"mcs": Mcs,
"description": "abc123",
"deleted": true,
"type": "BuiltIn",
"dynamic": false,
"conditions": ComplexCondition,
"group": CustomerSegmentGroup,
"brokenInheritanceFrom": {},
"isStandardCustomerSegment": true
}
}
}
personalization_findTouchPoints
Description
Finds all TouchPoints for a specific MCS.
Response
Returns a TouchPointPayload!
Arguments
| Name | Description |
|---|---|
paging - TouchPointPagingInput!
|
Paging and sorting parameters to use |
filter - TouchPointFilter!
|
The filter parameters to search for |
Example
Query
query Personalization_findTouchPoints(
$paging: TouchPointPagingInput!,
$filter: TouchPointFilter!
) {
personalization_findTouchPoints(
paging: $paging,
filter: $filter
) {
entries {
id
version
name
mcs {
...McsFragment
}
description
persisted
conditions {
...ComplexConditionFragment
}
deleted
brokenInheritanceFrom
}
totalCount
}
}
Variables
{
"paging": TouchPointPagingInput,
"filter": TouchPointFilter
}
Response
{
"data": {
"personalization_findTouchPoints": {
"entries": [TouchPoint],
"totalCount": 123
}
}
}
personalization_isCustomerSegmentLinked
Description
Check if customer segment is linked
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - CustomerSegmentInput
|
Example
Query
query Personalization_isCustomerSegmentLinked($input: CustomerSegmentInput) {
personalization_isCustomerSegmentLinked(input: $input)
}
Variables
{"input": CustomerSegmentInput}
Response
{"data": {"personalization_isCustomerSegmentLinked": false}}
promotions_findInformativeBenefitTypes
Description
Find all informative benefit types
Response
Returns an InformativeBenefitsFindPayload!
Arguments
| Name | Description |
|---|---|
paging - InformativeBenefitPagingInput!
|
Default = {pagingInput: {limit: 100, offset: 0}} |
filter - InformativeBenefitFilterInput!
|
The filter parameters to search for. Default = {} |
Example
Query
query Promotions_findInformativeBenefitTypes(
$paging: InformativeBenefitPagingInput!,
$filter: InformativeBenefitFilterInput!
) {
promotions_findInformativeBenefitTypes(
paging: $paging,
filter: $filter
) {
entries {
key
value
}
totalCount
}
}
Variables
{"paging": {"pagingInput": {"limit": 100, "offset": 0}}, "filter": {}}
Response
{
"data": {
"promotions_findInformativeBenefitTypes": {
"entries": [MapType],
"totalCount": 987
}
}
}
promotions_findPromotions
Description
Finds all promotions in a certain MCS.
Response
Returns a PromotionFindPayload!
Arguments
| Name | Description |
|---|---|
paging - PromotionsPagingInput!
|
Default = {pagingInput: {limit: 100, offset: 0}, sortInput: {sortOrder: DESC, sortColumn: INFO}} |
filter - PromotionsFilterInput!
|
The filter parameters to search for. Default = {currentUserOnly: false} |
Example
Query
query Promotions_findPromotions(
$paging: PromotionsPagingInput!,
$filter: PromotionsFilterInput!
) {
promotions_findPromotions(
paging: $paging,
filter: $filter
) {
entries {
id
version
name
mcs {
...McsFragment
}
description
status
type
brokenInheritanceFrom
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
timeValidity {
... on Campaign {
...CampaignFragment
}
... on DateRange {
...DateRangeFragment
}
}
activeStatus
activeForMCS {
...McsFragment
}
conditions {
...ComplexConditionFragment
}
benefits {
...BenefitEntityFragment
}
benefitsSummaries
metaData
}
totalCount
}
}
Variables
{
"paging": {
"pagingInput": {"limit": 100, "offset": 0},
"sortInput": {"sortOrder": "DESC", "sortColumn": "INFO"}
},
"filter": {"currentUserOnly": "false"}
}
Response
{
"data": {
"promotions_findPromotions": {
"entries": [PromotionEntity],
"totalCount": 123
}
}
}
reporting_findPerformanceBoosterValue
Description
Find if the search reporting booster option enabled in the shop settings
Response
Returns a Boolean!
Example
Query
query Reporting_findPerformanceBoosterValue {
reporting_findPerformanceBoosterValue
}
Response
{"data": {"reporting_findPerformanceBoosterValue": true}}
reporting_findSearchLogs
Description
Find all search logs for the provided mcs.
Response
Returns a SearchLogs!
Arguments
| Name | Description |
|---|---|
filter - SearchTermFilterInput!
|
All information needed to filter the search logs. |
Example
Query
query Reporting_findSearchLogs($filter: SearchTermFilterInput!) {
reporting_findSearchLogs(filter: $filter) {
searchLogs {
searchTerm
totalSearchQueries
averageHitRate
averageClickRate
averageConversionRate
searchIndexed
}
totalCount
}
}
Variables
{"filter": SearchTermFilterInput}
Response
{
"data": {
"reporting_findSearchLogs": {
"searchLogs": [SearchLog],
"totalCount": 123
}
}
}
right_findRights
Description
Filters the user rights
Response
Returns a RightFindPayload!
Arguments
| Name | Description |
|---|---|
filter - RightFilterInput!
|
Filter to select rights (by id and type). Default = {} |
paging - RightPagingInput!
|
Sort order, limit and offset of results Default: ascending by hierarchy, 100 (limit) and 0 (offset). Default = {paging: {limit: 100, offset: 0}, sortOn: {sortOrder: ASC, sortType: HIERARCHY}} |
Example
Query
query Right_findRights(
$filter: RightFilterInput!,
$paging: RightPagingInput!
) {
right_findRights(
filter: $filter,
paging: $paging
) {
entries {
id
version
name
privileges
rightType
parentId
rightGroup {
...RightGroupEntityFragment
}
parent
}
totalCount
}
}
Variables
{
"filter": {},
"paging": {
"paging": {"limit": 100, "offset": 0},
"sortOn": {"sortOrder": "ASC", "sortType": "HIERARCHY"}
}
}
Response
{
"data": {
"right_findRights": {
"entries": [RightEntity],
"totalCount": 987
}
}
}
role_findRoleMcss
Description
Filters available MultiChannelSelectors for roles with user rights
Response
Returns a RoleMcsFindPayload!
Arguments
| Name | Description |
|---|---|
filter - RoleMcsFilterInput!
|
Filter to select MultiChannelSelectors (by id, name and type). Default = {} |
paging - RoleMcsPagingInput!
|
Sort order, limit and offset of resulting MultiChannelSelector lists Default: ascending by hierarchy, 100 (limit) and 0 (offset). Default = {paging: {limit: 100, offset: 0}, sortOn: {sortOrder: ASC, sortType: HIERARCHY}} |
Example
Query
query Role_findRoleMcss(
$filter: RoleMcsFilterInput!,
$paging: RoleMcsPagingInput!
) {
role_findRoleMcss(
filter: $filter,
paging: $paging
) {
entries {
mcs {
...BoMcsFragment
}
privileges
}
totalCount
}
}
Variables
{
"filter": {},
"paging": {
"paging": {"limit": 100, "offset": 0},
"sortOn": {"sortOrder": "ASC", "sortType": "HIERARCHY"}
}
}
Response
{
"data": {
"role_findRoleMcss": {
"entries": [RoleMcs],
"totalCount": 987
}
}
}
role_findRoles
Description
Filters roles with user rights
Response
Returns a RoleFindPayload!
Arguments
| Name | Description |
|---|---|
filter - RoleFilterInput!
|
Filter to select roles (by id, name, right id and right type). Default = {} |
paging - RolePagingInput!
|
Sort order, limit and offset of results Default: ascending by name, 100 (limit) and 0 (offset). Default = {paging: {limit: 100, offset: 0}, sortInput: {sortOrder: ASC, sortColumn: NAME}} |
Example
Query
query Role_findRoles(
$filter: RoleFilterInput!,
$paging: RolePagingInput!
) {
role_findRoles(
filter: $filter,
paging: $paging
) {
entries {
id
version
name
roleRights {
...RoleRightEntityFragment
}
numberOfUsers
hasSpecialRightsOnly
description
isAdmin
}
totalCount
}
}
Variables
{
"filter": {},
"paging": {
"paging": {"limit": 100, "offset": 0},
"sortInput": {"sortOrder": "ASC", "sortColumn": "NAME"}
}
}
Response
{
"data": {
"role_findRoles": {
"entries": [RoleEntity],
"totalCount": 987
}
}
}
search_findAllSynonyms
Description
Finds all synonyms and antonyms.
Response
Returns a Synonyms!
Example
Query
query Search_findAllSynonyms {
search_findAllSynonyms {
elements {
id
version
inherited
mcs {
...McsFragment
}
synonymGroups {
...SynonymGroupFragment
}
}
totalCount
}
}
Response
{
"data": {
"search_findAllSynonyms": {
"elements": [Synonym],
"totalCount": 123
}
}
}
search_findBandwidth
Description
The bandwidth value for given MCS, checks MCS hierarchy for best value
Response
Returns a BandwidthInfo
Example
Query
query Search_findBandwidth {
search_findBandwidth {
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
bandwidthValue
fallbackValue {
mcs {
...McsFragment
}
bandwidthValue
fallbackValue {
...BandwidthInfoFragment
}
isInherited
}
isInherited
}
}
Response
{
"data": {
"search_findBandwidth": {
"mcs": Mcs,
"bandwidthValue": 987,
"fallbackValue": BandwidthInfo,
"isInherited": true
}
}
}
search_findDiagnosis
Description
Do a search and return a full explanation how the result was created.
Response
Returns a SearchDiagnosisResult!
Arguments
| Name | Description |
|---|---|
input - FindSearchDiagnosisInput!
|
Search options to create the search explanation. |
Example
Query
query Search_findDiagnosis($input: FindSearchDiagnosisInput!) {
search_findDiagnosis(input: $input) {
total
totalShop
speed
relevanceMetric {
min
max
average
}
heroCount
antiHeroCount
exclusionCount
redirectUrl
isCustomerSegmented
isABTested
items {
productId
articles {
...SearchDiagnosisArticleFragment
}
}
}
}
Variables
{"input": FindSearchDiagnosisInput}
Response
{
"data": {
"search_findDiagnosis": {
"total": 123,
"totalShop": 123,
"speed": {},
"relevanceMetric": RelevanceMetric,
"heroCount": 123,
"antiHeroCount": 987,
"exclusionCount": 123,
"redirectUrl": "abc123",
"isCustomerSegmented": true,
"isABTested": true,
"items": [SearchDiagnosisResultItem]
}
}
}
search_findExclusion
Description
Finds a search exclusion by it's ID Returns error if no exclusion with these parameters exist.
Response
Returns a SearchExclusion!
Example
Query
query Search_findExclusion(
$id: Long!,
$version: Long!
) {
search_findExclusion(
id: $id,
version: $version
) {
id
version
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
type
name
searchTerms
countArticles
articles {
articleIdentifier
totalNumberOfItems
items {
...Item_2Fragment
}
}
categories {
category {
...NavigationTreeEntryFragment
}
includeSubTree
mcs {
...McsFragment
}
}
categoryTreeEntries {
target {
...CategoryTreeEntryFragment
}
includeSubTree
}
inheritanceEnabled
inheritedValue {
id
version
mcs {
...McsFragment
}
type
name
searchTerms
countArticles
articles {
...ArticleFragment
}
categories {
...CategoryTreeFragment
}
categoryTreeEntries {
...LinkToCategoryTreeEntryFragment
}
inheritanceEnabled
inheritedValue {
...SearchExclusionFragment
}
}
}
}
Variables
{"id": {}, "version": {}}
Response
{
"data": {
"search_findExclusion": {
"id": {},
"version": {},
"mcs": Mcs,
"type": "FOR_ALL_SEARCH_TERMS",
"name": "abc123",
"searchTerms": ["abc123"],
"countArticles": 123,
"articles": [Article],
"categories": [CategoryTree],
"categoryTreeEntries": [LinkToCategoryTreeEntry],
"inheritanceEnabled": true,
"inheritedValue": SearchExclusion
}
}
}
search_findExclusions
Description
searches for search exclusions that fit the given parameters. Returns error if no exclusion with these parameters exist.
Response
Returns a SearchExclusions!
Arguments
| Name | Description |
|---|---|
input - FindSearchExclusionInput!
|
The parameters to filter by. |
Example
Query
query Search_findExclusions($input: FindSearchExclusionInput!) {
search_findExclusions(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
type
name
searchTerms
countArticles
articles {
...ArticleFragment
}
categories {
...CategoryTreeFragment
}
categoryTreeEntries {
...LinkToCategoryTreeEntryFragment
}
inheritanceEnabled
inheritedValue {
...SearchExclusionFragment
}
}
totalCount
}
}
Variables
{"input": FindSearchExclusionInput}
Response
{
"data": {
"search_findExclusions": {
"entries": [SearchExclusion],
"totalCount": 987
}
}
}
search_findIndexableAttribute
Response
Returns a SearchIndexableAttributeFindPayload!
Arguments
| Name | Description |
|---|---|
filter - IndexableAttributeFilterInput!
|
Default = {} |
paging - IndexableAttributePagingInput!
|
Default = {paging: {limit: 100, offset: 0}, sorting: {sortOrder: ASC, sortType: NAME}} |
Example
Query
query Search_findIndexableAttribute(
$filter: IndexableAttributeFilterInput!,
$paging: IndexableAttributePagingInput!
) {
search_findIndexableAttribute(
filter: $filter,
paging: $paging
) {
entries {
level
attributeName
displayName
description
}
totalCount
}
}
Variables
{
"filter": {},
"paging": {
"paging": {"limit": 100, "offset": 0},
"sorting": {"sortOrder": "ASC", "sortType": "NAME"}
}
}
Response
{
"data": {
"search_findIndexableAttribute": {
"entries": [IndexableAttribute],
"totalCount": 987
}
}
}
search_findIndexingScenarios
Description
Find all scenarios which will be used to add attributes on them later.
Response
Returns [SearchIndexingScenario!]!
Arguments
| Name | Description |
|---|---|
input - FindSearchIndexingScenarioInput!
|
Paging and Sorting information to return more specific scenarios. |
Example
Query
query Search_findIndexingScenarios($input: FindSearchIndexingScenarioInput!) {
search_findIndexingScenarios(input: $input) {
id
version
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
name
isInherited
factor
trackingCode
}
}
Variables
{"input": FindSearchIndexingScenarioInput}
Response
{
"data": {
"search_findIndexingScenarios": [
{
"id": {},
"version": {},
"mcs": Mcs,
"name": "abc123",
"isInherited": false,
"factor": 123,
"trackingCode": "abc123"
}
]
}
}
search_findLemmata
Description
Finds all matching lemma entries.
Response
Returns a QueryLemmaPayload!
Arguments
| Name | Description |
|---|---|
input - LemmaFindInput!
|
A description of the lemma entries to search for. |
Example
Query
query Search_findLemmata($input: LemmaFindInput!) {
search_findLemmata(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
searchTerms
wordStem
isInherited
}
totalCount
}
}
Variables
{"input": LemmaFindInput}
Response
{
"data": {
"search_findLemmata": {
"entries": [Lemma],
"totalCount": 987
}
}
}
search_findScenarioAttributes
Description
Find all attributes in specific mcs and for each attribute if it was selected or not for specific scenario id.
Response
Returns a SearchIndexableAttributes!
Arguments
| Name | Description |
|---|---|
filter - AllAttributesFilterInput!
|
Filter options to filter for more specific attributes. |
Example
Query
query Search_findScenarioAttributes($filter: AllAttributesFilterInput!) {
search_findScenarioAttributes(filter: $filter) {
entries {
attribute
level
selected
}
totalCount
}
}
Variables
{"filter": AllAttributesFilterInput}
Response
{
"data": {
"search_findScenarioAttributes": {
"entries": [SearchIndexableAttribute],
"totalCount": 123
}
}
}
search_findSearchIndexAttributes
Description
Finds all index attributes for a given search scenario.
Response
Returns a SearchIndexScenarioAttributes!
Arguments
| Name | Description |
|---|---|
input - FindSearchIndexScenarioAttributeInput!
|
Paging and Sorting information. Also the scenario to search in. |
Example
Query
query Search_findSearchIndexAttributes($input: FindSearchIndexScenarioAttributeInput!) {
search_findSearchIndexAttributes(input: $input) {
entries {
id
version
weight
name
level
mcs {
...McsFragment
}
isInherited
updated
created
}
totalCount
}
}
Variables
{"input": FindSearchIndexScenarioAttributeInput}
Response
{
"data": {
"search_findSearchIndexAttributes": {
"entries": [SearchIndexScenarioAttribute],
"totalCount": 987
}
}
}
search_findSearchIndexLastUpdate
Description
Returns the last time the search index of a given MCS is updated.
Response
Returns a DateTime
Example
Query
query Search_findSearchIndexLastUpdate {
search_findSearchIndexLastUpdate
}
Response
{
"data": {
"search_findSearchIndexLastUpdate": "2007-12-03T10:15:30Z"
}
}
search_findSearchTermGroup
Description
Find all Search term groups for a specific mcs.
Response
Returns a SearchTermGroups!
Arguments
| Name | Description |
|---|---|
input - FindSearchTermGroupInput!
|
Filter information about the search term group to find. |
Example
Query
query Search_findSearchTermGroup($input: FindSearchTermGroupInput!) {
search_findSearchTermGroup(input: $input) {
entries {
id
version
name
valid
isExact
mcs {
...McsFragment
}
searchTerms
isInherited
referenceType
}
totalCount
}
}
Variables
{"input": FindSearchTermGroupInput}
Response
{
"data": {
"search_findSearchTermGroup": {
"entries": [SearchTermGroup],
"totalCount": 123
}
}
}
search_findSuggestAttributes
Description
Find attributes usable for search suggest and whether they are currently indexed or not.
Response
Returns [SearchIndexableAttribute!]!
Arguments
| Name | Description |
|---|---|
input - FindSearchSuggestAttributesInput!
|
A searchterm and additional parameters. |
Example
Query
query Search_findSuggestAttributes($input: FindSearchSuggestAttributesInput!) {
search_findSuggestAttributes(input: $input) {
attribute
level
selected
}
}
Variables
{"input": FindSearchSuggestAttributesInput}
Response
{
"data": {
"search_findSuggestAttributes": [
{
"attribute": "abc123",
"level": "Product",
"selected": true
}
]
}
}
search_findSynonymById
Description
Finds a synonym or antonym.
Example
Query
query Search_findSynonymById($id: ID!) {
search_findSynonymById(id: $id) {
id
version
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
synonymGroups {
id
version
mcs {
...McsFragment
}
overridden
direction
weight
fromSynonyms
toSynonyms
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"search_findSynonymById": {
"id": 4,
"version": {},
"inherited": true,
"mcs": Mcs,
"synonymGroups": [SynonymGroup]
}
}
}
search_findSynonymGroupById
Description
Finds a set of synonyms or antonyms.
Response
Returns a SynonymGroup
Arguments
| Name | Description |
|---|---|
id - ID!
|
The ID of the synonym group in question. |
Example
Query
query Search_findSynonymGroupById($id: ID!) {
search_findSynonymGroupById(id: $id) {
id
version
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
overridden
direction
weight
fromSynonyms
toSynonyms
}
}
Variables
{"id": 4}
Response
{
"data": {
"search_findSynonymGroupById": {
"id": 4,
"version": {},
"mcs": Mcs,
"overridden": true,
"direction": "DIRECTED",
"weight": 987,
"fromSynonyms": ["abc123"],
"toSynonyms": ["xyz789"]
}
}
}
search_findSynonyms
Description
Finds synonyms and antonyms according to a filter input.
Response
Returns a Synonyms!
Arguments
| Name | Description |
|---|---|
synonymSearchInput - SynonymSearchInput
|
A description of the synonyms to search for. |
Example
Query
query Search_findSynonyms($synonymSearchInput: SynonymSearchInput) {
search_findSynonyms(synonymSearchInput: $synonymSearchInput) {
elements {
id
version
inherited
mcs {
...McsFragment
}
synonymGroups {
...SynonymGroupFragment
}
}
totalCount
}
}
Variables
{"synonymSearchInput": SynonymSearchInput}
Response
{
"data": {
"search_findSynonyms": {
"elements": [Synonym],
"totalCount": 987
}
}
}
seo_findCanonicalCategories
Description
Finds all Canonical categories that match url of Seo term rely on category id.
Response
Returns a CanonicalCategoriesFindPayload!
Arguments
| Name | Description |
|---|---|
filter - SeoTermCategoryFilterInput!
|
Example
Query
query Seo_findCanonicalCategories($filter: SeoTermCategoryFilterInput!) {
seo_findCanonicalCategories(filter: $filter) {
entries {
id
version
mcs {
...McsFragment
}
name
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
ancestors {
...NavigationTreeEntryFragment
}
parent {
...NavigationTreeEntryFragment
}
children {
...NavigationTreeEntryChildrenPayloadFragment
}
valid
}
}
}
Variables
{"filter": SeoTermCategoryFilterInput}
Response
{
"data": {
"seo_findCanonicalCategories": {
"entries": [NavigationTreeEntry]
}
}
}
seo_findSeoTerms
Description
Finds all SEO Terms.
Response
Returns a SeoTermFindPayload!
Arguments
| Name | Description |
|---|---|
paging - SeoTermPagingInput!
|
Default = {paging: {limit: 100, offset: 0}, sortInput: {sortOrder: ASC, sortType: TERM}} |
filter - SeoTermFilterInput!
|
Default = {ids: [], categoryStatus: []} |
Example
Query
query Seo_findSeoTerms(
$paging: SeoTermPagingInput!,
$filter: SeoTermFilterInput!
) {
seo_findSeoTerms(
paging: $paging,
filter: $filter
) {
entries {
id
version
term
url
mainTerm
mcs {
...McsFragment
}
categoryTreeEntry {
...CategoryTreeEntryFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
totalCount
}
}
Variables
{
"paging": {
"paging": {"limit": 100, "offset": 0},
"sortInput": {"sortOrder": "ASC", "sortType": "TERM"}
},
"filter": {"ids": [""], "categoryStatus": [""]}
}
Response
{
"data": {
"seo_findSeoTerms": {
"entries": [SeoTerm],
"totalCount": 987
}
}
}
smartAssistant_findData
Description
Returns root list of the smartAssistant tree
Response
Returns a SmartAssistantRoots!
Example
Query
query SmartAssistant_findData {
smartAssistant_findData {
totalCompletion
entries {
name
isCompleted
score
type
totalScore
children {
... on MaintainedPageSmartAssistantNode {
...MaintainedPageSmartAssistantNodeFragment
}
... on MainCategorySmartAssistantNode {
...MainCategorySmartAssistantNodeFragment
}
... on DefaultSmartNode {
...DefaultSmartNodeFragment
}
}
}
}
}
Response
{
"data": {
"smartAssistant_findData": {
"totalCompletion": 123.45,
"entries": [SmartAssistantRoot]
}
}
}
translation_findMessageMcss
Description
Filters the message MultiChannelSelectors for translations
Response
Returns a MessageMcsFindPayload!
Arguments
| Name | Description |
|---|---|
filter - MessageMcsFilterInput!
|
Filter to select MultiChannelSelectors (by id and name). Default = {} |
paging - MessageMcsPagingInput!
|
Sort order, limit and offset of results Default: ascending by hierarchy, 100 (limit) and 0 (offset). Default = {paging: {limit: 100, offset: 0}, sortOn: {sortOrder: ASC, sort: MCS_HIERARCHY}} |
Example
Query
query Translation_findMessageMcss(
$filter: MessageMcsFilterInput!,
$paging: MessageMcsPagingInput!
) {
translation_findMessageMcss(
filter: $filter,
paging: $paging
) {
entries {
mcs {
...BoMcsFragment
}
privileges
}
totalCount
}
}
Variables
{
"filter": {},
"paging": {
"paging": {"limit": 100, "offset": 0},
"sortOn": {"sortOrder": "ASC", "sort": "MCS_HIERARCHY"}
}
}
Response
{
"data": {
"translation_findMessageMcss": {
"entries": [MessageMcs],
"totalCount": 123
}
}
}
translation_findTranslations
Description
Filters the shop translations
Response
Returns a TranslationFindPayload!
Arguments
| Name | Description |
|---|---|
filter - TranslationFilterInput!
|
Filter to select translations (by MultiChannelSelector and message key). Default = {} |
paging - TranslationPagingInput!
|
Sort order, limit and offset of results Default: ascending by name, 100 (limit) and 0 (offset). Default = {paging: {limit: 100, offset: 0}, sortOn: {sortOrder: ASC, sort: NAME}} |
Example
Query
query Translation_findTranslations(
$filter: TranslationFilterInput!,
$paging: TranslationPagingInput!
) {
translation_findTranslations(
filter: $filter,
paging: $paging
) {
entries {
messageKey
translations {
...TranslationFragment
}
}
totalCount
}
}
Variables
{
"filter": {},
"paging": {
"paging": {"limit": 100, "offset": 0},
"sortOn": {"sortOrder": "ASC", "sort": "NAME"}
}
}
Response
{
"data": {
"translation_findTranslations": {
"entries": [Translations],
"totalCount": 987
}
}
}
userRole_findUserRoles
Description
Filters user/role assignments
Response
Returns a UserRoleFindPayload!
Arguments
| Name | Description |
|---|---|
filter - UserRoleFilterInput!
|
Filter to select user/role relations. Default = {} |
paging - UserRolePagingInput!
|
Sort order, limit and offset of results Default: ascending by user name, 100 (limit) and 0 (offset). Default = {paging: {limit: 100, offset: 0}, sortOn: {sortOrder: ASC, sortType: USER}} |
Example
Query
query UserRole_findUserRoles(
$filter: UserRoleFilterInput!,
$paging: UserRolePagingInput!
) {
userRole_findUserRoles(
filter: $filter,
paging: $paging
) {
entries {
id
version
user {
...UserEntityFragment
}
role {
...RoleEntityFragment
}
mcss {
...McsFragment
}
}
totalCount
}
}
Variables
{
"filter": {},
"paging": {
"paging": {"limit": 100, "offset": 0},
"sortOn": {"sortOrder": "ASC", "sortType": "USER"}
}
}
Response
{
"data": {
"userRole_findUserRoles": {
"entries": [UserRoleEntity],
"totalCount": 123
}
}
}
version
Description
A simple query for testing purposes only
Response
Returns a String
Example
Query
query Version {
version
}
Response
{"data": {"version": "abc123"}}
voucher_checkVoucherCode
Description
Check Voucher with matching voucherCode/customerIdentifier to the input
Response
Returns a VoucherCodeCheckPayload!
Arguments
| Name | Description |
|---|---|
input - VoucherCodeCheckInput!
|
Voucher code and customer identifier to find matching vouchers |
Example
Query
query Voucher_checkVoucherCode($input: VoucherCodeCheckInput!) {
voucher_checkVoucherCode(input: $input) {
voucherCodeCheckGroup {
voucherCode {
...VoucherCodeFragment
}
status
remainingUsages
}
}
}
Variables
{"input": VoucherCodeCheckInput}
Response
{
"data": {
"voucher_checkVoucherCode": {
"voucherCodeCheckGroup": [VoucherCodeCheckList]
}
}
}
voucher_doGroupsExist
Description
Find if voucher group name is saved
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
filter - VoucherFilterInput!
|
The filter parameters to search for. Default = {isExactName: false} |
Example
Query
query Voucher_doGroupsExist($filter: VoucherFilterInput!) {
voucher_doGroupsExist(filter: $filter)
}
Variables
{"filter": {"isExactName": "false"}}
Response
{"data": {"voucher_doGroupsExist": true}}
voucher_findVoucherCodesSearchSuggestions
Description
Find voucher codes search suggestions
Response
Returns a VoucherCodeSearchSuggestionFindPayload!
Arguments
| Name | Description |
|---|---|
paging - VoucherPagingInput!
|
Default = {paging: {limit: 100, offset: 0}, sortOn: {sortOrder: ASC, sortType: NAME}} |
filter - VoucherCodeFilterInput!
|
The filter parameters to search for. Default = {} |
Example
Query
query Voucher_findVoucherCodesSearchSuggestions(
$paging: VoucherPagingInput!,
$filter: VoucherCodeFilterInput!
) {
voucher_findVoucherCodesSearchSuggestions(
paging: $paging,
filter: $filter
) {
entries
}
}
Variables
{
"paging": {
"paging": {"limit": 100, "offset": 0},
"sortOn": {"sortOrder": "ASC", "sortType": "NAME"}
},
"filter": {}
}
Response
{
"data": {
"voucher_findVoucherCodesSearchSuggestions": {
"entries": ["abc123"]
}
}
}
voucher_findVoucherGroupDetails
Description
Find voucher group details
Response
Returns a VoucherGroupFindPayload!
Arguments
| Name | Description |
|---|---|
paging - VoucherPagingInput!
|
Paging and sorting. Default = {paging: {limit: 100, offset: 0}, sortOn: {sortOrder: ASC, sortType: NAME}} |
filter - VoucherFilterInput!
|
The filter parameters to search for. Default = {isExactName: false} |
Example
Query
query Voucher_findVoucherGroupDetails(
$paging: VoucherPagingInput!,
$filter: VoucherFilterInput!
) {
voucher_findVoucherGroupDetails(
paging: $paging,
filter: $filter
) {
entries {
id
version
mcs {
...McsFragment
}
name
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
regex
type
imported
maxPerCodeRedeemCount
maxPerUserRedeemCount
codesInGroup
redeemedAmount
voucherCodesInfo {
...VoucherCodeInformationFragment
}
promotionsInfo {
...PromotionEntityFragment
}
usedByPromotion
}
totalCount
}
}
Variables
{
"paging": {
"paging": {"limit": 100, "offset": 0},
"sortOn": {"sortOrder": "ASC", "sortType": "NAME"}
},
"filter": {"isExactName": "false"}
}
Response
{
"data": {
"voucher_findVoucherGroupDetails": {
"entries": [VoucherGroup],
"totalCount": 123
}
}
}
voucher_findVoucherGroups
Description
Find voucher groups
Response
Returns a VoucherGroupFindPayload!
Arguments
| Name | Description |
|---|---|
paging - VoucherPagingInput!
|
Paging and sorting. Default = {paging: {limit: 100, offset: 0}, sortOn: {sortOrder: ASC, sortType: NAME}} |
filter - VoucherFilterInput!
|
The filter parameters to search for. Default = {isExactName: false} |
Example
Query
query Voucher_findVoucherGroups(
$paging: VoucherPagingInput!,
$filter: VoucherFilterInput!
) {
voucher_findVoucherGroups(
paging: $paging,
filter: $filter
) {
entries {
id
version
mcs {
...McsFragment
}
name
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
regex
type
imported
maxPerCodeRedeemCount
maxPerUserRedeemCount
codesInGroup
redeemedAmount
voucherCodesInfo {
...VoucherCodeInformationFragment
}
promotionsInfo {
...PromotionEntityFragment
}
usedByPromotion
}
totalCount
}
}
Variables
{
"paging": {
"paging": {"limit": 100, "offset": 0},
"sortOn": {"sortOrder": "ASC", "sortType": "NAME"}
},
"filter": {"isExactName": "false"}
}
Response
{
"data": {
"voucher_findVoucherGroups": {
"entries": [VoucherGroup],
"totalCount": 987
}
}
}
voucher_findVouchersSearchSuggestions
Description
Find vouchers search suggestions
Response
Returns a VoucherSearchSuggestionFindPayload!
Arguments
| Name | Description |
|---|---|
paging - VoucherPagingInput!
|
Paging and sorting. Default = {paging: {limit: 100, offset: 0}, sortOn: {sortOrder: ASC, sortType: NAME}} |
filter - VoucherFilterInput!
|
The filter parameters to search for. Default = {isExactName: false} |
Example
Query
query Voucher_findVouchersSearchSuggestions(
$paging: VoucherPagingInput!,
$filter: VoucherFilterInput!
) {
voucher_findVouchersSearchSuggestions(
paging: $paging,
filter: $filter
) {
entries
}
}
Variables
{
"paging": {
"paging": {"limit": 100, "offset": 0},
"sortOn": {"sortOrder": "ASC", "sortType": "NAME"}
},
"filter": {"isExactName": "false"}
}
Response
{
"data": {
"voucher_findVouchersSearchSuggestions": {
"entries": ["abc123"]
}
}
}
voucher_previewCodes
Description
Preview voucher codes
Response
Returns a PreviewCodesFindPayload!
Arguments
| Name | Description |
|---|---|
paging - PreviewCodesPagingInput!
|
Paging and sorting. Default = {paging: {limit: 100, offset: 0}} |
filter - PreviewCodesFilterInput!
|
Prefix, regex and number of codes to be generated. Default = {prefix: ""} |
Example
Query
query Voucher_previewCodes(
$paging: PreviewCodesPagingInput!,
$filter: PreviewCodesFilterInput!
) {
voucher_previewCodes(
paging: $paging,
filter: $filter
) {
entries
}
}
Variables
{"paging": {"paging": {"limit": 100, "offset": 0}}, "filter": {"prefix": ""}}
Response
{
"data": {
"voucher_previewCodes": {
"entries": ["abc123"]
}
}
}
Mutations
abTest_createAbtest
Description
Creates a new AbTest.
Response
Returns an AbTestCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateAbTestInput!]!
|
Example
Query
mutation AbTest_createAbtest($input: [CreateAbTestInput!]!) {
abTest_createAbtest(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
description
hypothesis
startDate
endDate
status
scenarios {
...AbTestScenarioFragment
}
deleted
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
}
}
Variables
{"input": [CreateAbTestInput]}
Response
{"data": {"abTest_createAbtest": {"entries": [AbTest]}}}
abTest_deleteAbTest
Description
Delete existing AbTest
Response
Returns an AbTestDeletePayload!
Arguments
| Name | Description |
|---|---|
id - [EntityId!]!
|
Example
Query
mutation AbTest_deleteAbTest($id: [EntityId!]!) {
abTest_deleteAbTest(id: $id) {
successful
}
}
Variables
{"id": [EntityId]}
Response
{"data": {"abTest_deleteAbTest": {"successful": false}}}
abTest_updateAbTest
Description
Update an existing AbTest
Response
Returns an AbTestUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateAbTestInput!]!
|
Example
Query
mutation AbTest_updateAbTest($input: [UpdateAbTestInput!]!) {
abTest_updateAbTest(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
description
hypothesis
startDate
endDate
status
scenarios {
...AbTestScenarioFragment
}
deleted
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
}
}
Variables
{"input": [UpdateAbTestInput]}
Response
{"data": {"abTest_updateAbTest": {"entries": [AbTest]}}}
assetFormat_createAssetFormat
Description
Add new Asset Format
Response
Returns [AssetFormat!]!
Arguments
| Name | Description |
|---|---|
input - CreateAssetFormatInput!
|
Example
Query
mutation AssetFormat_createAssetFormat($input: CreateAssetFormatInput!) {
assetFormat_createAssetFormat(input: $input) {
id
version
name
width
height
}
}
Variables
{"input": CreateAssetFormatInput}
Response
{
"data": {
"assetFormat_createAssetFormat": [
{
"id": 4,
"version": {},
"name": "xyz789",
"width": 987,
"height": 123
}
]
}
}
assetFormat_deleteAssetFormat
Description
Delete existing asset format
assetFormat_updateAssetFormat
Description
Update existing asset format
Response
Returns [AssetFormat!]!
Arguments
| Name | Description |
|---|---|
input - UpdateAssetFormatInput!
|
Example
Query
mutation AssetFormat_updateAssetFormat($input: UpdateAssetFormatInput!) {
assetFormat_updateAssetFormat(input: $input) {
id
version
name
width
height
}
}
Variables
{"input": UpdateAssetFormatInput}
Response
{
"data": {
"assetFormat_updateAssetFormat": [
{
"id": 4,
"version": {},
"name": "xyz789",
"width": 123,
"height": 987
}
]
}
}
asset_createBinaryImage
Description
Add new Binary Image asset operation using importedId
Response
Returns an AssetCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateBinaryImageInput!]!
|
Example
Query
mutation Asset_createBinaryImage($input: [CreateBinaryImageInput!]!) {
asset_createBinaryImage(input: $input) {
entries {
id
version
name
mcs {
...McsFragment
}
contentType
assetCategory
size
keywords
url
uploadedDate
lastModified
uploadedUser {
...UserInformationFragment
}
editedUser {
...UserInformationFragment
}
assetType
}
}
}
Variables
{"input": [CreateBinaryImageInput]}
Response
{
"data": {
"asset_createBinaryImage": {"entries": [Asset]}
}
}
asset_createLinkableAsset
Description
Add new Linkable Asset operation using importedId
Response
Returns an AssetCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateLinkableAssetInput!]!
|
Example
Query
mutation Asset_createLinkableAsset($input: [CreateLinkableAssetInput!]!) {
asset_createLinkableAsset(input: $input) {
entries {
id
version
name
mcs {
...McsFragment
}
contentType
assetCategory
size
keywords
url
uploadedDate
lastModified
uploadedUser {
...UserInformationFragment
}
editedUser {
...UserInformationFragment
}
assetType
}
}
}
Variables
{"input": [CreateLinkableAssetInput]}
Response
{
"data": {
"asset_createLinkableAsset": {"entries": [Asset]}
}
}
asset_createStaticContent
Description
Add new Static Content asset operation using importedId
Response
Returns an AssetCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateStaticContentInput!]!
|
Example
Query
mutation Asset_createStaticContent($input: [CreateStaticContentInput!]!) {
asset_createStaticContent(input: $input) {
entries {
id
version
name
mcs {
...McsFragment
}
contentType
assetCategory
size
keywords
url
uploadedDate
lastModified
uploadedUser {
...UserInformationFragment
}
editedUser {
...UserInformationFragment
}
assetType
}
}
}
Variables
{"input": [CreateStaticContentInput]}
Response
{
"data": {
"asset_createStaticContent": {"entries": [Asset]}
}
}
asset_deleteAsset
Description
Delete images by their ids (Binary image, static content, linkable asset)
Response
Returns an AssetDeletePayload!
Arguments
| Name | Description |
|---|---|
ids - [EntityId!]!
|
Example
Query
mutation Asset_deleteAsset($ids: [EntityId!]!) {
asset_deleteAsset(ids: $ids) {
successful
}
}
Variables
{"ids": [EntityId]}
Response
{"data": {"asset_deleteAsset": {"successful": true}}}
asset_optimizeAsset
Description
Optimize asset operation
asset_updateAsset
Description
Update static content or linkable asset
Response
Returns an AssetUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateAssetInput!]!
|
Example
Query
mutation Asset_updateAsset($input: [UpdateAssetInput!]!) {
asset_updateAsset(input: $input) {
entries {
id
version
name
mcs {
...McsFragment
}
contentType
assetCategory
size
keywords
url
uploadedDate
lastModified
uploadedUser {
...UserInformationFragment
}
editedUser {
...UserInformationFragment
}
assetType
}
}
}
Variables
{"input": [UpdateAssetInput]}
Response
{"data": {"asset_updateAsset": {"entries": [Asset]}}}
asset_updateBinaryImage
Description
Update binary image
Response
Returns an AssetUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateBinaryImageInput!]!
|
Example
Query
mutation Asset_updateBinaryImage($input: [UpdateBinaryImageInput!]!) {
asset_updateBinaryImage(input: $input) {
entries {
id
version
name
mcs {
...McsFragment
}
contentType
assetCategory
size
keywords
url
uploadedDate
lastModified
uploadedUser {
...UserInformationFragment
}
editedUser {
...UserInformationFragment
}
assetType
}
}
}
Variables
{"input": [UpdateBinaryImageInput]}
Response
{
"data": {
"asset_updateBinaryImage": {"entries": [Asset]}
}
}
asset_updateStaticContent
Description
Update static content
Response
Returns an AssetUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateStaticContentInput!]!
|
Example
Query
mutation Asset_updateStaticContent($input: [UpdateStaticContentInput!]!) {
asset_updateStaticContent(input: $input) {
entries {
id
version
name
mcs {
...McsFragment
}
contentType
assetCategory
size
keywords
url
uploadedDate
lastModified
uploadedUser {
...UserInformationFragment
}
editedUser {
...UserInformationFragment
}
assetType
}
}
}
Variables
{"input": [UpdateStaticContentInput]}
Response
{
"data": {
"asset_updateStaticContent": {"entries": [Asset]}
}
}
asset_validateZipAndExtractFiles
Description
Validate zip file then extract files & add them at the asset cache
Response
Returns [ImportedFileData!]!
Arguments
| Name | Description |
|---|---|
input - ExtractZipFileInput!
|
The input for validiting & extracting a zip file. |
Example
Query
mutation Asset_validateZipAndExtractFiles($input: ExtractZipFileInput!) {
asset_validateZipAndExtractFiles(input: $input) {
importedId
fileName
fileSize
contentType
checksum
assetCategory
dimension {
width
height
}
uploadedMessageType
uploadedStatus
statusMessages
}
}
Variables
{"input": ExtractZipFileInput}
Response
{
"data": {
"asset_validateZipAndExtractFiles": [
{
"importedId": {},
"fileName": "abc123",
"fileSize": {},
"contentType": "abc123",
"checksum": "xyz789",
"assetCategory": "IMAGE",
"dimension": Dimension,
"uploadedMessageType": "SAME_FILE_EXISTS",
"uploadedStatus": "SUCCESS",
"statusMessages": ["xyz789"]
}
]
}
}
brand_updateBrand
Description
Update existing brand
Response
Returns a BrandUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateBrandInput!]!
|
Example
Query
mutation Brand_updateBrand($input: [UpdateBrandInput!]!) {
brand_updateBrand(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
valid
updatedBy {
...UserInformationFragment
}
status
images {
...BrandImageFragment
}
links {
...BrandAttributeLinkFragment
}
parameters {
...BrandParameterFragment
}
}
}
}
Variables
{"input": [UpdateBrandInput]}
Response
{
"data": {
"brand_updateBrand": {"entries": [BrandEntity]}
}
}
campaign_createCampaign
Description
Create a new campaign
Response
Returns a CampaignCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateCampaignInput!]!
|
Example
Query
mutation Campaign_createCampaign($input: [CreateCampaignInput!]!) {
campaign_createCampaign(input: $input) {
entries {
id
version
name
mcs {
...McsFragment
}
startDate
endDate
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
status
references {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
}
}
}
Variables
{"input": [CreateCampaignInput]}
Response
{
"data": {
"campaign_createCampaign": {"entries": [Campaign]}
}
}
campaign_deleteCampaign
Description
Delete existing campaign.
Response
Returns a CampaignDeletePayload!
Arguments
| Name | Description |
|---|---|
input - [DeleteCampaignInput!]!
|
Example
Query
mutation Campaign_deleteCampaign($input: [DeleteCampaignInput!]!) {
campaign_deleteCampaign(input: $input) {
successful
}
}
Variables
{"input": [DeleteCampaignInput]}
Response
{"data": {"campaign_deleteCampaign": {"successful": false}}}
campaign_updateCampaign
Description
Edit existing campaign.
Response
Returns a CampaignUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateCampaignInput!]!
|
Example
Query
mutation Campaign_updateCampaign($input: [UpdateCampaignInput!]!) {
campaign_updateCampaign(input: $input) {
entries {
id
version
name
mcs {
...McsFragment
}
startDate
endDate
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
status
references {
... on PromotionEntity {
...PromotionEntityFragment
}
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on BrandParameter {
...BrandParameterFragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on Teaser {
...TeaserFragment
}
... on Tab {
...TabFragment
}
... on CuratedPage {
...CuratedPageFragment
}
... on SmartCategory {
...SmartCategoryFragment
}
... on FilterCategory {
...FilterCategoryFragment
}
... on BrandCategory {
...BrandCategoryFragment
}
}
}
}
}
Variables
{"input": [UpdateCampaignInput]}
Response
{
"data": {
"campaign_updateCampaign": {"entries": [Campaign]}
}
}
cip_createConnectedIProductsStatus
Description
Create a connected iProduct status
Response
Returns a ConnectedIProductsStatusCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateConnectedIProductsStatusInput!]!
|
Example
Query
mutation Cip_createConnectedIProductsStatus($input: [CreateConnectedIProductsStatusInput!]!) {
cip_createConnectedIProductsStatus(input: $input) {
entries {
id
version
productId
useCaseId
active
}
}
}
Variables
{"input": [CreateConnectedIProductsStatusInput]}
Response
{
"data": {
"cip_createConnectedIProductsStatus": {
"entries": [ConnectedIProductStatus]
}
}
}
cip_deleteConnectedIProductsStatus
Description
Delete the existing connected iProduct status
Response
Returns a ConnectedIProductsStatusDeletePayload!
Arguments
| Name | Description |
|---|---|
ids - [EntityId!]!
|
Example
Query
mutation Cip_deleteConnectedIProductsStatus($ids: [EntityId!]!) {
cip_deleteConnectedIProductsStatus(ids: $ids) {
successful
}
}
Variables
{"ids": [EntityId]}
Response
{"data": {"cip_deleteConnectedIProductsStatus": {"successful": true}}}
cms_assignAbTestToGrid
Response
Returns a GridAssignAbTestPayload!
Arguments
| Name | Description |
|---|---|
input - AssignAbTestInput!
|
Example
Query
mutation Cms_assignAbTestToGrid($input: AssignAbTestInput!) {
cms_assignAbTestToGrid(input: $input) {
grid {
id
version
name
timeValidity {
...DateRangeFragment
}
mcs {
...McsFragment
}
inherited
abScenario {
...AbTestScenarioFragment
}
audit {
...BackofficeUserInfoAuditFragment
}
gridElements {
...GridElementPayloadFragment
}
}
}
}
Variables
{"input": AssignAbTestInput}
Response
{"data": {"cms_assignAbTestToGrid": {"grid": Grid}}}
cms_copyContainerToClipboard
Response
Returns a CopyContainerToClipboardPayload!
Arguments
| Name | Description |
|---|---|
input - [CopyContainerToClipboardInput!]!
|
Example
Query
mutation Cms_copyContainerToClipboard($input: [CopyContainerToClipboardInput!]!) {
cms_copyContainerToClipboard(input: $input) {
entries {
id
version
gridElementContainer {
...GridElementContainerFragment
}
}
}
}
Variables
{"input": [CopyContainerToClipboardInput]}
Response
{
"data": {
"cms_copyContainerToClipboard": {
"entries": [ClipboardContainerContent]
}
}
}
cms_createGrid
Response
Returns a GridCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateGridInput!]!
|
Example
Query
mutation Cms_createGrid($input: [CreateGridInput!]!) {
cms_createGrid(input: $input) {
entries {
id
version
name
timeValidity {
...DateRangeFragment
}
mcs {
...McsFragment
}
inherited
abScenario {
...AbTestScenarioFragment
}
audit {
...BackofficeUserInfoAuditFragment
}
gridElements {
...GridElementPayloadFragment
}
}
}
}
Variables
{"input": [CreateGridInput]}
Response
{"data": {"cms_createGrid": {"entries": [Grid]}}}
cms_createGridTemplate
Description
Create new grid template
Response
Returns a GridTemplateCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateGridTemplateInput!]!
|
Example
Query
mutation Cms_createGridTemplate($input: [CreateGridTemplateInput!]!) {
cms_createGridTemplate(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
inherited
name
template {
...TeaserTemplateFragment
}
containers {
...GridTemplateContainerFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
}
}
Variables
{"input": [CreateGridTemplateInput]}
Response
{
"data": {
"cms_createGridTemplate": {"entries": [GridTemplate]}
}
}
cms_deleteFromClipboard
Response
Returns a ClipboardDeletePayload!
Arguments
| Name | Description |
|---|---|
ids - [EntityId!]!
|
Example
Query
mutation Cms_deleteFromClipboard($ids: [EntityId!]!) {
cms_deleteFromClipboard(ids: $ids) {
successful
}
}
Variables
{"ids": [EntityId]}
Response
{"data": {"cms_deleteFromClipboard": {"successful": true}}}
cms_deleteGrid
Description
cms_copyGrid(input: [CopyGridInput!]!): GridCopyPayload! """If start date < NOW, error."""
Response
Returns a GridDeletePayload!
Arguments
| Name | Description |
|---|---|
ids - [EntityId!]!
|
Example
Query
mutation Cms_deleteGrid($ids: [EntityId!]!) {
cms_deleteGrid(ids: $ids) {
successful
}
}
Variables
{"ids": [EntityId]}
Response
{"data": {"cms_deleteGrid": {"successful": false}}}
cms_deleteGridTemplate
Description
Delete grid template
Response
Returns a GridTemplateDeletePayload!
Arguments
| Name | Description |
|---|---|
id - [EntityId!]!
|
Example
Query
mutation Cms_deleteGridTemplate($id: [EntityId!]!) {
cms_deleteGridTemplate(id: $id) {
successful
}
}
Variables
{"id": [EntityId]}
Response
{"data": {"cms_deleteGridTemplate": {"successful": false}}}
cms_unassignAbTestFromPage
Response
Returns a GridUnassignAbTestPayload!
Arguments
| Name | Description |
|---|---|
input - UnassignAbTestInput!
|
Example
Query
mutation Cms_unassignAbTestFromPage($input: UnassignAbTestInput!) {
cms_unassignAbTestFromPage(input: $input) {
successful
}
}
Variables
{"input": UnassignAbTestInput}
Response
{"data": {"cms_unassignAbTestFromPage": {"successful": true}}}
cms_updateGrid
Response
Returns a GridUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateGridInput!]!
|
Example
Query
mutation Cms_updateGrid($input: [UpdateGridInput!]!) {
cms_updateGrid(input: $input) {
entries {
id
version
name
timeValidity {
...DateRangeFragment
}
mcs {
...McsFragment
}
inherited
abScenario {
...AbTestScenarioFragment
}
audit {
...BackofficeUserInfoAuditFragment
}
gridElements {
...GridElementPayloadFragment
}
}
}
}
Variables
{"input": [UpdateGridInput]}
Response
{"data": {"cms_updateGrid": {"entries": [Grid]}}}
cms_updateGridElement
Response
Returns a GridElementUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateGridElementInput!]!
|
Example
Query
mutation Cms_updateGridElement($input: [UpdateGridElementInput!]!) {
cms_updateGridElement(input: $input) {
entries {
id
version
name
trackingCode
type
position {
...ElementPositionFragment
}
parameter {
...GridContainerParameterPayloadFragment
}
audit {
...BackofficeUserInfoAuditFragment
}
container {
...GridElementContainerPayloadFragment
}
}
}
}
Variables
{"input": [UpdateGridElementInput]}
Response
{
"data": {
"cms_updateGridElement": {"entries": [GridElement]}
}
}
cms_updateGridTemplate
Description
Update grid template
Response
Returns a GridTemplateUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateGridTemplateInput!]!
|
Example
Query
mutation Cms_updateGridTemplate($input: [UpdateGridTemplateInput!]!) {
cms_updateGridTemplate(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
inherited
name
template {
...TeaserTemplateFragment
}
containers {
...GridTemplateContainerFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
}
}
Variables
{"input": [UpdateGridTemplateInput]}
Response
{
"data": {
"cms_updateGridTemplate": {"entries": [GridTemplate]}
}
}
core_createUserInformation
Description
Create the information of the current user
Response
Returns a UserInformationCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateUserInformationInput!]!
|
Example
Query
mutation Core_createUserInformation($input: [CreateUserInformationInput!]!) {
core_createUserInformation(input: $input) {
entries {
id
version
name
email
settings {
...UserSettingsFragment
}
userRoles {
...UserRoleEntityFragment
}
isSystemUser
}
}
}
Variables
{"input": [CreateUserInformationInput]}
Response
{
"data": {
"core_createUserInformation": {
"entries": [UserInformation]
}
}
}
core_deactivateItem
Description
Deactivates an item described by ID until it is reenabled (reenabling by productdata import from pim or flag removed)
core_deactivateProduct
Description
Deactivates a product described by ID until it is reenabled (reenabling by productdata import from pim or flag removed)
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
productId - String!
|
The ID of a product to deactivate. |
Example
Query
mutation Core_deactivateProduct($productId: String!) {
core_deactivateProduct(productId: $productId)
}
Variables
{"productId": "xyz789"}
Response
{"data": {"core_deactivateProduct": true}}
core_deleteUserInformation
Description
Delete the information of the current user
Response
Returns a UserInformationDeletePayload!
Arguments
| Name | Description |
|---|---|
ids - [EntityId!]!
|
Example
Query
mutation Core_deleteUserInformation($ids: [EntityId!]!) {
core_deleteUserInformation(ids: $ids) {
successful
}
}
Variables
{"ids": [EntityId]}
Response
{"data": {"core_deleteUserInformation": {"successful": false}}}
core_reactivateItem
Description
Reactivates an item described by ID by removing the disabling flag.
core_reactivateProduct
Description
Reactivates a product described by ID by removing the disabling flag.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
productId - String!
|
The ID of a product to reactivate. |
Example
Query
mutation Core_reactivateProduct($productId: String!) {
core_reactivateProduct(productId: $productId)
}
Variables
{"productId": "abc123"}
Response
{"data": {"core_reactivateProduct": false}}
core_updateMyProfile
Description
Change the information of the current user
Response
Returns a UserInformationUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateMyProfileInput!]!
|
Example
Query
mutation Core_updateMyProfile($input: [UpdateMyProfileInput!]!) {
core_updateMyProfile(input: $input) {
entries {
id
version
name
email
settings {
...UserSettingsFragment
}
userRoles {
...UserRoleEntityFragment
}
isSystemUser
}
}
}
Variables
{"input": [UpdateMyProfileInput]}
Response
{
"data": {
"core_updateMyProfile": {"entries": [UserInformation]}
}
}
core_updateOsSimpleIdForCategory
Description
Will replace all os simple ids by a new one, so that the old maintained parameters are restored.
Response
Returns a Boolean!
Example
Query
mutation Core_updateOsSimpleIdForCategory(
$simpleIdToRestore: String!,
$newSimpleId: String!
) {
core_updateOsSimpleIdForCategory(
simpleIdToRestore: $simpleIdToRestore,
newSimpleId: $newSimpleId
)
}
Variables
{
"simpleIdToRestore": "xyz789",
"newSimpleId": "xyz789"
}
Response
{"data": {"core_updateOsSimpleIdForCategory": false}}
core_updateUserInformation
Description
Change the information of the current user
Response
Returns a UserInformationUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateUserInformationInput!]!
|
Example
Query
mutation Core_updateUserInformation($input: [UpdateUserInformationInput!]!) {
core_updateUserInformation(input: $input) {
entries {
id
version
name
email
settings {
...UserSettingsFragment
}
userRoles {
...UserRoleEntityFragment
}
isSystemUser
}
}
}
Variables
{"input": [UpdateUserInformationInput]}
Response
{
"data": {
"core_updateUserInformation": {
"entries": [UserInformation]
}
}
}
customerSegments_createCustomerSegment
Description
Add new customer segment
Response
Returns [CustomerSegment!]!
Arguments
| Name | Description |
|---|---|
input - [CreateCustomerSegmentInput!]!
|
Example
Query
mutation CustomerSegments_createCustomerSegment($input: [CreateCustomerSegmentInput!]!) {
customerSegments_createCustomerSegment(input: $input) {
id
version
name
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
description
deleted
type
dynamic
conditions {
id
version
conditions {
... on ComplexCondition {
...ComplexConditionFragment
}
... on SimpleCondition {
...SimpleConditionFragment
}
}
operator
}
group {
id
version
name
mcs {
...McsFragment
}
segments {
...CustomerSegmentFragment
}
priority
dynamic
}
brokenInheritanceFrom
isStandardCustomerSegment
}
}
Variables
{"input": [CreateCustomerSegmentInput]}
Response
{
"data": {
"customerSegments_createCustomerSegment": [
{
"id": 4,
"version": {},
"name": "abc123",
"mcs": Mcs,
"description": "xyz789",
"deleted": true,
"type": "BuiltIn",
"dynamic": true,
"conditions": ComplexCondition,
"group": CustomerSegmentGroup,
"brokenInheritanceFrom": {},
"isStandardCustomerSegment": false
}
]
}
}
customerSegments_deleteCustomerSegment
Description
Delete existing customer segment
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - [EntityId!]!
|
Example
Query
mutation CustomerSegments_deleteCustomerSegment($id: [EntityId!]!) {
customerSegments_deleteCustomerSegment(id: $id)
}
Variables
{"id": [EntityId]}
Response
{"data": {"customerSegments_deleteCustomerSegment": true}}
customerSegments_updateCustomerSegment
Description
Update existing customer segment
Response
Returns [CustomerSegment!]!
Arguments
| Name | Description |
|---|---|
input - [UpdateCustomerSegmentInput!]!
|
Example
Query
mutation CustomerSegments_updateCustomerSegment($input: [UpdateCustomerSegmentInput!]!) {
customerSegments_updateCustomerSegment(input: $input) {
id
version
name
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
description
deleted
type
dynamic
conditions {
id
version
conditions {
... on ComplexCondition {
...ComplexConditionFragment
}
... on SimpleCondition {
...SimpleConditionFragment
}
}
operator
}
group {
id
version
name
mcs {
...McsFragment
}
segments {
...CustomerSegmentFragment
}
priority
dynamic
}
brokenInheritanceFrom
isStandardCustomerSegment
}
}
Variables
{"input": [UpdateCustomerSegmentInput]}
Response
{
"data": {
"customerSegments_updateCustomerSegment": [
{
"id": "4",
"version": {},
"name": "xyz789",
"mcs": Mcs,
"description": "abc123",
"deleted": false,
"type": "BuiltIn",
"dynamic": false,
"conditions": ComplexCondition,
"group": CustomerSegmentGroup,
"brokenInheritanceFrom": {},
"isStandardCustomerSegment": false
}
]
}
}
dataExport_createArticleIgnoreList
Description
Create new articles ignore list
Response
Returns an ArticleIgnoreListCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateArticlesIgnoreListInput!]!
|
Example
Query
mutation DataExport_createArticleIgnoreList($input: [CreateArticlesIgnoreListInput!]!) {
dataExport_createArticleIgnoreList(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
granularity
articles {
...ArticleFragment
}
}
}
}
Variables
{"input": [CreateArticlesIgnoreListInput]}
Response
{
"data": {
"dataExport_createArticleIgnoreList": {
"entries": [DataExportArticleIgnoreList]
}
}
}
dataExport_createCategoryIgnoreList
Description
Create new category ignore list
Response
Returns a CategoryIgnoreListCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateCategoriesIgnoreListInput!]!
|
Example
Query
mutation DataExport_createCategoryIgnoreList($input: [CreateCategoriesIgnoreListInput!]!) {
dataExport_createCategoryIgnoreList(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
exportCategories {
...LinkToCategoryTreeEntryFragment
}
}
}
}
Variables
{"input": [CreateCategoriesIgnoreListInput]}
Response
{
"data": {
"dataExport_createCategoryIgnoreList": {
"entries": [DataExportCategoryIgnoreList]
}
}
}
dataExport_createDataExports
Description
Create new data export
Response
Returns a DataExportCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateDataExportInput!]!
|
Example
Query
mutation DataExport_createDataExports($input: [CreateDataExportInput!]!) {
dataExport_createDataExports(input: $input) {
entries {
id
version
name
mcs {
...McsFragment
}
email
lastExecutionDate
nextExecutionDate
granularity
status
compressionType
exportType {
... on HttpType {
...HttpTypeFragment
}
... on FtpType {
...FtpTypeFragment
}
}
articlesIgnoreList {
...DataExportArticleIgnoreListFragment
}
categoriesIgnoreList {
...DataExportCategoryIgnoreListFragment
}
exportFormat {
...DataExportFormatFragment
}
conditions {
...ComplexConditionFragment
}
replacementList {
...DataExportReplacementListFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
}
}
Variables
{"input": [CreateDataExportInput]}
Response
{
"data": {
"dataExport_createDataExports": {
"entries": [DataExportEntity]
}
}
}
dataExport_createFormat
Description
Create new format
Response
Returns a FormatCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateFormatInput!]!
|
Example
Query
mutation DataExport_createFormat($input: [CreateFormatInput!]!) {
dataExport_createFormat(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
templateFormat
readOnly
}
}
}
Variables
{"input": [CreateFormatInput]}
Response
{
"data": {
"dataExport_createFormat": {
"entries": [DataExportFormat]
}
}
}
dataExport_createReplacementList
Description
Create new replacement list
Response
Returns a ReplacementListCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateReplacementListInput!]!
|
Example
Query
mutation DataExport_createReplacementList($input: [CreateReplacementListInput!]!) {
dataExport_createReplacementList(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
values {
...DataExportReplacementFragment
}
}
}
}
Variables
{"input": [CreateReplacementListInput]}
Response
{
"data": {
"dataExport_createReplacementList": {
"entries": [DataExportReplacementList]
}
}
}
dataExport_deleteArticleIgnoreList
Description
Delete article ignore list
Response
Returns an ArticleIgnoreListDeletePayload!
Arguments
| Name | Description |
|---|---|
id - [EntityId!]!
|
Example
Query
mutation DataExport_deleteArticleIgnoreList($id: [EntityId!]!) {
dataExport_deleteArticleIgnoreList(id: $id) {
successful
}
}
Variables
{"id": [EntityId]}
Response
{"data": {"dataExport_deleteArticleIgnoreList": {"successful": false}}}
dataExport_deleteCategoryIgnoreList
Description
Delete category ignore list
Response
Returns a CategoryIgnoreListDeletePayload!
Arguments
| Name | Description |
|---|---|
id - [EntityId!]!
|
Example
Query
mutation DataExport_deleteCategoryIgnoreList($id: [EntityId!]!) {
dataExport_deleteCategoryIgnoreList(id: $id) {
successful
}
}
Variables
{"id": [EntityId]}
Response
{"data": {"dataExport_deleteCategoryIgnoreList": {"successful": true}}}
dataExport_deleteDataExports
Description
Delete existing data export
Response
Returns a DataExportDeletePayload!
Arguments
| Name | Description |
|---|---|
id - [EntityId!]!
|
Example
Query
mutation DataExport_deleteDataExports($id: [EntityId!]!) {
dataExport_deleteDataExports(id: $id) {
successful
}
}
Variables
{"id": [EntityId]}
Response
{"data": {"dataExport_deleteDataExports": {"successful": false}}}
dataExport_deleteFormat
Description
Delete format
Response
Returns a FormatDeletePayload!
Arguments
| Name | Description |
|---|---|
id - [EntityId!]!
|
Example
Query
mutation DataExport_deleteFormat($id: [EntityId!]!) {
dataExport_deleteFormat(id: $id) {
successful
}
}
Variables
{"id": [EntityId]}
Response
{"data": {"dataExport_deleteFormat": {"successful": false}}}
dataExport_deleteReplacementList
Description
Delete replacement list
Response
Returns a ReplacementListDeletePayload!
Arguments
| Name | Description |
|---|---|
id - [EntityId!]!
|
Example
Query
mutation DataExport_deleteReplacementList($id: [EntityId!]!) {
dataExport_deleteReplacementList(id: $id) {
successful
}
}
Variables
{"id": [EntityId]}
Response
{"data": {"dataExport_deleteReplacementList": {"successful": true}}}
dataExport_runDataExport
Description
Upload data export
Response
Returns a DataExportRunPayload!
Arguments
| Name | Description |
|---|---|
id - EntityId!
|
Example
Query
mutation DataExport_runDataExport($id: EntityId!) {
dataExport_runDataExport(id: $id) {
successful
}
}
Variables
{"id": EntityId}
Response
{"data": {"dataExport_runDataExport": {"successful": true}}}
dataExport_updateArticleIgnoreList
Description
Update articles ignore list
Response
Returns an ArticleIgnoreListUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateArticleIgnoreListInput!]!
|
Example
Query
mutation DataExport_updateArticleIgnoreList($input: [UpdateArticleIgnoreListInput!]!) {
dataExport_updateArticleIgnoreList(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
granularity
articles {
...ArticleFragment
}
}
}
}
Variables
{"input": [UpdateArticleIgnoreListInput]}
Response
{
"data": {
"dataExport_updateArticleIgnoreList": {
"entries": [DataExportArticleIgnoreList]
}
}
}
dataExport_updateCategoryIgnoreList
Description
Rename category ignore list
Response
Returns a CategoryIgnoreListUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateCategoryIgnoreListInput!]!
|
Example
Query
mutation DataExport_updateCategoryIgnoreList($input: [UpdateCategoryIgnoreListInput!]!) {
dataExport_updateCategoryIgnoreList(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
exportCategories {
...LinkToCategoryTreeEntryFragment
}
}
}
}
Variables
{"input": [UpdateCategoryIgnoreListInput]}
Response
{
"data": {
"dataExport_updateCategoryIgnoreList": {
"entries": [DataExportCategoryIgnoreList]
}
}
}
dataExport_updateDataExports
Description
Update existing data export
Response
Returns a DataExportUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateDataExportInput!]!
|
Example
Query
mutation DataExport_updateDataExports($input: [UpdateDataExportInput!]!) {
dataExport_updateDataExports(input: $input) {
entries {
id
version
name
mcs {
...McsFragment
}
email
lastExecutionDate
nextExecutionDate
granularity
status
compressionType
exportType {
... on HttpType {
...HttpTypeFragment
}
... on FtpType {
...FtpTypeFragment
}
}
articlesIgnoreList {
...DataExportArticleIgnoreListFragment
}
categoriesIgnoreList {
...DataExportCategoryIgnoreListFragment
}
exportFormat {
...DataExportFormatFragment
}
conditions {
...ComplexConditionFragment
}
replacementList {
...DataExportReplacementListFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
}
}
Variables
{"input": [UpdateDataExportInput]}
Response
{
"data": {
"dataExport_updateDataExports": {
"entries": [DataExportEntity]
}
}
}
dataExport_updateFormatList
Description
Update format
Response
Returns a FormatUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateFormatInput!]!
|
Example
Query
mutation DataExport_updateFormatList($input: [UpdateFormatInput!]!) {
dataExport_updateFormatList(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
templateFormat
readOnly
}
}
}
Variables
{"input": [UpdateFormatInput]}
Response
{
"data": {
"dataExport_updateFormatList": {
"entries": [DataExportFormat]
}
}
}
dataExport_updateReplacementList
Description
Update replacement list
Response
Returns a ReplacementListUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateReplacementListInput!]!
|
Example
Query
mutation DataExport_updateReplacementList($input: [UpdateReplacementListInput!]!) {
dataExport_updateReplacementList(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
values {
...DataExportReplacementFragment
}
}
}
}
Variables
{"input": [UpdateReplacementListInput]}
Response
{
"data": {
"dataExport_updateReplacementList": {
"entries": [DataExportReplacementList]
}
}
}
deprecated_parameter_deleteGlobalParameter
Description
Removes a single global parameter. Returns True, if the parameter was deleted successfully.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - Long!
|
The ID of the parameter to delete. |
Example
Query
mutation Deprecated_parameter_deleteGlobalParameter($id: Long!) {
deprecated_parameter_deleteGlobalParameter(id: $id)
}
Variables
{"id": {}}
Response
{"data": {"deprecated_parameter_deleteGlobalParameter": true}}
deprecated_parameter_deleteGlobalParameters
Description
Removes a list of global parameters. Returns the removed parameters.
Response
Returns [GlobalParameterAttribute!]!
Arguments
| Name | Description |
|---|---|
ids - [Long!]!
|
A List of IDs of global parameters to delete. |
Example
Query
mutation Deprecated_parameter_deleteGlobalParameters($ids: [Long!]!) {
deprecated_parameter_deleteGlobalParameters(ids: $ids) {
id
version
name
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
value {
id
version
status
stringList
integerValue
string
option {
...AttributeOptionFragment
}
link {
... on ArticleLink {
...ArticleLinkFragment
}
... on PageLink {
...PageLinkFragment
}
... on AssetLink {
...AssetLinkFragment
}
... on BrandLink {
...BrandLinkFragment
}
... on SearchTermLink {
...SearchTermLinkFragment
}
... on ExternalLink {
...ExternalLinkFragment
}
... on SEOTermLink {
...SEOTermLinkFragment
}
... on ContentTreeLink {
...ContentTreeLinkFragment
}
... on LayerLink {
...LayerLinkFragment
}
}
startDate
endDate
campaign {
...CampaignFragment
}
customerSegmented
abTested
customerSegmentContentAttributes {
...CustomerSegmentContentAttributeFragment
}
scenarioContentAttributes {
...AbScenarioContentAttributeFragment
}
}
}
}
Variables
{"ids": [{}]}
Response
{
"data": {
"deprecated_parameter_deleteGlobalParameters": [
{
"id": 4,
"version": {},
"name": "abc123",
"inherited": false,
"mcs": Mcs,
"value": ContentAttribute
}
]
}
}
deprecated_parameter_saveOrUpdateGlobalParameters
Description
Adds or changes a given global parameter and returns the changed Attributes.
Response
Returns [GlobalParameterAttribute!]!
Arguments
| Name | Description |
|---|---|
globalParameterInput - GlobalParameterInput!
|
The new global parameter. |
Example
Query
mutation Deprecated_parameter_saveOrUpdateGlobalParameters($globalParameterInput: GlobalParameterInput!) {
deprecated_parameter_saveOrUpdateGlobalParameters(globalParameterInput: $globalParameterInput) {
id
version
name
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
value {
id
version
status
stringList
integerValue
string
option {
...AttributeOptionFragment
}
link {
... on ArticleLink {
...ArticleLinkFragment
}
... on PageLink {
...PageLinkFragment
}
... on AssetLink {
...AssetLinkFragment
}
... on BrandLink {
...BrandLinkFragment
}
... on SearchTermLink {
...SearchTermLinkFragment
}
... on ExternalLink {
...ExternalLinkFragment
}
... on SEOTermLink {
...SEOTermLinkFragment
}
... on ContentTreeLink {
...ContentTreeLinkFragment
}
... on LayerLink {
...LayerLinkFragment
}
}
startDate
endDate
campaign {
...CampaignFragment
}
customerSegmented
abTested
customerSegmentContentAttributes {
...CustomerSegmentContentAttributeFragment
}
scenarioContentAttributes {
...AbScenarioContentAttributeFragment
}
}
}
}
Variables
{"globalParameterInput": GlobalParameterInput}
Response
{
"data": {
"deprecated_parameter_saveOrUpdateGlobalParameters": [
{
"id": "4",
"version": {},
"name": "xyz789",
"inherited": true,
"mcs": Mcs,
"value": ContentAttribute
}
]
}
}
deprecated_search_saveOrUpdateAdaptiveSearchActivation
Description
Changes the global parameter describing if adaptive search is activated.
Response
Returns [GlobalParameterAttribute!]!
Arguments
| Name | Description |
|---|---|
parameter - GlobalParameterAttributeInput!
|
The new state of this global parameter. |
Example
Query
mutation Deprecated_search_saveOrUpdateAdaptiveSearchActivation($parameter: GlobalParameterAttributeInput!) {
deprecated_search_saveOrUpdateAdaptiveSearchActivation(parameter: $parameter) {
id
version
name
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
value {
id
version
status
stringList
integerValue
string
option {
...AttributeOptionFragment
}
link {
... on ArticleLink {
...ArticleLinkFragment
}
... on PageLink {
...PageLinkFragment
}
... on AssetLink {
...AssetLinkFragment
}
... on BrandLink {
...BrandLinkFragment
}
... on SearchTermLink {
...SearchTermLinkFragment
}
... on ExternalLink {
...ExternalLinkFragment
}
... on SEOTermLink {
...SEOTermLinkFragment
}
... on ContentTreeLink {
...ContentTreeLinkFragment
}
... on LayerLink {
...LayerLinkFragment
}
}
startDate
endDate
campaign {
...CampaignFragment
}
customerSegmented
abTested
customerSegmentContentAttributes {
...CustomerSegmentContentAttributeFragment
}
scenarioContentAttributes {
...AbScenarioContentAttributeFragment
}
}
}
}
Variables
{"parameter": GlobalParameterAttributeInput}
Response
{
"data": {
"deprecated_search_saveOrUpdateAdaptiveSearchActivation": [
{
"id": 4,
"version": {},
"name": "xyz789",
"inherited": true,
"mcs": Mcs,
"value": ContentAttribute
}
]
}
}
deprecated_search_saveOrUpdateAdaptiveSearchActivations
Description
Changes the global parameter describing if adaptive search is activated. Can change multiple parameters.
Response
Returns [GlobalParameterAttribute!]!
Arguments
| Name | Description |
|---|---|
parameters - [GlobalParameterAttributeInput!]!
|
A list of new states of this global parameter. |
Example
Query
mutation Deprecated_search_saveOrUpdateAdaptiveSearchActivations($parameters: [GlobalParameterAttributeInput!]!) {
deprecated_search_saveOrUpdateAdaptiveSearchActivations(parameters: $parameters) {
id
version
name
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
value {
id
version
status
stringList
integerValue
string
option {
...AttributeOptionFragment
}
link {
... on ArticleLink {
...ArticleLinkFragment
}
... on PageLink {
...PageLinkFragment
}
... on AssetLink {
...AssetLinkFragment
}
... on BrandLink {
...BrandLinkFragment
}
... on SearchTermLink {
...SearchTermLinkFragment
}
... on ExternalLink {
...ExternalLinkFragment
}
... on SEOTermLink {
...SEOTermLinkFragment
}
... on ContentTreeLink {
...ContentTreeLinkFragment
}
... on LayerLink {
...LayerLinkFragment
}
}
startDate
endDate
campaign {
...CampaignFragment
}
customerSegmented
abTested
customerSegmentContentAttributes {
...CustomerSegmentContentAttributeFragment
}
scenarioContentAttributes {
...AbScenarioContentAttributeFragment
}
}
}
}
Variables
{"parameters": [GlobalParameterAttributeInput]}
Response
{
"data": {
"deprecated_search_saveOrUpdateAdaptiveSearchActivations": [
{
"id": 4,
"version": {},
"name": "abc123",
"inherited": true,
"mcs": Mcs,
"value": ContentAttribute
}
]
}
}
deprecated_search_saveOrUpdateAdaptiveSearchKpi
Description
Changes the global parameter describing KPIs for the adaptive search.
Response
Returns [GlobalParameterAttribute!]!
Arguments
| Name | Description |
|---|---|
parameter - GlobalParameterAttributeInput!
|
The new state of this global parameter. |
Example
Query
mutation Deprecated_search_saveOrUpdateAdaptiveSearchKpi($parameter: GlobalParameterAttributeInput!) {
deprecated_search_saveOrUpdateAdaptiveSearchKpi(parameter: $parameter) {
id
version
name
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
value {
id
version
status
stringList
integerValue
string
option {
...AttributeOptionFragment
}
link {
... on ArticleLink {
...ArticleLinkFragment
}
... on PageLink {
...PageLinkFragment
}
... on AssetLink {
...AssetLinkFragment
}
... on BrandLink {
...BrandLinkFragment
}
... on SearchTermLink {
...SearchTermLinkFragment
}
... on ExternalLink {
...ExternalLinkFragment
}
... on SEOTermLink {
...SEOTermLinkFragment
}
... on ContentTreeLink {
...ContentTreeLinkFragment
}
... on LayerLink {
...LayerLinkFragment
}
}
startDate
endDate
campaign {
...CampaignFragment
}
customerSegmented
abTested
customerSegmentContentAttributes {
...CustomerSegmentContentAttributeFragment
}
scenarioContentAttributes {
...AbScenarioContentAttributeFragment
}
}
}
}
Variables
{"parameter": GlobalParameterAttributeInput}
Response
{
"data": {
"deprecated_search_saveOrUpdateAdaptiveSearchKpi": [
{
"id": "4",
"version": {},
"name": "xyz789",
"inherited": false,
"mcs": Mcs,
"value": ContentAttribute
}
]
}
}
deprecated_search_saveOrUpdateAdaptiveSearchKpis
Description
Changes the global parameter describing KPIs for the adaptive search. Can change multiple parameters
Response
Returns [GlobalParameterAttribute!]!
Arguments
| Name | Description |
|---|---|
parameters - [GlobalParameterAttributeInput!]!
|
A list of new states of this global parameter. |
Example
Query
mutation Deprecated_search_saveOrUpdateAdaptiveSearchKpis($parameters: [GlobalParameterAttributeInput!]!) {
deprecated_search_saveOrUpdateAdaptiveSearchKpis(parameters: $parameters) {
id
version
name
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
value {
id
version
status
stringList
integerValue
string
option {
...AttributeOptionFragment
}
link {
... on ArticleLink {
...ArticleLinkFragment
}
... on PageLink {
...PageLinkFragment
}
... on AssetLink {
...AssetLinkFragment
}
... on BrandLink {
...BrandLinkFragment
}
... on SearchTermLink {
...SearchTermLinkFragment
}
... on ExternalLink {
...ExternalLinkFragment
}
... on SEOTermLink {
...SEOTermLinkFragment
}
... on ContentTreeLink {
...ContentTreeLinkFragment
}
... on LayerLink {
...LayerLinkFragment
}
}
startDate
endDate
campaign {
...CampaignFragment
}
customerSegmented
abTested
customerSegmentContentAttributes {
...CustomerSegmentContentAttributeFragment
}
scenarioContentAttributes {
...AbScenarioContentAttributeFragment
}
}
}
}
Variables
{"parameters": [GlobalParameterAttributeInput]}
Response
{
"data": {
"deprecated_search_saveOrUpdateAdaptiveSearchKpis": [
{
"id": 4,
"version": {},
"name": "xyz789",
"inherited": false,
"mcs": Mcs,
"value": ContentAttribute
}
]
}
}
deprecated_search_saveOrUpdateAdaptiveSearchRatio
Description
Changes the global parameter describing the search ratio
Response
Returns [GlobalParameterAttribute!]!
Arguments
| Name | Description |
|---|---|
parameter - GlobalParameterAttributeInput!
|
The new state of this global parameter. |
Example
Query
mutation Deprecated_search_saveOrUpdateAdaptiveSearchRatio($parameter: GlobalParameterAttributeInput!) {
deprecated_search_saveOrUpdateAdaptiveSearchRatio(parameter: $parameter) {
id
version
name
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
value {
id
version
status
stringList
integerValue
string
option {
...AttributeOptionFragment
}
link {
... on ArticleLink {
...ArticleLinkFragment
}
... on PageLink {
...PageLinkFragment
}
... on AssetLink {
...AssetLinkFragment
}
... on BrandLink {
...BrandLinkFragment
}
... on SearchTermLink {
...SearchTermLinkFragment
}
... on ExternalLink {
...ExternalLinkFragment
}
... on SEOTermLink {
...SEOTermLinkFragment
}
... on ContentTreeLink {
...ContentTreeLinkFragment
}
... on LayerLink {
...LayerLinkFragment
}
}
startDate
endDate
campaign {
...CampaignFragment
}
customerSegmented
abTested
customerSegmentContentAttributes {
...CustomerSegmentContentAttributeFragment
}
scenarioContentAttributes {
...AbScenarioContentAttributeFragment
}
}
}
}
Variables
{"parameter": GlobalParameterAttributeInput}
Response
{
"data": {
"deprecated_search_saveOrUpdateAdaptiveSearchRatio": [
{
"id": 4,
"version": {},
"name": "xyz789",
"inherited": false,
"mcs": Mcs,
"value": ContentAttribute
}
]
}
}
deprecated_search_saveOrUpdateAdaptiveSearchRatios
Description
Changes the global parameter describing the search ratio. Can change multiple parameters.
Response
Returns [GlobalParameterAttribute!]!
Arguments
| Name | Description |
|---|---|
parameters - [GlobalParameterAttributeInput!]!
|
A list of new states of this global parameter. |
Example
Query
mutation Deprecated_search_saveOrUpdateAdaptiveSearchRatios($parameters: [GlobalParameterAttributeInput!]!) {
deprecated_search_saveOrUpdateAdaptiveSearchRatios(parameters: $parameters) {
id
version
name
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
value {
id
version
status
stringList
integerValue
string
option {
...AttributeOptionFragment
}
link {
... on ArticleLink {
...ArticleLinkFragment
}
... on PageLink {
...PageLinkFragment
}
... on AssetLink {
...AssetLinkFragment
}
... on BrandLink {
...BrandLinkFragment
}
... on SearchTermLink {
...SearchTermLinkFragment
}
... on ExternalLink {
...ExternalLinkFragment
}
... on SEOTermLink {
...SEOTermLinkFragment
}
... on ContentTreeLink {
...ContentTreeLinkFragment
}
... on LayerLink {
...LayerLinkFragment
}
}
startDate
endDate
campaign {
...CampaignFragment
}
customerSegmented
abTested
customerSegmentContentAttributes {
...CustomerSegmentContentAttributeFragment
}
scenarioContentAttributes {
...AbScenarioContentAttributeFragment
}
}
}
}
Variables
{"parameters": [GlobalParameterAttributeInput]}
Response
{
"data": {
"deprecated_search_saveOrUpdateAdaptiveSearchRatios": [
{
"id": "4",
"version": {},
"name": "abc123",
"inherited": true,
"mcs": Mcs,
"value": ContentAttribute
}
]
}
}
deprecated_search_saveOrUpdateSearchSuggestBlacklist
Description
Adds or changes a search suggest blacklist value.
Response
Returns a GlobalParameterAttribute!
Arguments
| Name | Description |
|---|---|
parameter - GlobalParameterAttributeInput!
|
A description of a specific global parameter attribute. |
Example
Query
mutation Deprecated_search_saveOrUpdateSearchSuggestBlacklist($parameter: GlobalParameterAttributeInput!) {
deprecated_search_saveOrUpdateSearchSuggestBlacklist(parameter: $parameter) {
id
version
name
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
value {
id
version
status
stringList
integerValue
string
option {
...AttributeOptionFragment
}
link {
... on ArticleLink {
...ArticleLinkFragment
}
... on PageLink {
...PageLinkFragment
}
... on AssetLink {
...AssetLinkFragment
}
... on BrandLink {
...BrandLinkFragment
}
... on SearchTermLink {
...SearchTermLinkFragment
}
... on ExternalLink {
...ExternalLinkFragment
}
... on SEOTermLink {
...SEOTermLinkFragment
}
... on ContentTreeLink {
...ContentTreeLinkFragment
}
... on LayerLink {
...LayerLinkFragment
}
}
startDate
endDate
campaign {
...CampaignFragment
}
customerSegmented
abTested
customerSegmentContentAttributes {
...CustomerSegmentContentAttributeFragment
}
scenarioContentAttributes {
...AbScenarioContentAttributeFragment
}
}
}
}
Variables
{"parameter": GlobalParameterAttributeInput}
Response
{
"data": {
"deprecated_search_saveOrUpdateSearchSuggestBlacklist": {
"id": 4,
"version": {},
"name": "abc123",
"inherited": false,
"mcs": Mcs,
"value": ContentAttribute
}
}
}
deprecated_search_saveOrUpdateSearchSuggestBlacklists
Description
Adds or changes multiple search suggest blacklist value.
Response
Returns [GlobalParameterAttribute!]!
Arguments
| Name | Description |
|---|---|
parameters - [GlobalParameterAttributeInput!]!
|
A list of descriptions of specific global parameter attributes. |
Example
Query
mutation Deprecated_search_saveOrUpdateSearchSuggestBlacklists($parameters: [GlobalParameterAttributeInput!]!) {
deprecated_search_saveOrUpdateSearchSuggestBlacklists(parameters: $parameters) {
id
version
name
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
value {
id
version
status
stringList
integerValue
string
option {
...AttributeOptionFragment
}
link {
... on ArticleLink {
...ArticleLinkFragment
}
... on PageLink {
...PageLinkFragment
}
... on AssetLink {
...AssetLinkFragment
}
... on BrandLink {
...BrandLinkFragment
}
... on SearchTermLink {
...SearchTermLinkFragment
}
... on ExternalLink {
...ExternalLinkFragment
}
... on SEOTermLink {
...SEOTermLinkFragment
}
... on ContentTreeLink {
...ContentTreeLinkFragment
}
... on LayerLink {
...LayerLinkFragment
}
}
startDate
endDate
campaign {
...CampaignFragment
}
customerSegmented
abTested
customerSegmentContentAttributes {
...CustomerSegmentContentAttributeFragment
}
scenarioContentAttributes {
...AbScenarioContentAttributeFragment
}
}
}
}
Variables
{"parameters": [GlobalParameterAttributeInput]}
Response
{
"data": {
"deprecated_search_saveOrUpdateSearchSuggestBlacklists": [
{
"id": "4",
"version": {},
"name": "abc123",
"inherited": false,
"mcs": Mcs,
"value": ContentAttribute
}
]
}
}
deprecated_search_saveOrUpdateSearchSuggestWhitelist
Description
Adds or changes a search suggest whitelist value.
Response
Returns a GlobalParameterAttribute!
Arguments
| Name | Description |
|---|---|
parameter - GlobalParameterAttributeInput!
|
A description of a specific global parameter attribute. |
Example
Query
mutation Deprecated_search_saveOrUpdateSearchSuggestWhitelist($parameter: GlobalParameterAttributeInput!) {
deprecated_search_saveOrUpdateSearchSuggestWhitelist(parameter: $parameter) {
id
version
name
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
value {
id
version
status
stringList
integerValue
string
option {
...AttributeOptionFragment
}
link {
... on ArticleLink {
...ArticleLinkFragment
}
... on PageLink {
...PageLinkFragment
}
... on AssetLink {
...AssetLinkFragment
}
... on BrandLink {
...BrandLinkFragment
}
... on SearchTermLink {
...SearchTermLinkFragment
}
... on ExternalLink {
...ExternalLinkFragment
}
... on SEOTermLink {
...SEOTermLinkFragment
}
... on ContentTreeLink {
...ContentTreeLinkFragment
}
... on LayerLink {
...LayerLinkFragment
}
}
startDate
endDate
campaign {
...CampaignFragment
}
customerSegmented
abTested
customerSegmentContentAttributes {
...CustomerSegmentContentAttributeFragment
}
scenarioContentAttributes {
...AbScenarioContentAttributeFragment
}
}
}
}
Variables
{"parameter": GlobalParameterAttributeInput}
Response
{
"data": {
"deprecated_search_saveOrUpdateSearchSuggestWhitelist": {
"id": "4",
"version": {},
"name": "xyz789",
"inherited": true,
"mcs": Mcs,
"value": ContentAttribute
}
}
}
deprecated_search_saveOrUpdateSearchSuggestWhitelists
Description
Adds or changes multiple search suggest whitelist value.
Response
Returns [GlobalParameterAttribute!]!
Arguments
| Name | Description |
|---|---|
parameters - [GlobalParameterAttributeInput!]!
|
A list of descriptions of specific global parameter attributes. |
Example
Query
mutation Deprecated_search_saveOrUpdateSearchSuggestWhitelists($parameters: [GlobalParameterAttributeInput!]!) {
deprecated_search_saveOrUpdateSearchSuggestWhitelists(parameters: $parameters) {
id
version
name
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
value {
id
version
status
stringList
integerValue
string
option {
...AttributeOptionFragment
}
link {
... on ArticleLink {
...ArticleLinkFragment
}
... on PageLink {
...PageLinkFragment
}
... on AssetLink {
...AssetLinkFragment
}
... on BrandLink {
...BrandLinkFragment
}
... on SearchTermLink {
...SearchTermLinkFragment
}
... on ExternalLink {
...ExternalLinkFragment
}
... on SEOTermLink {
...SEOTermLinkFragment
}
... on ContentTreeLink {
...ContentTreeLinkFragment
}
... on LayerLink {
...LayerLinkFragment
}
}
startDate
endDate
campaign {
...CampaignFragment
}
customerSegmented
abTested
customerSegmentContentAttributes {
...CustomerSegmentContentAttributeFragment
}
scenarioContentAttributes {
...AbScenarioContentAttributeFragment
}
}
}
}
Variables
{"parameters": [GlobalParameterAttributeInput]}
Response
{
"data": {
"deprecated_search_saveOrUpdateSearchSuggestWhitelists": [
{
"id": 4,
"version": {},
"name": "xyz789",
"inherited": false,
"mcs": Mcs,
"value": ContentAttribute
}
]
}
}
echo
Description
A simple mutation for testing purposes only
marketing_copyArticleListScore
Response
Returns an ArticleListScoreCopyPayload!
Arguments
| Name | Description |
|---|---|
input - [CopyArticleListScoreInput!]!
|
Example
Query
mutation Marketing_copyArticleListScore($input: [CopyArticleListScoreInput!]!) {
marketing_copyArticleListScore(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
isInherited
articleListScoreCards {
... on ArticleListScoreCardDirectValue {
...ArticleListScoreCardDirectValueFragment
}
... on ArticleListScoreCardBoolean {
...ArticleListScoreCardBooleanFragment
}
... on ArticleListScoreCardCategory {
...ArticleListScoreCardCategoryFragment
}
... on ArticleListScoreCardBrand {
...ArticleListScoreCardBrandFragment
}
... on ArticleListScoreCardDouble {
...ArticleListScoreCardDoubleFragment
}
... on ArticleListScoreCardInt {
...ArticleListScoreCardIntFragment
}
... on ArticleListScoreCardString {
...ArticleListScoreCardStringFragment
}
}
references {
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on LegacyContentReference {
...LegacyContentReferenceFragment
}
}
}
}
}
Variables
{"input": [CopyArticleListScoreInput]}
Response
{
"data": {
"marketing_copyArticleListScore": {
"entries": [ArticleListScore]
}
}
}
marketing_createArticleListScore
Response
Returns an ArticleListScoreCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateArticleListScoreInput!]!
|
Example
Query
mutation Marketing_createArticleListScore($input: [CreateArticleListScoreInput!]!) {
marketing_createArticleListScore(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
isInherited
articleListScoreCards {
... on ArticleListScoreCardDirectValue {
...ArticleListScoreCardDirectValueFragment
}
... on ArticleListScoreCardBoolean {
...ArticleListScoreCardBooleanFragment
}
... on ArticleListScoreCardCategory {
...ArticleListScoreCardCategoryFragment
}
... on ArticleListScoreCardBrand {
...ArticleListScoreCardBrandFragment
}
... on ArticleListScoreCardDouble {
...ArticleListScoreCardDoubleFragment
}
... on ArticleListScoreCardInt {
...ArticleListScoreCardIntFragment
}
... on ArticleListScoreCardString {
...ArticleListScoreCardStringFragment
}
}
references {
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on LegacyContentReference {
...LegacyContentReferenceFragment
}
}
}
}
}
Variables
{"input": [CreateArticleListScoreInput]}
Response
{
"data": {
"marketing_createArticleListScore": {
"entries": [ArticleListScore]
}
}
}
marketing_deleteArticleListScore
Response
Returns an ArticleListScoreDeletePayload!
Arguments
| Name | Description |
|---|---|
ids - [EntityId!]!
|
Example
Query
mutation Marketing_deleteArticleListScore($ids: [EntityId!]!) {
marketing_deleteArticleListScore(ids: $ids) {
successful
}
}
Variables
{"ids": [EntityId]}
Response
{"data": {"marketing_deleteArticleListScore": {"successful": true}}}
marketing_updateArticleListScore
Response
Returns an ArticleListScoreUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateArticleListScoreInput!]!
|
Example
Query
mutation Marketing_updateArticleListScore($input: [UpdateArticleListScoreInput!]!) {
marketing_updateArticleListScore(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
isInherited
articleListScoreCards {
... on ArticleListScoreCardDirectValue {
...ArticleListScoreCardDirectValueFragment
}
... on ArticleListScoreCardBoolean {
...ArticleListScoreCardBooleanFragment
}
... on ArticleListScoreCardCategory {
...ArticleListScoreCardCategoryFragment
}
... on ArticleListScoreCardBrand {
...ArticleListScoreCardBrandFragment
}
... on ArticleListScoreCardDouble {
...ArticleListScoreCardDoubleFragment
}
... on ArticleListScoreCardInt {
...ArticleListScoreCardIntFragment
}
... on ArticleListScoreCardString {
...ArticleListScoreCardStringFragment
}
}
references {
... on CategoryParameter {
...CategoryParameterFragment
}
... on PageParameter {
...PageParameterFragment
}
... on GlobalParameter_2 {
...GlobalParameter_2Fragment
}
... on ContentTreeParameter {
...ContentTreeParameterFragment
}
... on LegacyContentReference {
...LegacyContentReferenceFragment
}
}
}
}
}
Variables
{"input": [UpdateArticleListScoreInput]}
Response
{
"data": {
"marketing_updateArticleListScore": {
"entries": [ArticleListScore]
}
}
}
metadata_updateParameterTypes
Response
Returns an AttributeTypeUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateParameterTypesInput!]!
|
Example
Query
mutation Metadata_updateParameterTypes($input: [UpdateParameterTypesInput!]!) {
metadata_updateParameterTypes(input: $input) {
entries {
id
version
key
displayName
group {
...AttributeDefinitionGroupFragment
}
abTestable
customerSegmentsAllowed
exportable
linkable
standard
mandatory
helpText
hasHelpText
mutationCommandType
allowedValues {
...AllowedValueFragment
}
searchable
valueType
}
}
}
Variables
{"input": [UpdateParameterTypesInput]}
Response
{
"data": {
"metadata_updateParameterTypes": {
"entries": [AttributeDescriptionType]
}
}
}
parameter_copyBrandParameter
Description
Copy brand parameter
Response
Returns a BrandParameterCopyPayload!
Arguments
| Name | Description |
|---|---|
input - [CopyBrandParameterInput!]!
|
Example
Query
mutation Parameter_copyBrandParameter($input: [CopyBrandParameterInput!]!) {
parameter_copyBrandParameter(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
brand {
...BrandEntityFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
inherited
parameterType {
...AttributeDescriptionTypeFragment
}
attributeName
attributeValue {
...DynamicAttributeValueFragment
}
description
overwrites {
...BrandParameterFragment
}
}
}
}
Variables
{"input": [CopyBrandParameterInput]}
Response
{
"data": {
"parameter_copyBrandParameter": {
"entries": [BrandParameter]
}
}
}
parameter_copyCategoryParameter
Response
Returns a CategoryParameterAttributeCopyPayload!
Arguments
| Name | Description |
|---|---|
input - [CopyCategoryParameterInput!]!
|
Example
Query
mutation Parameter_copyCategoryParameter($input: [CopyCategoryParameterInput!]!) {
parameter_copyCategoryParameter(input: $input) {
entries {
id
version
category {
...GraphQlCategoryFragment
}
categoryTreeEntry {
...CategoryTreeEntryFragment
}
mcs {
...McsFragment
}
inherited
overwrites {
...CategoryParameterFragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeValue {
...DynamicAttributeValueFragment
}
linkedToCategories {
...CategoryParameterLinkTargetsFragment
}
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
}
}
Variables
{"input": [CopyCategoryParameterInput]}
Response
{
"data": {
"parameter_copyCategoryParameter": {
"entries": [CategoryParameter]
}
}
}
parameter_copyContentTreeParameter
Response
Arguments
| Name | Description |
|---|---|
input - [CopyContentTreeParameterInput!]!
|
Example
Query
mutation Parameter_copyContentTreeParameter($input: [CopyContentTreeParameterInput!]!) {
parameter_copyContentTreeParameter(input: $input) {
entries {
id
version
contentPage {
...CuratedPageFragment
}
page {
...PageFragment
}
mcs {
...McsFragment
}
inherited
overwrites {
...PageParameterFragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeValue {
...DynamicAttributeValueFragment
}
linkTo {
...ContentParameterLinkTargetsFragment
}
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
pageType
}
}
}
Variables
{"input": [CopyContentTreeParameterInput]}
Response
{
"data": {
"parameter_copyContentTreeParameter": {
"entries": [ContentTreeParameter]
}
}
}
parameter_copyGlobalParameter2
Description
Copy existing parameter with all it data and updates the copied parameter with the given operations
Response
Returns a GlobalParameterCopyPayload!
Arguments
| Name | Description |
|---|---|
input - [CopyGlobalParameterInput!]!
|
Example
Query
mutation Parameter_copyGlobalParameter2($input: [CopyGlobalParameterInput!]!) {
parameter_copyGlobalParameter2(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
inherited
overwrites {
...GlobalParameter_2Fragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeName
attributeValue {
...DynamicAttributeValueFragment
}
description
}
}
}
Variables
{"input": [CopyGlobalParameterInput]}
Response
{
"data": {
"parameter_copyGlobalParameter2": {
"entries": [GlobalParameter_2]
}
}
}
parameter_copyPageParameter
Response
Returns a PageParameterAttributeCopyPayload!
Arguments
| Name | Description |
|---|---|
input - [CopyPageParameterInput!]!
|
Example
Query
mutation Parameter_copyPageParameter($input: [CopyPageParameterInput!]!) {
parameter_copyPageParameter(input: $input) {
entries {
id
version
page {
...PageFragment
}
mcs {
...McsFragment
}
inherited
overwrites {
...PageParameterFragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeValue {
...DynamicAttributeValueFragment
}
linkTo {
...PageParameterLinkTargetsFragment
}
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
pageType
}
}
}
Variables
{"input": [CopyPageParameterInput]}
Response
{
"data": {
"parameter_copyPageParameter": {
"entries": [PageParameter]
}
}
}
parameter_createBrandParameter
Description
Create brand parameter
Response
Returns a BrandParameterCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateBrandParameterInput!]!
|
Example
Query
mutation Parameter_createBrandParameter($input: [CreateBrandParameterInput!]!) {
parameter_createBrandParameter(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
brand {
...BrandEntityFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
inherited
parameterType {
...AttributeDescriptionTypeFragment
}
attributeName
attributeValue {
...DynamicAttributeValueFragment
}
description
overwrites {
...BrandParameterFragment
}
}
}
}
Variables
{"input": [CreateBrandParameterInput]}
Response
{
"data": {
"parameter_createBrandParameter": {
"entries": [BrandParameter]
}
}
}
parameter_createCategoryParameter
Response
Arguments
| Name | Description |
|---|---|
input - [CreateCategoryParameterAttributeInput!]!
|
Example
Query
mutation Parameter_createCategoryParameter($input: [CreateCategoryParameterAttributeInput!]!) {
parameter_createCategoryParameter(input: $input) {
entries {
id
version
category {
...GraphQlCategoryFragment
}
categoryTreeEntry {
...CategoryTreeEntryFragment
}
mcs {
...McsFragment
}
inherited
overwrites {
...CategoryParameterFragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeValue {
...DynamicAttributeValueFragment
}
linkedToCategories {
...CategoryParameterLinkTargetsFragment
}
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
}
}
Variables
{"input": [CreateCategoryParameterAttributeInput]}
Response
{
"data": {
"parameter_createCategoryParameter": [
{"entries": [CategoryParameter]}
]
}
}
parameter_createContentTreeParameter
Response
Arguments
| Name | Description |
|---|---|
input - [CreateContentTreeParameterAttributeInput!]!
|
Example
Query
mutation Parameter_createContentTreeParameter($input: [CreateContentTreeParameterAttributeInput!]!) {
parameter_createContentTreeParameter(input: $input) {
entries {
id
version
contentPage {
...CuratedPageFragment
}
page {
...PageFragment
}
mcs {
...McsFragment
}
inherited
overwrites {
...PageParameterFragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeValue {
...DynamicAttributeValueFragment
}
linkTo {
...ContentParameterLinkTargetsFragment
}
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
pageType
}
}
}
Variables
{"input": [CreateContentTreeParameterAttributeInput]}
Response
{
"data": {
"parameter_createContentTreeParameter": {
"entries": [ContentTreeParameter]
}
}
}
parameter_createGlobalParameter2
Response
Returns a GlobalParameterCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateGlobalParameterInput!]!
|
Example
Query
mutation Parameter_createGlobalParameter2($input: [CreateGlobalParameterInput!]!) {
parameter_createGlobalParameter2(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
inherited
overwrites {
...GlobalParameter_2Fragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeName
attributeValue {
...DynamicAttributeValueFragment
}
description
}
}
}
Variables
{"input": [CreateGlobalParameterInput]}
Response
{
"data": {
"parameter_createGlobalParameter2": {
"entries": [GlobalParameter_2]
}
}
}
parameter_createPageParameter
Response
Arguments
| Name | Description |
|---|---|
input - [CreatePageParameterAttributeInput!]!
|
Example
Query
mutation Parameter_createPageParameter($input: [CreatePageParameterAttributeInput!]!) {
parameter_createPageParameter(input: $input) {
entries {
id
version
page {
...PageFragment
}
mcs {
...McsFragment
}
inherited
overwrites {
...PageParameterFragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeValue {
...DynamicAttributeValueFragment
}
linkTo {
...PageParameterLinkTargetsFragment
}
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
pageType
}
}
}
Variables
{"input": [CreatePageParameterAttributeInput]}
Response
{
"data": {
"parameter_createPageParameter": [
{"entries": [PageParameter]}
]
}
}
parameter_deleteBrandParameter
Description
Remove brand parameter
Response
Returns a BrandParameterDeletePayload!
Arguments
| Name | Description |
|---|---|
id - [EntityId!]!
|
Example
Query
mutation Parameter_deleteBrandParameter($id: [EntityId!]!) {
parameter_deleteBrandParameter(id: $id) {
successful
}
}
Variables
{"id": [EntityId]}
Response
{"data": {"parameter_deleteBrandParameter": {"successful": false}}}
parameter_deleteCategoryParameter
Response
Returns a CategoryParameterAttributeDeletePayload!
Arguments
| Name | Description |
|---|---|
id - [EntityId!]!
|
Example
Query
mutation Parameter_deleteCategoryParameter($id: [EntityId!]!) {
parameter_deleteCategoryParameter(id: $id) {
successful
}
}
Variables
{"id": [EntityId]}
Response
{"data": {"parameter_deleteCategoryParameter": {"successful": false}}}
parameter_deleteContentTreeParameter
Response
Arguments
| Name | Description |
|---|---|
id - [EntityId!]!
|
Example
Query
mutation Parameter_deleteContentTreeParameter($id: [EntityId!]!) {
parameter_deleteContentTreeParameter(id: $id) {
successful
}
}
Variables
{"id": [EntityId]}
Response
{"data": {"parameter_deleteContentTreeParameter": {"successful": false}}}
parameter_deleteGlobalParameter2
Response
Returns a GlobalParameterDeletePayload!
Arguments
| Name | Description |
|---|---|
id - [EntityId!]!
|
Example
Query
mutation Parameter_deleteGlobalParameter2($id: [EntityId!]!) {
parameter_deleteGlobalParameter2(id: $id) {
successful
}
}
Variables
{"id": [EntityId]}
Response
{"data": {"parameter_deleteGlobalParameter2": {"successful": false}}}
parameter_deletePageParameter
Response
Returns a PageParameterAttributeDeletePayload!
Arguments
| Name | Description |
|---|---|
id - [EntityId!]!
|
Example
Query
mutation Parameter_deletePageParameter($id: [EntityId!]!) {
parameter_deletePageParameter(id: $id) {
successful
}
}
Variables
{"id": [EntityId]}
Response
{"data": {"parameter_deletePageParameter": {"successful": true}}}
parameter_updateBrandParameter
Description
Update brand parameter
Response
Returns a BrandParameterUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateBrandParameterInput!]!
|
Example
Query
mutation Parameter_updateBrandParameter($input: [UpdateBrandParameterInput!]!) {
parameter_updateBrandParameter(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
brand {
...BrandEntityFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
inherited
parameterType {
...AttributeDescriptionTypeFragment
}
attributeName
attributeValue {
...DynamicAttributeValueFragment
}
description
overwrites {
...BrandParameterFragment
}
}
}
}
Variables
{"input": [UpdateBrandParameterInput]}
Response
{
"data": {
"parameter_updateBrandParameter": {
"entries": [BrandParameter]
}
}
}
parameter_updateCategoryParameter
Response
Arguments
| Name | Description |
|---|---|
input - [UpdateCategoryParameterAttributeInput!]!
|
Example
Query
mutation Parameter_updateCategoryParameter($input: [UpdateCategoryParameterAttributeInput!]!) {
parameter_updateCategoryParameter(input: $input) {
entries {
id
version
category {
...GraphQlCategoryFragment
}
categoryTreeEntry {
...CategoryTreeEntryFragment
}
mcs {
...McsFragment
}
inherited
overwrites {
...CategoryParameterFragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeValue {
...DynamicAttributeValueFragment
}
linkedToCategories {
...CategoryParameterLinkTargetsFragment
}
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
}
}
Variables
{"input": [UpdateCategoryParameterAttributeInput]}
Response
{
"data": {
"parameter_updateCategoryParameter": [
{"entries": [CategoryParameter]}
]
}
}
parameter_updateContentTreeParameter
Response
Arguments
| Name | Description |
|---|---|
input - [UpdateContentTreeParameterAttributeInput!]!
|
Example
Query
mutation Parameter_updateContentTreeParameter($input: [UpdateContentTreeParameterAttributeInput!]!) {
parameter_updateContentTreeParameter(input: $input) {
entries {
id
version
contentPage {
...CuratedPageFragment
}
page {
...PageFragment
}
mcs {
...McsFragment
}
inherited
overwrites {
...PageParameterFragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeValue {
...DynamicAttributeValueFragment
}
linkTo {
...ContentParameterLinkTargetsFragment
}
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
pageType
}
}
}
Variables
{"input": [UpdateContentTreeParameterAttributeInput]}
Response
{
"data": {
"parameter_updateContentTreeParameter": {
"entries": [ContentTreeParameter]
}
}
}
parameter_updateGlobalParameter2
Response
Returns a GlobalParameterUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateGlobalParameterInput!]!
|
Example
Query
mutation Parameter_updateGlobalParameter2($input: [UpdateGlobalParameterInput!]!) {
parameter_updateGlobalParameter2(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
inherited
overwrites {
...GlobalParameter_2Fragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeName
attributeValue {
...DynamicAttributeValueFragment
}
description
}
}
}
Variables
{"input": [UpdateGlobalParameterInput]}
Response
{
"data": {
"parameter_updateGlobalParameter2": {
"entries": [GlobalParameter_2]
}
}
}
parameter_updatePageParameter
Response
Arguments
| Name | Description |
|---|---|
input - [UpdatePageParameterAttributeInput!]!
|
Example
Query
mutation Parameter_updatePageParameter($input: [UpdatePageParameterAttributeInput!]!) {
parameter_updatePageParameter(input: $input) {
entries {
id
version
page {
...PageFragment
}
mcs {
...McsFragment
}
inherited
overwrites {
...PageParameterFragment
}
parameterType {
...AttributeDescriptionTypeFragment
}
attributeValue {
...DynamicAttributeValueFragment
}
linkTo {
...PageParameterLinkTargetsFragment
}
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
pageType
}
}
}
Variables
{"input": [UpdatePageParameterAttributeInput]}
Response
{
"data": {
"parameter_updatePageParameter": [
{"entries": [PageParameter]}
]
}
}
personalization_updateCustomerSegmentGroup
Description
Update existing customer segment group
Response
Returns a CustomerSegmentGroupUpdatePayload
Arguments
| Name | Description |
|---|---|
input - [UpdateGroupInput!]!
|
Example
Query
mutation Personalization_updateCustomerSegmentGroup($input: [UpdateGroupInput!]!) {
personalization_updateCustomerSegmentGroup(input: $input) {
entries {
id
version
name
mcs {
...McsFragment
}
segments {
...CustomerSegmentFragment
}
priority
dynamic
}
}
}
Variables
{"input": [UpdateGroupInput]}
Response
{
"data": {
"personalization_updateCustomerSegmentGroup": {
"entries": [CustomerSegmentGroup]
}
}
}
promotions_createPromotions
Description
Create new promotion
Response
Returns a PromotionsCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreatePromotionInput!]!
|
Example
Query
mutation Promotions_createPromotions($input: [CreatePromotionInput!]!) {
promotions_createPromotions(input: $input) {
entries {
id
version
name
mcs {
...McsFragment
}
description
status
type
brokenInheritanceFrom
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
timeValidity {
... on Campaign {
...CampaignFragment
}
... on DateRange {
...DateRangeFragment
}
}
activeStatus
activeForMCS {
...McsFragment
}
conditions {
...ComplexConditionFragment
}
benefits {
...BenefitEntityFragment
}
benefitsSummaries
metaData
}
}
}
Variables
{"input": [CreatePromotionInput]}
Response
{
"data": {
"promotions_createPromotions": {
"entries": [PromotionEntity]
}
}
}
promotions_deletePromotions
Description
Delete existing promotion
Response
Returns a PromotionsDeletePayload!
Arguments
| Name | Description |
|---|---|
id - [EntityId!]!
|
Example
Query
mutation Promotions_deletePromotions($id: [EntityId!]!) {
promotions_deletePromotions(id: $id) {
successful
}
}
Variables
{"id": [EntityId]}
Response
{"data": {"promotions_deletePromotions": {"successful": false}}}
promotions_updatePromotions
Description
Update existing promotion
Response
Returns a PromotionsUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdatePromotionInput!]!
|
Example
Query
mutation Promotions_updatePromotions($input: [UpdatePromotionInput!]!) {
promotions_updatePromotions(input: $input) {
entries {
id
version
name
mcs {
...McsFragment
}
description
status
type
brokenInheritanceFrom
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
timeValidity {
... on Campaign {
...CampaignFragment
}
... on DateRange {
...DateRangeFragment
}
}
activeStatus
activeForMCS {
...McsFragment
}
conditions {
...ComplexConditionFragment
}
benefits {
...BenefitEntityFragment
}
benefitsSummaries
metaData
}
}
}
Variables
{"input": [UpdatePromotionInput]}
Response
{
"data": {
"promotions_updatePromotions": {
"entries": [PromotionEntity]
}
}
}
reporting_deleteSearchTerm
Description
Used when setting the search engine index to false.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
searchTermInput - SearchTermInput
|
A searchterm and MCS information. |
Example
Query
mutation Reporting_deleteSearchTerm($searchTermInput: SearchTermInput) {
reporting_deleteSearchTerm(searchTermInput: $searchTermInput)
}
Variables
{"searchTermInput": SearchTermInput}
Response
{"data": {"reporting_deleteSearchTerm": true}}
reporting_saveSearchTerm
Description
Used when setting the search engine index to true.
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
searchTermInput - SearchTermInput
|
A searchterm and MCS information. |
Example
Query
mutation Reporting_saveSearchTerm($searchTermInput: SearchTermInput) {
reporting_saveSearchTerm(searchTermInput: $searchTermInput)
}
Variables
{"searchTermInput": SearchTermInput}
Response
{"data": {"reporting_saveSearchTerm": false}}
role_createRole
Description
Create roles with menu/group user rights (roles with translation or special rights cannot be created)
Response
Returns a RoleCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateRoleInput!]!
|
Operations to create role |
Example
Query
mutation Role_createRole($input: [CreateRoleInput!]!) {
role_createRole(input: $input) {
entries {
id
version
name
roleRights {
...RoleRightEntityFragment
}
numberOfUsers
hasSpecialRightsOnly
description
isAdmin
}
}
}
Variables
{"input": [CreateRoleInput]}
Response
{"data": {"role_createRole": {"entries": [RoleEntity]}}}
role_deleteRole
Description
Delete roles with menu/group user rights
Response
Returns a RoleDeletePayload!
Arguments
| Name | Description |
|---|---|
ids - [EntityId!]!
|
Ids of roles to delete |
Example
Query
mutation Role_deleteRole($ids: [EntityId!]!) {
role_deleteRole(ids: $ids) {
successful
}
}
Variables
{"ids": [EntityId]}
Response
{"data": {"role_deleteRole": {"successful": false}}}
role_updateRole
Description
Update roles with menu/group user rights
Response
Returns a RoleUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateRoleInput!]!
|
Operations to update role |
Example
Query
mutation Role_updateRole($input: [UpdateRoleInput!]!) {
role_updateRole(input: $input) {
entries {
id
version
name
roleRights {
...RoleRightEntityFragment
}
numberOfUsers
hasSpecialRightsOnly
description
isAdmin
}
}
}
Variables
{"input": [UpdateRoleInput]}
Response
{"data": {"role_updateRole": {"entries": [RoleEntity]}}}
search_copySearchIndexScenario
Description
Copy existing scenario with all it data and updates the copied scenario with the given operations
Response
Returns a SearchIndexScenarioCopyPayload!
Arguments
| Name | Description |
|---|---|
input - [CopySearchIndexScenarioInput!]!
|
Example
Query
mutation Search_copySearchIndexScenario($input: [CopySearchIndexScenarioInput!]!) {
search_copySearchIndexScenario(input: $input) {
entries {
id
version
audit {
...AuditFragment
}
mcs {
...McsFragment
}
name
factor
trackingCode
attributeCount
attributes {
...SearchIndexScenarioAttribute_2Fragment
}
}
}
}
Variables
{"input": [CopySearchIndexScenarioInput]}
Response
{
"data": {
"search_copySearchIndexScenario": {
"entries": [SearchIndexScenario_2]
}
}
}
search_createExclusion
Description
Creates a new search exclusion.
Response
Returns a SearchExclusionCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateSearchExclusionInput!]!
|
All relevant information needed to create the search exclusion. |
Example
Query
mutation Search_createExclusion($input: [CreateSearchExclusionInput!]!) {
search_createExclusion(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
type
name
searchTerms
countArticles
articles {
...ArticleFragment
}
categories {
...CategoryTreeFragment
}
categoryTreeEntries {
...LinkToCategoryTreeEntryFragment
}
inheritanceEnabled
inheritedValue {
...SearchExclusionFragment
}
}
}
}
Variables
{"input": [CreateSearchExclusionInput]}
Response
{
"data": {
"search_createExclusion": {
"entries": [SearchExclusion]
}
}
}
search_createIndexAttribute
Description
Creates a new indexed attribute.
Response
Returns a SearchIndexScenarioAttribute!
Arguments
| Name | Description |
|---|---|
input - ScenarioAttributeInput!
|
All information needed to create a new indexed attribute. |
Example
Query
mutation Search_createIndexAttribute($input: ScenarioAttributeInput!) {
search_createIndexAttribute(input: $input) {
id
version
weight
name
level
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
isInherited
updated
created
}
}
Variables
{"input": ScenarioAttributeInput}
Response
{
"data": {
"search_createIndexAttribute": {
"id": "4",
"version": {},
"weight": 987.65,
"name": "xyz789",
"level": "Product",
"mcs": Mcs,
"isInherited": true,
"updated": "2007-12-03T10:15:30Z",
"created": "2007-12-03T10:15:30Z"
}
}
}
search_createIndexingScenario
Description
Create new scenario which we will add attributes later to it
Response
Returns a SearchIndexingScenario!
Arguments
| Name | Description |
|---|---|
input - SearchIndexingScenarioInput!
|
The scenario to create. |
Example
Query
mutation Search_createIndexingScenario($input: SearchIndexingScenarioInput!) {
search_createIndexingScenario(input: $input) {
id
version
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
name
isInherited
factor
trackingCode
}
}
Variables
{"input": SearchIndexingScenarioInput}
Response
{
"data": {
"search_createIndexingScenario": {
"id": {},
"version": {},
"mcs": Mcs,
"name": "xyz789",
"isInherited": false,
"factor": 123,
"trackingCode": "abc123"
}
}
}
search_createLemma
Description
Creates a new lemma/new lemmata
Response
Returns a LemmaCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateLemmaInput!]!
|
All relevant information needed to create the lemma/lemmata. |
Example
Query
mutation Search_createLemma($input: [CreateLemmaInput!]!) {
search_createLemma(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
searchTerms
wordStem
isInherited
}
}
}
Variables
{"input": [CreateLemmaInput]}
Response
{"data": {"search_createLemma": {"entries": [Lemma]}}}
search_createSearchIndexScenario
Description
Create new scenario which we will add attributes later to it
Response
Returns a SearchIndexScenarioCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateSearchIndexScenarioInput!]!
|
The scenario to create. |
Example
Query
mutation Search_createSearchIndexScenario($input: [CreateSearchIndexScenarioInput!]!) {
search_createSearchIndexScenario(input: $input) {
entries {
id
version
audit {
...AuditFragment
}
mcs {
...McsFragment
}
name
factor
trackingCode
attributeCount
attributes {
...SearchIndexScenarioAttribute_2Fragment
}
}
}
}
Variables
{"input": [CreateSearchIndexScenarioInput]}
Response
{
"data": {
"search_createSearchIndexScenario": {
"entries": [SearchIndexScenario_2]
}
}
}
search_createSearchTermGroup2
Description
Creates a new search term group.
Response
Returns a SearchTermGroupCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateSearchTermGroupInput!]!
|
All relevant information needed to create the search exclusion. |
Example
Query
mutation Search_createSearchTermGroup2($input: [CreateSearchTermGroupInput!]!) {
search_createSearchTermGroup2(input: $input) {
entries {
id
version
name
valid
isExact
mcs {
...McsFragment
}
searchTerms
isInherited
referenceType
}
}
}
Variables
{"input": [CreateSearchTermGroupInput]}
Response
{
"data": {
"search_createSearchTermGroup2": {
"entries": [SearchTermGroup]
}
}
}
search_createSuggestAttribute
Description
Add an existing attribte to search suggest index. Careful: Rebuilds search index!
Response
Returns a SearchIndexableAttribute!
Arguments
| Name | Description |
|---|---|
input - SearchSuggestAttributeInput!
|
Information about the attribute to add. |
Example
Query
mutation Search_createSuggestAttribute($input: SearchSuggestAttributeInput!) {
search_createSuggestAttribute(input: $input) {
attribute
level
selected
}
}
Variables
{"input": SearchSuggestAttributeInput}
Response
{
"data": {
"search_createSuggestAttribute": {
"attribute": "xyz789",
"level": "Product",
"selected": true
}
}
}
search_deleteBandwidth
Description
Deletes the bandwidth value for given MCS.
Response
Returns a BandwidthInfo!
Example
Query
mutation Search_deleteBandwidth {
search_deleteBandwidth {
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
bandwidthValue
fallbackValue {
mcs {
...McsFragment
}
bandwidthValue
fallbackValue {
...BandwidthInfoFragment
}
isInherited
}
isInherited
}
}
Response
{
"data": {
"search_deleteBandwidth": {
"mcs": Mcs,
"bandwidthValue": 987,
"fallbackValue": BandwidthInfo,
"isInherited": true
}
}
}
search_deleteExclusion
Description
Deletes an existing search exclusion.
Response
Returns a SearchExclusionDeletePayload!
Arguments
| Name | Description |
|---|---|
ids - [EntityId!]!
|
the ID of the search exclusion to delete. |
Example
Query
mutation Search_deleteExclusion($ids: [EntityId!]!) {
search_deleteExclusion(ids: $ids) {
successful
}
}
Variables
{"ids": [EntityId]}
Response
{"data": {"search_deleteExclusion": {"successful": false}}}
search_deleteIndexAttribute
Description
Deletes an existing indexed attribute.
Response
Returns a Boolean!
Example
Query
mutation Search_deleteIndexAttribute(
$id: ID!,
$version: Long!
) {
search_deleteIndexAttribute(
id: $id,
version: $version
)
}
Variables
{"id": "4", "version": {}}
Response
{"data": {"search_deleteIndexAttribute": true}}
search_deleteIndexingScenario
Description
Delete already existing scenario.
Response
Returns a Boolean!
Example
Query
mutation Search_deleteIndexingScenario(
$id: Long!,
$version: Long!
) {
search_deleteIndexingScenario(
id: $id,
version: $version
)
}
Variables
{"id": {}, "version": {}}
Response
{"data": {"search_deleteIndexingScenario": false}}
search_deleteLemma
Response
Returns a LemmaDeletePayload!
Arguments
| Name | Description |
|---|---|
ids - [EntityId!]!
|
the ID of the lemma/lemmata to delete. |
Example
Query
mutation Search_deleteLemma($ids: [EntityId!]!) {
search_deleteLemma(ids: $ids) {
successful
}
}
Variables
{"ids": [EntityId]}
Response
{"data": {"search_deleteLemma": {"successful": true}}}
search_deleteSearchIndexScenario
Description
Delete already existing scenario.
Response
Returns a SearchIndexScenarioDeletePayload!
Arguments
| Name | Description |
|---|---|
ids - [EntityId!]!
|
The ID of the scenario to delete. |
Example
Query
mutation Search_deleteSearchIndexScenario($ids: [EntityId!]!) {
search_deleteSearchIndexScenario(ids: $ids) {
successful
}
}
Variables
{"ids": [EntityId]}
Response
{"data": {"search_deleteSearchIndexScenario": {"successful": true}}}
search_deleteSearchTermGroup
Description
Delete search term group
search_deleteSearchTermGroup2
Description
Deletes an existing search term group.
Response
Returns a SearchTermGroupDeletePayload!
Arguments
| Name | Description |
|---|---|
ids - [EntityId!]!
|
the ID of the search exclusion to delete. |
Example
Query
mutation Search_deleteSearchTermGroup2($ids: [EntityId!]!) {
search_deleteSearchTermGroup2(ids: $ids) {
successful
}
}
Variables
{"ids": [EntityId]}
Response
{"data": {"search_deleteSearchTermGroup2": {"successful": true}}}
search_deleteSuggestAttribute
Description
Remove an indexed attribute from Search sggest index. Careful: Rebuilds search index!
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - SearchSuggestAttributeInput!
|
Information about the attribute to add. |
Example
Query
mutation Search_deleteSuggestAttribute($input: SearchSuggestAttributeInput!) {
search_deleteSuggestAttribute(input: $input)
}
Variables
{"input": SearchSuggestAttributeInput}
Response
{"data": {"search_deleteSuggestAttribute": false}}
search_deleteSynonymGroup
Description
Deletes a group of synonyms or antonyms by its ID.
Response
Returns a Synonym!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The ID of the synonym or antonym group to delete. |
Example
Query
mutation Search_deleteSynonymGroup($id: ID!) {
search_deleteSynonymGroup(id: $id) {
id
version
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
synonymGroups {
id
version
mcs {
...McsFragment
}
overridden
direction
weight
fromSynonyms
toSynonyms
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"search_deleteSynonymGroup": {
"id": "4",
"version": {},
"inherited": true,
"mcs": Mcs,
"synonymGroups": [SynonymGroup]
}
}
}
search_deleteSynonymGroups
Description
Deletes groups of synonyms or antonyms by its ID.
Response
Returns [Synonym!]!
Arguments
| Name | Description |
|---|---|
ids - [ID!]!
|
A list of IDs of the synonym or antonym groups to delete. |
Example
Query
mutation Search_deleteSynonymGroups($ids: [ID!]!) {
search_deleteSynonymGroups(ids: $ids) {
id
version
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
synonymGroups {
id
version
mcs {
...McsFragment
}
overridden
direction
weight
fromSynonyms
toSynonyms
}
}
}
Variables
{"ids": ["4"]}
Response
{
"data": {
"search_deleteSynonymGroups": [
{
"id": 4,
"version": {},
"inherited": true,
"mcs": Mcs,
"synonymGroups": [SynonymGroup]
}
]
}
}
search_removeAntiHeroMarker
Description
Remove a antihero article for a specific search. Alternatively, if the searchTerm given does not correspond to a search term group, remove the antihero article from a given category.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
searchTerm - String!
|
A searchterm to do the search with. |
productId - String!
|
The ID of a product to remove as the antihero article for the given search. |
categoryId - String
|
The ID of a category to remove the antihero article from. Will only be executed if no fitting searchterm is given. |
Example
Query
mutation Search_removeAntiHeroMarker(
$searchTerm: String!,
$productId: String!,
$categoryId: String
) {
search_removeAntiHeroMarker(
searchTerm: $searchTerm,
productId: $productId,
categoryId: $categoryId
)
}
Variables
{
"searchTerm": "xyz789",
"productId": "abc123",
"categoryId": "xyz789"
}
Response
{"data": {"search_removeAntiHeroMarker": false}}
search_removeHeroMarker
Description
Remove a hero article for a specific search. Alternatively, if the searchTerm given does not correspond to a search term group, remove the hero article from a given category.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
searchTerm - String!
|
A searchterm to do the search with. |
productId - String!
|
The ID of a product to remove as the hero article for the given search. |
categoryId - String
|
The ID of a category to remove the hero article from. Will only be executed if no fitting searchterm is given. |
Example
Query
mutation Search_removeHeroMarker(
$searchTerm: String!,
$productId: String!,
$categoryId: String
) {
search_removeHeroMarker(
searchTerm: $searchTerm,
productId: $productId,
categoryId: $categoryId
)
}
Variables
{
"searchTerm": "xyz789",
"productId": "xyz789",
"categoryId": "abc123"
}
Response
{"data": {"search_removeHeroMarker": true}}
search_saveOrUpdateSynonym
Description
Updates or creates a synonym or antonym.
Response
Returns a Synonym!
Arguments
| Name | Description |
|---|---|
synonymInput - SynonymGroupInput!
|
The synonym or antonym to create. |
Example
Query
mutation Search_saveOrUpdateSynonym($synonymInput: SynonymGroupInput!) {
search_saveOrUpdateSynonym(synonymInput: $synonymInput) {
id
version
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
synonymGroups {
id
version
mcs {
...McsFragment
}
overridden
direction
weight
fromSynonyms
toSynonyms
}
}
}
Variables
{"synonymInput": SynonymGroupInput}
Response
{
"data": {
"search_saveOrUpdateSynonym": {
"id": "4",
"version": {},
"inherited": false,
"mcs": Mcs,
"synonymGroups": [SynonymGroup]
}
}
}
search_saveOrUpdateSynonyms
Description
Updates or creates a group of synonyms or antonyms.
Response
Returns [Synonym!]!
Arguments
| Name | Description |
|---|---|
synonymInput - [SynonymGroupInput!]!
|
A list of synonyms or antonyms to create. |
Example
Query
mutation Search_saveOrUpdateSynonyms($synonymInput: [SynonymGroupInput!]!) {
search_saveOrUpdateSynonyms(synonymInput: $synonymInput) {
id
version
inherited
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
synonymGroups {
id
version
mcs {
...McsFragment
}
overridden
direction
weight
fromSynonyms
toSynonyms
}
}
}
Variables
{"synonymInput": [SynonymGroupInput]}
Response
{
"data": {
"search_saveOrUpdateSynonyms": [
{
"id": 4,
"version": {},
"inherited": true,
"mcs": Mcs,
"synonymGroups": [SynonymGroup]
}
]
}
}
search_saveSearchTermGroup
Description
Save search term group data.
Response
Returns a SearchTermGroup!
Arguments
| Name | Description |
|---|---|
input - SearchTermGroupInput!
|
The new search term group to create. |
Example
Query
mutation Search_saveSearchTermGroup($input: SearchTermGroupInput!) {
search_saveSearchTermGroup(input: $input) {
id
version
name
valid
isExact
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
searchTerms
isInherited
referenceType
}
}
Variables
{"input": SearchTermGroupInput}
Response
{
"data": {
"search_saveSearchTermGroup": {
"id": "4",
"version": {},
"name": "xyz789",
"valid": true,
"isExact": true,
"mcs": Mcs,
"searchTerms": ["abc123"],
"isInherited": true,
"referenceType": "NONE"
}
}
}
search_setAntiHeroMarker
Description
Set a antihero article for a specific search.
Response
Returns a Boolean!
Example
Query
mutation Search_setAntiHeroMarker(
$searchTerm: String!,
$productId: String!
) {
search_setAntiHeroMarker(
searchTerm: $searchTerm,
productId: $productId
)
}
Variables
{
"searchTerm": "xyz789",
"productId": "abc123"
}
Response
{"data": {"search_setAntiHeroMarker": true}}
search_setHeroMarker
Description
Set a hero article for a specific search.
Response
Returns a Boolean!
Example
Query
mutation Search_setHeroMarker(
$searchTerm: String!,
$productId: String!
) {
search_setHeroMarker(
searchTerm: $searchTerm,
productId: $productId
)
}
Variables
{
"searchTerm": "xyz789",
"productId": "xyz789"
}
Response
{"data": {"search_setHeroMarker": true}}
search_updateBandwidth
Description
Updates the bandwidth value for given MCS.
Response
Returns a BandwidthInfo!
Arguments
| Name | Description |
|---|---|
newValue - Int
|
The new bandwidth value. |
Example
Query
mutation Search_updateBandwidth($newValue: Int) {
search_updateBandwidth(newValue: $newValue) {
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
bandwidthValue
fallbackValue {
mcs {
...McsFragment
}
bandwidthValue
fallbackValue {
...BandwidthInfoFragment
}
isInherited
}
isInherited
}
}
Variables
{"newValue": 987}
Response
{
"data": {
"search_updateBandwidth": {
"mcs": Mcs,
"bandwidthValue": 123,
"fallbackValue": BandwidthInfo,
"isInherited": true
}
}
}
search_updateExclusion
Description
Updates an existing search exclusion.
Response
Returns a SearchExclusionUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateSearchExclusionInput!]!
|
Information needed to find the search exclusion to update and all operations to be done. |
Example
Query
mutation Search_updateExclusion($input: [UpdateSearchExclusionInput!]!) {
search_updateExclusion(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
type
name
searchTerms
countArticles
articles {
...ArticleFragment
}
categories {
...CategoryTreeFragment
}
categoryTreeEntries {
...LinkToCategoryTreeEntryFragment
}
inheritanceEnabled
inheritedValue {
...SearchExclusionFragment
}
}
}
}
Variables
{"input": [UpdateSearchExclusionInput]}
Response
{
"data": {
"search_updateExclusion": {
"entries": [SearchExclusion]
}
}
}
search_updateIndexScenarioAttribute
Description
Updates an existing indexed attribute.
Response
Returns a SearchIndexScenarioAttribute!
Arguments
| Name | Description |
|---|---|
input - ScenarioAttributesUpdateInput
|
The changed values and the ID of the indexed attribute to update. |
Example
Query
mutation Search_updateIndexScenarioAttribute($input: ScenarioAttributesUpdateInput) {
search_updateIndexScenarioAttribute(input: $input) {
id
version
weight
name
level
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
isInherited
updated
created
}
}
Variables
{"input": ScenarioAttributesUpdateInput}
Response
{
"data": {
"search_updateIndexScenarioAttribute": {
"id": 4,
"version": {},
"weight": 987.65,
"name": "abc123",
"level": "Product",
"mcs": Mcs,
"isInherited": true,
"updated": "2007-12-03T10:15:30Z",
"created": "2007-12-03T10:15:30Z"
}
}
}
search_updateIndexingScenario
Description
Update existing scenario data
Response
Returns a SearchIndexingScenario!
Arguments
| Name | Description |
|---|---|
input - SearchIndexingScenarioInput!
|
the scenario to update and its updated information. |
Example
Query
mutation Search_updateIndexingScenario($input: SearchIndexingScenarioInput!) {
search_updateIndexingScenario(input: $input) {
id
version
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
name
isInherited
factor
trackingCode
}
}
Variables
{"input": SearchIndexingScenarioInput}
Response
{
"data": {
"search_updateIndexingScenario": {
"id": {},
"version": {},
"mcs": Mcs,
"name": "xyz789",
"isInherited": false,
"factor": 123,
"trackingCode": "abc123"
}
}
}
search_updateLemma
Response
Returns a LemmaUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateLemmaInput!]!
|
Information needed to find the lemma/lemmata to update and all operations to be done. |
Example
Query
mutation Search_updateLemma($input: [UpdateLemmaInput!]!) {
search_updateLemma(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
searchTerms
wordStem
isInherited
}
}
}
Variables
{"input": [UpdateLemmaInput]}
Response
{"data": {"search_updateLemma": {"entries": [Lemma]}}}
search_updateSearchIndexScenario
Description
Update existing scenario data
Response
Returns a SearchIndexScenarioUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateSearchIndexScenarioInput!]!
|
the scenario to update and its updated information. |
Example
Query
mutation Search_updateSearchIndexScenario($input: [UpdateSearchIndexScenarioInput!]!) {
search_updateSearchIndexScenario(input: $input) {
entries {
id
version
audit {
...AuditFragment
}
mcs {
...McsFragment
}
name
factor
trackingCode
attributeCount
attributes {
...SearchIndexScenarioAttribute_2Fragment
}
}
}
}
Variables
{"input": [UpdateSearchIndexScenarioInput]}
Response
{
"data": {
"search_updateSearchIndexScenario": {
"entries": [SearchIndexScenario_2]
}
}
}
search_updateSearchTermGroup
Description
Update search term group by its id
Response
Returns a SearchTermGroup!
Arguments
| Name | Description |
|---|---|
input - SearchTermGroupInput!
|
The search term group with its new representation to update to. |
Example
Query
mutation Search_updateSearchTermGroup($input: SearchTermGroupInput!) {
search_updateSearchTermGroup(input: $input) {
id
version
name
valid
isExact
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
searchTerms
isInherited
referenceType
}
}
Variables
{"input": SearchTermGroupInput}
Response
{
"data": {
"search_updateSearchTermGroup": {
"id": "4",
"version": {},
"name": "abc123",
"valid": true,
"isExact": false,
"mcs": Mcs,
"searchTerms": ["xyz789"],
"isInherited": false,
"referenceType": "NONE"
}
}
}
search_updateSearchTermGroup2
Description
Updates an existing search term group.
Response
Returns a SearchTermGroupUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateSearchTermGroupInput!]!
|
Information needed to find the search exclusion to update and all operations to be done. |
Example
Query
mutation Search_updateSearchTermGroup2($input: [UpdateSearchTermGroupInput!]!) {
search_updateSearchTermGroup2(input: $input) {
entries {
id
version
name
valid
isExact
mcs {
...McsFragment
}
searchTerms
isInherited
referenceType
}
}
}
Variables
{"input": [UpdateSearchTermGroupInput]}
Response
{
"data": {
"search_updateSearchTermGroup2": {
"entries": [SearchTermGroup]
}
}
}
seo_createSeoTerm
Description
Creates a new seo term.
Response
Returns a SeoTermCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateSeoTermInput!]!
|
All relevant information needed to create the seo term. |
Example
Query
mutation Seo_createSeoTerm($input: [CreateSeoTermInput!]!) {
seo_createSeoTerm(input: $input) {
entries {
id
version
term
url
mainTerm
mcs {
...McsFragment
}
categoryTreeEntry {
...CategoryTreeEntryFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
}
}
Variables
{"input": [CreateSeoTermInput]}
Response
{"data": {"seo_createSeoTerm": {"entries": [SeoTerm]}}}
seo_deleteSeoTerm
Description
Delete an existing seo term.
Response
Returns a SeoTermDeletePayload!
Arguments
| Name | Description |
|---|---|
ids - [EntityId!]!
|
the IDs of the seo term to delete. |
Example
Query
mutation Seo_deleteSeoTerm($ids: [EntityId!]!) {
seo_deleteSeoTerm(ids: $ids) {
successful
}
}
Variables
{"ids": [EntityId]}
Response
{"data": {"seo_deleteSeoTerm": {"successful": false}}}
seo_updateSeoTerm
Description
Updates an existing seo term.
Response
Returns a SeoTermUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateSeoTermInput!]!
|
Information needed to find the seo term to update and all operations to be done. |
Example
Query
mutation Seo_updateSeoTerm($input: [UpdateSeoTermInput!]!) {
seo_updateSeoTerm(input: $input) {
entries {
id
version
term
url
mainTerm
mcs {
...McsFragment
}
categoryTreeEntry {
...CategoryTreeEntryFragment
}
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
}
}
}
Variables
{"input": [UpdateSeoTermInput]}
Response
{"data": {"seo_updateSeoTerm": {"entries": [SeoTerm]}}}
touchpoint_createTouchpoint
Description
Add new touchpoint
Response
Returns [TouchPoint!]!
Arguments
| Name | Description |
|---|---|
input - [CreateTouchpointInput!]!
|
Example
Query
mutation Touchpoint_createTouchpoint($input: [CreateTouchpointInput!]!) {
touchpoint_createTouchpoint(input: $input) {
id
version
name
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
description
persisted
conditions {
id
version
conditions {
... on ComplexCondition {
...ComplexConditionFragment
}
... on SimpleCondition {
...SimpleConditionFragment
}
}
operator
}
deleted
brokenInheritanceFrom
}
}
Variables
{"input": [CreateTouchpointInput]}
Response
{
"data": {
"touchpoint_createTouchpoint": [
{
"id": 4,
"version": {},
"name": "abc123",
"mcs": Mcs,
"description": "abc123",
"persisted": false,
"conditions": ComplexCondition,
"deleted": false,
"brokenInheritanceFrom": {}
}
]
}
}
touchpoint_deleteTouchpoint
Description
Delete an exsisting touchpoint
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - [EntityId!]!
|
Example
Query
mutation Touchpoint_deleteTouchpoint($id: [EntityId!]!) {
touchpoint_deleteTouchpoint(id: $id)
}
Variables
{"id": [EntityId]}
Response
{"data": {"touchpoint_deleteTouchpoint": true}}
touchpoint_updateTouchpoint
Description
Update an existing touchpoint
Response
Returns [TouchPoint!]!
Arguments
| Name | Description |
|---|---|
input - [UpdateTouchpointInput!]!
|
Example
Query
mutation Touchpoint_updateTouchpoint($input: [UpdateTouchpointInput!]!) {
touchpoint_updateTouchpoint(input: $input) {
id
version
name
mcs {
id
version
mcsString
displayString
deleted
parent
parentMcs {
...McsFragment
}
internalName
ishopBackoffice
mcs {
...BackofficeMultiChannelSelectorFragment
}
}
description
persisted
conditions {
id
version
conditions {
... on ComplexCondition {
...ComplexConditionFragment
}
... on SimpleCondition {
...SimpleConditionFragment
}
}
operator
}
deleted
brokenInheritanceFrom
}
}
Variables
{"input": [UpdateTouchpointInput]}
Response
{
"data": {
"touchpoint_updateTouchpoint": [
{
"id": "4",
"version": {},
"name": "xyz789",
"mcs": Mcs,
"description": "xyz789",
"persisted": false,
"conditions": ComplexCondition,
"deleted": true,
"brokenInheritanceFrom": {}
}
]
}
}
translation_createTranslation
Description
Create translations
Response
Returns a TranslationCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateTranslationInput!]!
|
Operations to create translations |
Example
Query
mutation Translation_createTranslation($input: [CreateTranslationInput!]!) {
translation_createTranslation(input: $input) {
entries {
messageKey
translations {
...TranslationFragment
}
}
}
}
Variables
{"input": [CreateTranslationInput]}
Response
{
"data": {
"translation_createTranslation": {
"entries": [Translations]
}
}
}
translation_deleteTranslation
Description
Deletes translations
Response
Returns a TranslationDeletePayload!
Arguments
| Name | Description |
|---|---|
ids - [EntityId!]!
|
Ids of translations to delete |
Example
Query
mutation Translation_deleteTranslation($ids: [EntityId!]!) {
translation_deleteTranslation(ids: $ids) {
successful
entries {
messageKey
translations {
...TranslationFragment
}
}
}
}
Variables
{"ids": [EntityId]}
Response
{
"data": {
"translation_deleteTranslation": {
"successful": false,
"entries": [Translations]
}
}
}
translation_updateTranslation
Description
Update translations
Response
Returns a TranslationUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateTranslationInput!]!
|
Operations to update translations |
Example
Query
mutation Translation_updateTranslation($input: [UpdateTranslationInput!]!) {
translation_updateTranslation(input: $input) {
entries {
messageKey
translations {
...TranslationFragment
}
}
}
}
Variables
{"input": [UpdateTranslationInput]}
Response
{
"data": {
"translation_updateTranslation": {
"entries": [Translations]
}
}
}
userRole_createUserRole
Description
Create user/role relation (roles with translation or special rights cannot be assigned to users)
Response
Returns a UserRoleCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateUserRoleInput!]!
|
Operations to create user/role relation |
Example
Query
mutation UserRole_createUserRole($input: [CreateUserRoleInput!]!) {
userRole_createUserRole(input: $input) {
entries {
id
version
user {
...UserEntityFragment
}
role {
...RoleEntityFragment
}
mcss {
...McsFragment
}
}
}
}
Variables
{"input": [CreateUserRoleInput]}
Response
{
"data": {
"userRole_createUserRole": {
"entries": [UserRoleEntity]
}
}
}
userRole_deleteUserRole
Description
Delete user/role relations
Response
Returns a UserRoleDeletePayload!
Arguments
| Name | Description |
|---|---|
ids - [EntityId!]!
|
Ids of user/role relations to delete |
Example
Query
mutation UserRole_deleteUserRole($ids: [EntityId!]!) {
userRole_deleteUserRole(ids: $ids) {
successful
}
}
Variables
{"ids": [EntityId]}
Response
{"data": {"userRole_deleteUserRole": {"successful": true}}}
userRole_updateUserRole
Description
Update user/role relation
Response
Returns a UserRoleUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateUserRoleInput!]!
|
Operations to update user/role relation |
Example
Query
mutation UserRole_updateUserRole($input: [UpdateUserRoleInput!]!) {
userRole_updateUserRole(input: $input) {
entries {
id
version
user {
...UserEntityFragment
}
role {
...RoleEntityFragment
}
mcss {
...McsFragment
}
}
}
}
Variables
{"input": [UpdateUserRoleInput]}
Response
{
"data": {
"userRole_updateUserRole": {
"entries": [UserRoleEntity]
}
}
}
voucher_createCommonVoucher
Description
Add a new common voucher
Response
Returns a VoucherCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreateCommonVoucherInput!]!
|
Example
Query
mutation Voucher_createCommonVoucher($input: [CreateCommonVoucherInput!]!) {
voucher_createCommonVoucher(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
regex
type
imported
maxPerCodeRedeemCount
maxPerUserRedeemCount
codesInGroup
redeemedAmount
voucherCodesInfo {
...VoucherCodeInformationFragment
}
promotionsInfo {
...PromotionEntityFragment
}
usedByPromotion
}
}
}
Variables
{"input": [CreateCommonVoucherInput]}
Response
{
"data": {
"voucher_createCommonVoucher": {
"entries": [VoucherGroup]
}
}
}
voucher_createPersonalVoucher
Description
Add a new personal voucher
Response
Returns a VoucherCreatePayload!
Arguments
| Name | Description |
|---|---|
input - [CreatePersonalVoucherInput!]!
|
Example
Query
mutation Voucher_createPersonalVoucher($input: [CreatePersonalVoucherInput!]!) {
voucher_createPersonalVoucher(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
regex
type
imported
maxPerCodeRedeemCount
maxPerUserRedeemCount
codesInGroup
redeemedAmount
voucherCodesInfo {
...VoucherCodeInformationFragment
}
promotionsInfo {
...PromotionEntityFragment
}
usedByPromotion
}
}
}
Variables
{"input": [CreatePersonalVoucherInput]}
Response
{
"data": {
"voucher_createPersonalVoucher": {
"entries": [VoucherGroup]
}
}
}
voucher_deleteVoucherGroup
Description
Delete voucher group
Response
Returns a VoucherDeletePayload!
Arguments
| Name | Description |
|---|---|
ids - [EntityId!]!
|
Example
Query
mutation Voucher_deleteVoucherGroup($ids: [EntityId!]!) {
voucher_deleteVoucherGroup(ids: $ids) {
successful
}
}
Variables
{"ids": [EntityId]}
Response
{"data": {"voucher_deleteVoucherGroup": {"successful": false}}}
voucher_updateCommonVoucher
Description
Add voucher code common voucher
Response
Returns a VoucherUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdateCommonVoucherInput!]!
|
Example
Query
mutation Voucher_updateCommonVoucher($input: [UpdateCommonVoucherInput!]!) {
voucher_updateCommonVoucher(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
regex
type
imported
maxPerCodeRedeemCount
maxPerUserRedeemCount
codesInGroup
redeemedAmount
voucherCodesInfo {
...VoucherCodeInformationFragment
}
promotionsInfo {
...PromotionEntityFragment
}
usedByPromotion
}
}
}
Variables
{"input": [UpdateCommonVoucherInput]}
Response
{
"data": {
"voucher_updateCommonVoucher": {
"entries": [VoucherGroup]
}
}
}
voucher_updatePersonalVoucher
Description
Add voucher code
Response
Returns a VoucherUpdatePayload!
Arguments
| Name | Description |
|---|---|
input - [UpdatePersonalVoucherInput!]!
|
Example
Query
mutation Voucher_updatePersonalVoucher($input: [UpdatePersonalVoucherInput!]!) {
voucher_updatePersonalVoucher(input: $input) {
entries {
id
version
mcs {
...McsFragment
}
name
description
backofficeUserInfoAudit {
...BackofficeUserInfoAuditFragment
}
regex
type
imported
maxPerCodeRedeemCount
maxPerUserRedeemCount
codesInGroup
redeemedAmount
voucherCodesInfo {
...VoucherCodeInformationFragment
}
promotionsInfo {
...PromotionEntityFragment
}
usedByPromotion
}
}
}
Variables
{"input": [UpdatePersonalVoucherInput]}
Response
{
"data": {
"voucher_updatePersonalVoucher": {
"entries": [VoucherGroup]
}
}
}
Types
ABTestScenarioFilter
Fields
| Input Field | Description |
|---|---|
value - [ID!]!
|
Example
{"value": [4]}
ABTestedList
Fields
| Field Name | Description |
|---|---|
entries - [ABTestedValue!]!
|
Example
{"entries": [ABTestedValue]}
ABTestedValue
Fields
| Field Name | Description |
|---|---|
scenario - AbTestScenario!
|
Linked scenario for this attribute |
nullableValue - DynamicValue
|
A/B test value can have no value attribute, so it should allow null |
Example
{
"scenario": AbTestScenario,
"nullableValue": StringValue
}
AbScenarioContentAttribute
Description
A single content attribute for a specific AB-Testscenario
Fields
| Field Name | Description |
|---|---|
contentAttribute - ContentAttribute!
|
The content attribute |
scenario - AbTestScenario!
|
The AB-Testscenario |
Example
{
"contentAttribute": ContentAttribute,
"scenario": AbTestScenario
}
AbScenarioContentAttributeInput
Description
A single content attribute for a specific AB-Testscenario
Fields
| Input Field | Description |
|---|---|
contentAttribute - BaseContentAttributeInput!
|
The content attribute value. |
scenario - AbTestScenarioInput!
|
The AB-Testscenario |
Example
{
"contentAttribute": BaseContentAttributeInput,
"scenario": AbTestScenarioInput
}
AbTest
Description
Representation of an existing AB-Test.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this AB-Test. |
version - Long!
|
The version of current AB-Test. |
mcs - Mcs!
|
The MCS of current AB-Test. |
name - String!
|
The name of current AB-Test. |
description - String
|
The description of current AB-Test. |
hypothesis - String
|
The hypothesis of current AB-Test. |
startDate - DateTime!
|
The start of execution. |
endDate - DateTime
|
The end of execution. |
status - TimeValidityStatus!
|
The ABTest status gives Information about it's life cycle. |
scenarios - [AbTestScenario!]!
|
A List of scenarios in this AB-Test. Be aware of circular output: Test <-> Scenario |
deleted - Boolean
|
If ABTest is deleted or not |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
The audit and userInfo of current ABTest |
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"name": "abc123",
"description": "abc123",
"hypothesis": "abc123",
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"status": "ACTIVE",
"scenarios": [AbTestScenario],
"deleted": false,
"backofficeUserInfoAudit": BackofficeUserInfoAudit
}
AbTestCreatePayload
Description
Payload wrapper object for creating AbTests.
Fields
| Field Name | Description |
|---|---|
entries - [AbTest!]!
|
The list of created AbTests. |
Example
{"entries": [AbTest]}
AbTestDeleteFilterInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
A/B test id |
Example
{"id": 4}
AbTestDeletePayload
Description
Payload wrapper object for deleting AbTest
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Flag for success. |
Example
{"successful": false}
AbTestFilterInput
Fields
| Input Field | Description |
|---|---|
ids - [ID!]
|
Results in AbTest according to the ids |
searchTerm - String
|
Results in all AbTest names with partial matches. |
status - [TimeValidityStatus]!
|
only results with given status will be returned if empty, results of all states will be returned multiple entries possible. Default = [] |
Example
{
"ids": [4],
"searchTerm": "abc123",
"status": ["ACTIVE"]
}
AbTestFindPayload
Description
A list of ABTests
Fields
| Field Name | Description |
|---|---|
entries - [AbTest!]!
|
The list of AbTests after applying paging information. |
totalCount - Int!
|
The complete count of AbTests, disregarding any paging information. count is calculated for given filter and mcs |
Example
{"entries": [AbTest], "totalCount": 987}
AbTestPagingInput
Fields
| Input Field | Description |
|---|---|
sorting - AbTestSorting!
|
Sorting information. Default = {sortColumn: NAME, sortOrder: ASC} |
paging - Paging!
|
Paging information. Default = {limit: 100, offset: 0} |
Example
{
"sorting": AbTestSorting,
"paging": Paging
}
AbTestScenario
Description
Representation of a single AB-Testscenario.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of current scenario. |
version - Long!
|
The version of current scenario. |
mcs - Mcs!
|
The MCS of current scenario. |
name - String!
|
The name of current scenario |
weight - Float!
|
The weight applied to current scenario. |
trackingCode - String
|
An optional tracking code for current scenario. |
defaultScenario - Boolean!
|
A flag describing if this is the default scenario of the AB-Test. |
winning - Boolean!
|
A flag describing if this is the chosen winning scenario of the AB-Test. |
abTest - AbTest!
|
Reference to the AB-Test containing this scenario. Be aware of circular output: Test <-> Scenario |
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"name": "xyz789",
"weight": 123.45,
"trackingCode": "abc123",
"defaultScenario": true,
"winning": true,
"abTest": AbTest
}
AbTestScenarioInput
Description
Representation of an AB-TestScenario
Example
{
"id": 4,
"version": {},
"mcsInput": McsInput,
"name": "abc123"
}
AbTestSortColumn
Description
Enum Representation of the columns available in AbTests.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
AbTestSorting
Description
Sorting information.
Fields
| Input Field | Description |
|---|---|
sortColumn - AbTestSortColumn!
|
The column by which the AbTests should be sorted. Default: NAME. Default = NAME |
sortOrder - SortOrder!
|
The sort direction. Default: Ascending. Default = ASC |
Example
{"sortColumn": "NAME", "sortOrder": "ASC"}
AbTestUpdatePayload
Description
Payload wrapper object for updating AbTest
Fields
| Field Name | Description |
|---|---|
entries - [AbTest!]!
|
List of updated AbTests |
Example
{"entries": [AbTest]}
AbTestUsedStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NONE"
AbTimelineEvent
AbstractItem
Types
| Union Types |
|---|
Example
Item
AbstractSmartAssistantNode
AddAndCondition
Description
This is the second level Which will be AND condition
Fields
| Input Field | Description |
|---|---|
addSimpleConditions - [AddSimpleCondition!]!
|
List of simple conditions which will be AND-ed together |
Example
{"addSimpleConditions": [AddSimpleCondition]}
AddAreaForGridElements
AddArticleIgnoreElement
Description
Input parameters to add articles to an ignore list
Fields
| Input Field | Description |
|---|---|
value - Article_ID!
|
Article number that will be added |
Example
{"value": Article_ID}
AddArticleListScoreCard
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
addDirectValueCard - AddArticleListScoreCardDirectValue
|
|
addBooleanCard - AddArticleListScoreCardBoolean
|
|
addCategoryCard - AddArticleListScoreCardCategory
|
|
addBrandCard - AddArticleListScoreCardBrand
|
|
addDoubleCard - AddArticleListScoreCardDouble
|
|
addIntCard - AddArticleListScoreCardInt
|
|
addStringCard - AddArticleListScoreCardString
|
Example
{
"addDirectValueCard": AddArticleListScoreCardDirectValue,
"addBooleanCard": AddArticleListScoreCardBoolean,
"addCategoryCard": AddArticleListScoreCardCategory,
"addBrandCard": AddArticleListScoreCardBrand,
"addDoubleCard": AddArticleListScoreCardDouble,
"addIntCard": AddArticleListScoreCardInt,
"addStringCard": AddArticleListScoreCardString
}
AddArticleListScoreCardBoolean
Fields
| Input Field | Description |
|---|---|
setAttribute - SetArticleListScoreType!
|
|
setWeight - SetIntWeight!
|
|
setBoolean - SetArticleListScoreCardBooleanValue!
|
Example
{
"setAttribute": SetArticleListScoreType,
"setWeight": SetIntWeight,
"setBoolean": SetArticleListScoreCardBooleanValue
}
AddArticleListScoreCardBrand
Fields
| Input Field | Description |
|---|---|
setAttribute - SetArticleListScoreType!
|
|
setWeight - SetIntWeight!
|
|
setOtherRange - SetOtherRange!
|
|
addBrandRange - [AddBrandRange!]!
|
Example
{
"setAttribute": SetArticleListScoreType,
"setWeight": SetIntWeight,
"setOtherRange": SetOtherRange,
"addBrandRange": [AddBrandRange]
}
AddArticleListScoreCardCategory
Fields
| Input Field | Description |
|---|---|
setAttribute - SetArticleListScoreType!
|
|
setWeight - SetIntWeight!
|
|
setOtherRange - SetOtherRange!
|
|
addCategoryRange - [AddCategoryRange!]!
|
Example
{
"setAttribute": SetArticleListScoreType,
"setWeight": SetIntWeight,
"setOtherRange": SetOtherRange,
"addCategoryRange": [AddCategoryRange]
}
AddArticleListScoreCardDirectValue
Fields
| Input Field | Description |
|---|---|
setAttribute - SetArticleListScoreType!
|
|
setWeight - SetIntWeight!
|
Example
{
"setAttribute": SetArticleListScoreType,
"setWeight": SetIntWeight
}
AddArticleListScoreCardDouble
Fields
| Input Field | Description |
|---|---|
setAttribute - SetArticleListScoreType!
|
|
setWeight - SetIntWeight!
|
|
setOtherRange - SetOtherRange!
|
|
addDoubleRange - [AddDoubleRange!]!
|
Example
{
"setAttribute": SetArticleListScoreType,
"setWeight": SetIntWeight,
"setOtherRange": SetOtherRange,
"addDoubleRange": [AddDoubleRange]
}
AddArticleListScoreCardInt
Fields
| Input Field | Description |
|---|---|
setAttribute - SetArticleListScoreType!
|
|
setWeight - SetIntWeight!
|
|
setOtherRange - SetOtherRange!
|
|
addIntRange - [AddIntRange!]!
|
Example
{
"setAttribute": SetArticleListScoreType,
"setWeight": SetIntWeight,
"setOtherRange": SetOtherRange,
"addIntRange": [AddIntRange]
}
AddArticleListScoreCardString
Fields
| Input Field | Description |
|---|---|
setAttribute - SetArticleListScoreType!
|
|
setWeight - SetIntWeight!
|
|
setOtherRange - SetOtherRange!
|
|
addStringRange - [AddStringRange!]!
|
Example
{
"setAttribute": SetArticleListScoreType,
"setWeight": SetIntWeight,
"setOtherRange": SetOtherRange,
"addStringRange": [AddStringRange]
}
AddBenefit
Description
This command allows only one benefit to be added each time
Fields
| Input Field | Description |
|---|---|
addDiscountAmountBenefit - AddDiscountAmountBenefit
|
|
addDiscountPercentBenefit - AddDiscountPercentBenefit
|
|
addDiscountPercentOnCheapestItemBenefit - AddDiscountPercentOnCheapestItemBenefit
|
|
addDiscountPercentOnMostExpensiveItemBenefit - AddDiscountPercentOnMostExpensiveItemBenefit
|
|
addTakeAndPayBenefit - AddTakeAndPayBenefit
|
|
addFreeShippingBenefit - AddFreeShippingBenefit
|
|
addInformativeBenefit - AddInformativeBenefit
|
|
addFreeItemBenefit - AddFreeItemBenefit
|
|
addSpecialPriceBenefit - AddSpecialPriceBenefit
|
Example
{
"addDiscountAmountBenefit": AddDiscountAmountBenefit,
"addDiscountPercentBenefit": AddDiscountPercentBenefit,
"addDiscountPercentOnCheapestItemBenefit": AddDiscountPercentOnCheapestItemBenefit,
"addDiscountPercentOnMostExpensiveItemBenefit": AddDiscountPercentOnMostExpensiveItemBenefit,
"addTakeAndPayBenefit": AddTakeAndPayBenefit,
"addFreeShippingBenefit": AddFreeShippingBenefit,
"addInformativeBenefit": AddInformativeBenefit,
"addFreeItemBenefit": AddFreeItemBenefit,
"addSpecialPriceBenefit": AddSpecialPriceBenefit
}
AddBlocklistedBrand
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
AddBooleanDynamicCondition
Description
For BooleanDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setBoolean - SetBooleanConditionValue!
|
Boolean condition |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setBoolean": SetBooleanConditionValue
}
AddBrandDynamicCondition
Description
For BrandDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setBrand - SetBrandDynamicConditionRelation!
|
Brand value |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setBrand": SetBrandDynamicConditionRelation
}
AddBrandListDynamicCondition
Description
For BrandListDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setStringList - SetStringListConditionValue!
|
Brand list ids values |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setStringList": SetStringListConditionValue
}
AddBrandRange
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight!
|
|
setBrand - SetBrandId!
|
Example
{
"setWeight": SetIntWeight,
"setBrand": SetBrandId
}
AddCategoryDynamicCondition
Description
For CategoryDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setOperator - SetCategoryConditionOperator!
|
Operator Within/NotWithin. Default = {value: Within} |
setCategory - SetCategoryDynamicConditionRelation!
|
Category entity id |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setOperator": SetCategoryConditionOperator,
"setCategory": SetCategoryDynamicConditionRelation
}
AddCategoryListDynamicCondition
Description
For CategoryListDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setOperator - SetCategoryConditionOperator!
|
Operator Within/NotWithin |
setCategoryTreeRelations - [SetCategoryTreeRelation!]!
|
Category list entities ids |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setOperator": SetCategoryConditionOperator,
"setCategoryTreeRelations": [SetCategoryTreeRelation]
}
AddCategoryRange
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight!
|
|
setCategory - SetCategory!
|
Example
{
"setWeight": SetIntWeight,
"setCategory": SetCategory
}
AddCategoryRelation
Description
Representation of a new category relation.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the category to add. |
setIncludeSubTree - SetIncludeSubTree
|
If all subcategories of this category should be included or only this specific category. |
Example
{"id": 4, "setIncludeSubTree": SetIncludeSubTree}
AddColorListDynamicCondition
Description
For ColorListDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setStringList - SetStringListConditionValue!
|
String lst color values |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setStringList": SetStringListConditionValue
}
AddComboboxDynamicCondition
Description
For ComboBoxDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setKey - SetComboboxConditionValue!
|
Selected value from combobox |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setKey": SetComboboxConditionValue
}
AddCommonVoucherDynamicCondition
Description
For CommonVoucherDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setCommonVoucher - SetCommonVoucher!
|
Common voucher id |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setCommonVoucher": SetCommonVoucher
}
AddCustomerSegment
Description
input AddGridElementParameter { setAttribute: SetAttribute! setValue: SetDynamicValueOperation! } input UpdateGridElementParameter { id: EntityId! ops: [UpdateGridElementParameterOperation!]! } input UpdateGridElementParameterOperation { updateValue: SetDynamicValueOperation setParameterDescription: SetParameterDescription } input CopyGridOperation { setValidityRange: SetValidityRange setName: SetName setAbScenario: SetAbScenario # WIP # setCustomerSegment: SetCustomerSegment updateGridContainers: [UpdateGridContainersOperation!] } input RemoveGridContainer { id: EntityId! }
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
AddCustomerSegmentDynamicCondition
Description
For CustomerSegmentDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setCustomerSegment - SetCustomerSegmentDynamicConditionRelation!
|
Customer segment id |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setCustomerSegment": SetCustomerSegmentDynamicConditionRelation
}
AddDateDynamicCondition
Description
For DateDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setDate - SetDateConditionValue!
|
Date value |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setDate": SetDateConditionValue
}
AddDiscountAmountBenefit
Description
Input parameters for DiscountAmountBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setBenefitTarget - SetBenefitTarget!
|
Benefit target type (ITEM or BASKET) |
setBenefitDiscount - SetBenefitDiscount!
|
Percentage value |
setBenefitCurrency - SetBenefitCurrency
|
Currency |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setBenefitTarget": SetBenefitTarget,
"setBenefitDiscount": SetBenefitDiscount,
"setBenefitCurrency": SetBenefitCurrency
}
AddDiscountPercentBenefit
Description
Input parameters for DiscountPercentBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setBenefitTarget - SetBenefitTarget!
|
Benefit target type (ITEM or BASKET) |
setPercentageValue - SetPercentageValue!
|
Percentage value |
setPriceType - SetPriceType!
|
Price type CURRENT_PRICE or OLD_PRICE |
setCapAmount - SetCapAmount
|
Cap amount |
setCapCurrency - SetCapCurrency
|
Cap currency (EUR, ...etc) |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setBenefitTarget": SetBenefitTarget,
"setPercentageValue": SetPercentageValue,
"setPriceType": SetPriceType,
"setCapAmount": SetCapAmount,
"setCapCurrency": SetCapCurrency
}
AddDiscountPercentOnCheapestItemBenefit
Description
Input parameters for DiscountPercentOnCheapestItemBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setPercentageValue - SetPercentageValue!
|
Percentage value |
setCapAmount - SetCapAmount
|
Cap amount |
setCapCurrency - SetCapCurrency
|
Cap currency (EUR, ...etc) |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setPercentageValue": SetPercentageValue,
"setCapAmount": SetCapAmount,
"setCapCurrency": SetCapCurrency
}
AddDiscountPercentOnMostExpensiveItemBenefit
Description
Input parameters for DiscountPercentOnMostExpensiveItemBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setPercentageValue - SetPercentageValue!
|
Percentage value |
setCapAmount - SetCapAmount
|
Cap amount |
setCapCurrency - SetCapCurrency
|
Cap currency (EUR, ...etc) |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setPercentageValue": SetPercentageValue,
"setCapAmount": SetCapAmount,
"setCapCurrency": SetCapCurrency
}
AddDoubleDynamicCondition
Description
For DoubleDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setDouble - SetDoubleConditionValue!
|
Double value |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setDouble": SetDoubleConditionValue
}
AddDoubleRange
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
addGreaterThan - AddDoubleRangeGreaterThan
|
|
addLessThan - AddDoubleRangeLessThan
|
|
addBetween - AddDoubleRangeBetween
|
Example
{
"addGreaterThan": AddDoubleRangeGreaterThan,
"addLessThan": AddDoubleRangeLessThan,
"addBetween": AddDoubleRangeBetween
}
AddDoubleRangeBetween
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight!
|
|
setFrom - SetFromDoubleValue!
|
|
setTo - SetToDoubleValue!
|
Example
{
"setWeight": SetIntWeight,
"setFrom": SetFromDoubleValue,
"setTo": SetToDoubleValue
}
AddDoubleRangeGreaterThan
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight!
|
|
setFrom - SetFromDoubleValue!
|
Example
{
"setWeight": SetIntWeight,
"setFrom": SetFromDoubleValue
}
AddDoubleRangeLessThan
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight!
|
|
setTo - SetToDoubleValue!
|
Example
{
"setWeight": SetIntWeight,
"setTo": SetToDoubleValue
}
AddDoubleTextDynamicCondition
Description
For DoubleTextDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setFirstText - SetTextConditionValue!
|
First text |
setSecondText - SetSecondTextConditionValue
|
Second text |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setFirstText": SetTextConditionValue,
"setSecondText": SetSecondTextConditionValue
}
AddExclustion
Description
A detailled description of excluded articles and categories in a search exclusion.
Fields
| Input Field | Description |
|---|---|
setExcludedArticles - SetExcludedArticles
|
A list of excluded articles. |
addExcludedCategory - AddCategoryRelation
|
An excluded category to add. |
Example
{
"setExcludedArticles": SetExcludedArticles,
"addExcludedCategory": AddCategoryRelation
}
AddFilterCategoryBlocklistedCategory
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
AddFilterCategorySource
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
AddFilterDynamicCondition
Description
For FilterDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setKey - SetTextConditionValue!
|
Filter key |
setValue - SetSecondTextConditionValue
|
Filter value |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setKey": SetTextConditionValue,
"setValue": SetSecondTextConditionValue
}
AddFreeItemBenefit
Description
Input parameters for FreeItemsBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setBenefitTarget - SetBenefitTarget!
|
Benefit target type (ITEM or BASKET) |
setBenefitItems - SetBenefitItems!
|
Selectable items |
setMaxSelectableItems - SetMaxSelectableItems!
|
Max selectable items |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setBenefitTarget": SetBenefitTarget,
"setBenefitItems": SetBenefitItems,
"setMaxSelectableItems": SetMaxSelectableItems
}
AddFreeShippingBenefit
Description
Input parameters for FreeShippingBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage
}
AddGridContainerAttribute
Fields
| Input Field | Description |
|---|---|
setAttribute - SetParameterType!
|
Attribute type |
setValue - SetGenericValueOperation!
|
Attribute value |
Example
{
"setAttribute": SetParameterType,
"setValue": SetGenericValueOperation
}
AddHotSpotRelation
Fields
| Input Field | Description |
|---|---|
setLinkValue - SetLinkValue!
|
|
setCoordinates - SetHotSpotCoordinates!
|
|
setHotSpotTrackingCode - SetHotSpotTrackingCode
|
|
setHotSpotText - SetHotSpotText
|
Example
{
"setLinkValue": SetLinkValue,
"setCoordinates": SetHotSpotCoordinates,
"setHotSpotTrackingCode": SetHotSpotTrackingCode,
"setHotSpotText": SetHotSpotText
}
AddIgnoredCategory
Description
Input parameters to add a category to a list of ignored categories
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
AddInformativeBenefit
Description
Input parameters for InformativeBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setInformativeType - SetInformativeType!
|
Informative type |
setInternalName - SetInternalName
|
Internal name |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setInformativeType": SetInformativeType,
"setInternalName": SetInternalName
}
AddIntRange
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
addGreaterThan - AddIntRangeGreaterThan
|
|
addLessThan - AddIntRangeLessThan
|
|
addBetween - AddIntRangeBetween
|
Example
{
"addGreaterThan": AddIntRangeGreaterThan,
"addLessThan": AddIntRangeLessThan,
"addBetween": AddIntRangeBetween
}
AddIntRangeBetween
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight!
|
|
setFrom - SetFromIntValue!
|
|
setTo - SetToIntValue!
|
Example
{
"setWeight": SetIntWeight,
"setFrom": SetFromIntValue,
"setTo": SetToIntValue
}
AddIntRangeGreaterThan
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight!
|
|
setFrom - SetFromIntValue!
|
Example
{
"setWeight": SetIntWeight,
"setFrom": SetFromIntValue
}
AddIntRangeLessThan
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight!
|
|
setTo - SetToIntValue!
|
Example
{
"setWeight": SetIntWeight,
"setTo": SetToIntValue
}
AddIntegerComparisonDynamicCondition
Description
For IntegerComparisonDynamicCondition
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setInteger - SetIntegerConditionValue!
|
Integer value |
setOperator - SetMonetaryComparisonOperator!
|
Operators >= or <= |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setInteger": SetIntegerConditionValue,
"setOperator": SetMonetaryComparisonOperator
}
AddIntegerDynamicCondition
Description
For IntegerDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setInteger - SetIntegerConditionValue!
|
Integer value |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setInteger": SetIntegerConditionValue
}
AddLinkToCategoryTreeEntry
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
withSubtree - SetIncludeSubTree!
|
Example
{"id": 4, "withSubtree": SetIncludeSubTree}
AddLinkToContentTreeEntry
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
withSubtree - SetIncludeSubTree!
|
Example
{
"id": "4",
"withSubtree": SetIncludeSubTree
}
AddLinkToLandingTreeEntry
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
withSubtree - SetIncludeSubTree!
|
Example
{
"id": "4",
"withSubtree": SetIncludeSubTree
}
AddLinkToMaintainTreeEntry
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
withSubtree - SetIncludeSubTree!
|
Example
{"id": 4, "withSubtree": SetIncludeSubTree}
AddLinkToProductPageTreeEntry
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
withSubtree - SetIncludeSubTree!
|
Example
{
"id": "4",
"withSubtree": SetIncludeSubTree
}
AddLinkToSearchTermGroupTreeEntry
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
withSubtree - SetIncludeSubTree!
|
Example
{"id": 4, "withSubtree": SetIncludeSubTree}
AddLinkedBrandRelation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the brand |
setLinkValue - SetLinkValue
|
|
setLinkedBrandTrackingCode - SetLinkedBrandTrackingCode
|
Example
{
"id": 4,
"setLinkValue": SetLinkValue,
"setLinkedBrandTrackingCode": SetLinkedBrandTrackingCode
}
AddMcs
Description
Operation to add MultiChannelSelector to user/role relation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Id of MultiChannelSelector entity |
Example
{"id": "4"}
AddMonetaryAmountComparisonDynamicCondition
Description
For MonetaryAmountComparisonDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setOperator - SetMonetaryComparisonOperator!
|
Operators >= or <= |
setAmount - SetMonetaryAmountConditionValue!
|
Double amount |
setCurrency - SetTextConditionValue!
|
Currency |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setOperator": SetMonetaryComparisonOperator,
"setAmount": SetMonetaryAmountConditionValue,
"setCurrency": SetTextConditionValue
}
AddMonetaryAmountDynamicCondition
Description
For MonetaryAmountDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setAmount - SetMonetaryAmountConditionValue!
|
Double amount |
setCurrency - SetTextConditionValue!
|
Currency |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setAmount": SetMonetaryAmountConditionValue,
"setCurrency": SetTextConditionValue
}
AddNamedBrandCategorySource
AddNamedCategoryRelation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
setNamedCategoryName - SetNamedCategoryName!
|
Example
{"id": 4, "setNamedCategoryName": SetNamedCategoryName}
AddNamedImageRelation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
setNamedImageName - SetNamedImageName!
|
Example
{"id": 4, "setNamedImageName": SetNamedImageName}
AddNamedLinkRelation
Fields
| Input Field | Description |
|---|---|
setLinkValue - SetLinkValue!
|
|
setNamedLinkName - SetNamedLinkName!
|
|
setNamedLinkTitle - SetNamedLinkTitle
|
|
setNamedLinkTrackingCode - SetNamedLinkTrackingCode
|
Example
{
"setLinkValue": SetLinkValue,
"setNamedLinkName": SetNamedLinkName,
"setNamedLinkTitle": SetNamedLinkTitle,
"setNamedLinkTrackingCode": SetNamedLinkTrackingCode
}
AddOrCondition
Description
This is the first level from OR condition
Fields
| Input Field | Description |
|---|---|
addAndConditions - [AddAndCondition!]!
|
List of complex AND conditions which will be OR-ed together |
Example
{"addAndConditions": [AddAndCondition]}
AddOrCustomerSegmentCondition
Fields
| Input Field | Description |
|---|---|
addAndConditions - [AddAndCondition!]!
|
Example
{"addAndConditions": [AddAndCondition]}
AddOrDataExportCondition
Description
Input parameter for adding Data Export Condition
Fields
| Input Field | Description |
|---|---|
addAndConditions - [AddAndCondition!]!
|
Example
{"addAndConditions": [AddAndCondition]}
AddOrFilterCategoryCondition
Fields
| Input Field | Description |
|---|---|
addAndConditions - [AddAndCondition!]!
|
Example
{"addAndConditions": [AddAndCondition]}
AddOrFilterLevelCondition
Fields
| Input Field | Description |
|---|---|
addAndConditions - [AddAndCondition!]!
|
Example
{"addAndConditions": [AddAndCondition]}
AddOrPromotionCondition
Fields
| Input Field | Description |
|---|---|
addAndConditions - [AddAndCondition!]!
|
Example
{"addAndConditions": [AddAndCondition]}
AddOrSmartCategoryCondition
Fields
| Input Field | Description |
|---|---|
addAndConditions - [AddAndCondition!]!
|
Example
{"addAndConditions": [AddAndCondition]}
AddOrTouchpointCondition
Fields
| Input Field | Description |
|---|---|
addAndConditions - [AddAndCondition!]!
|
Example
{"addAndConditions": [AddAndCondition]}
AddPersonalVoucherDynamicCondition
Description
For PersonalVoucherDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setPersonalVoucher - SetPersonalVoucher!
|
Personal voucher id |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setPersonalVoucher": SetPersonalVoucher
}
AddPriceDynamicCondition
Description
For PriceFilterDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setText - SetTextConditionValue!
|
Text |
setMin - SetMinConditionValue
|
Minimum price value |
setMax - SetMaxConditionValue
|
Maximum price value |
setReduced - SetReduced!
|
Reduced boolean value. Default = {value: false} |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setText": SetTextConditionValue,
"setMin": SetMinConditionValue,
"setMax": SetMaxConditionValue,
"setReduced": SetReduced
}
AddPrivilege
Description
Operation to add privilege to role/right relation
Fields
| Input Field | Description |
|---|---|
value - Privilege!
|
Privilege to add |
Example
{"value": "GRANTED"}
AddProductListDynamicCondition
Description
Fo ProductListDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setStringList - SetStringListConditionValue!
|
String product list keys |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setStringList": SetStringListConditionValue
}
AddRangeFilterDynamicCondition
Description
For RangeFilterDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setText - SetTextConditionValue!
|
Text |
setMin - SetMinConditionValue
|
Minimum value |
setMax - SetMaxConditionValue
|
Maximum value |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setText": SetTextConditionValue,
"setMin": SetMinConditionValue,
"setMax": SetMaxConditionValue
}
AddReplacement
AddRoleRight
Description
Operation to add right to role
Fields
| Input Field | Description |
|---|---|
setRight - SetRight!
|
Operation to set right |
addPrivileges - [AddPrivilege!]!
|
Operation to add privileges to role/right relation |
Example
{
"setRight": SetRight,
"addPrivileges": [AddPrivilege]
}
AddSearchIndexAttribute
Description
Adds a new search index attribute or updates an existing one, identified by the indexable attribute name.
Fields
| Input Field | Description |
|---|---|
setIndexableAttributeName - SetIndexableAttributeName!
|
The indexed attribute name. |
setWeight - SetWeight!
|
The weight of the indexed attribute. |
Example
{
"setIndexableAttributeName": SetIndexableAttributeName,
"setWeight": SetWeight
}
AddSimpleCondition
Fields
| Input Field | Description |
|---|---|
addBooleanDynamicCondition - AddBooleanDynamicCondition
|
|
addBrandDynamicCondition - AddBrandDynamicCondition
|
|
addBrandListDynamicCondition - AddBrandListDynamicCondition
|
|
addCategoryDynamicCondition - AddCategoryDynamicCondition
|
|
addCategoryListDynamicCondition - AddCategoryListDynamicCondition
|
|
addColorListDynamicCondition - AddColorListDynamicCondition
|
|
addComboboxDynamicCondition - AddComboboxDynamicCondition
|
|
addCommonVoucherDynamicCondition - AddCommonVoucherDynamicCondition
|
|
addCustomerSegmentDynamicCondition - AddCustomerSegmentDynamicCondition
|
|
addDateDynamicCondition - AddDateDynamicCondition
|
|
addDoubleDynamicCondition - AddDoubleDynamicCondition
|
|
addDoubleTextDynamicCondition - AddDoubleTextDynamicCondition
|
|
addFilterDynamicCondition - AddFilterDynamicCondition
|
|
addIntegerDynamicCondition - AddIntegerDynamicCondition
|
|
addIntegerComparisonDynamicCondition - AddIntegerComparisonDynamicCondition
|
|
addMonetaryAmountComparisonDynamicCondition - AddMonetaryAmountComparisonDynamicCondition
|
|
addMonetaryAmountDynamicCondition - AddMonetaryAmountDynamicCondition
|
|
addPersonalVoucherDynamicCondition - AddPersonalVoucherDynamicCondition
|
|
addPriceDynamicCondition - AddPriceDynamicCondition
|
|
addProductListDynamicCondition - AddProductListDynamicCondition
|
|
addRangeFilterDynamicCondition - AddRangeFilterDynamicCondition
|
|
addStringListDynamicCondition - AddStringListDynamicCondition
|
|
addTextDynamicCondition - AddTextDynamicCondition
|
|
addTouchpointDynamicCondition - AddTouchpointDynamicCondition
|
|
addUserInterestDynamicCondition - AddUserInterestDynamicCondition
|
|
addUserTypeDynamicCondition - AddUserTypeDynamicCondition
|
|
addVoidDynamicCondition - AddVoidDynamicCondition
|
Example
{
"addBooleanDynamicCondition": AddBooleanDynamicCondition,
"addBrandDynamicCondition": AddBrandDynamicCondition,
"addBrandListDynamicCondition": AddBrandListDynamicCondition,
"addCategoryDynamicCondition": AddCategoryDynamicCondition,
"addCategoryListDynamicCondition": AddCategoryListDynamicCondition,
"addColorListDynamicCondition": AddColorListDynamicCondition,
"addComboboxDynamicCondition": AddComboboxDynamicCondition,
"addCommonVoucherDynamicCondition": AddCommonVoucherDynamicCondition,
"addCustomerSegmentDynamicCondition": AddCustomerSegmentDynamicCondition,
"addDateDynamicCondition": AddDateDynamicCondition,
"addDoubleDynamicCondition": AddDoubleDynamicCondition,
"addDoubleTextDynamicCondition": AddDoubleTextDynamicCondition,
"addFilterDynamicCondition": AddFilterDynamicCondition,
"addIntegerDynamicCondition": AddIntegerDynamicCondition,
"addIntegerComparisonDynamicCondition": AddIntegerComparisonDynamicCondition,
"addMonetaryAmountComparisonDynamicCondition": AddMonetaryAmountComparisonDynamicCondition,
"addMonetaryAmountDynamicCondition": AddMonetaryAmountDynamicCondition,
"addPersonalVoucherDynamicCondition": AddPersonalVoucherDynamicCondition,
"addPriceDynamicCondition": AddPriceDynamicCondition,
"addProductListDynamicCondition": AddProductListDynamicCondition,
"addRangeFilterDynamicCondition": AddRangeFilterDynamicCondition,
"addStringListDynamicCondition": AddStringListDynamicCondition,
"addTextDynamicCondition": AddTextDynamicCondition,
"addTouchpointDynamicCondition": AddTouchpointDynamicCondition,
"addUserInterestDynamicCondition": AddUserInterestDynamicCondition,
"addUserTypeDynamicCondition": AddUserTypeDynamicCondition,
"addVoidDynamicCondition": AddVoidDynamicCondition
}
AddSmartProductCinema
Fields
| Input Field | Description |
|---|---|
addOrCondition - AddOrCondition!
|
Example
{"addOrCondition": AddOrCondition}
AddSpecialPriceBenefit
Description
Input parameters for SpecialPriceBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setBenefitItems - SetBenefitItems!
|
Selectable items |
setMaxSelectableItems - SetMaxSelectableItems!
|
Max selectable items |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setBenefitItems": SetBenefitItems,
"setMaxSelectableItems": SetMaxSelectableItems
}
AddStringListDynamicCondition
Description
For StringListDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setStringList - SetStringListConditionValue!
|
String values |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setStringList": SetStringListConditionValue
}
AddStringRange
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight!
|
|
setValue - SetStringRangeValue!
|
Example
{
"setWeight": SetIntWeight,
"setValue": SetStringRangeValue
}
AddTabValue
AddTagCloudRelation
Fields
| Input Field | Description |
|---|---|
setPriority - SetPriority!
|
|
setLink - SetLinkValue!
|
|
setLinkName - SetNamedLinkName!
|
|
setTitle - SetNamedLinkTitle
|
|
setTrackingInfo - SetNamedLinkTrackingCode
|
Example
{
"setPriority": SetPriority,
"setLink": SetLinkValue,
"setLinkName": SetNamedLinkName,
"setTitle": SetNamedLinkTitle,
"setTrackingInfo": SetNamedLinkTrackingCode
}
AddTakeAndPayBenefit
Description
Input parameters for TakeAndPayBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setItemsYouTake - SetItemsYouTake!
|
Number of items you take |
setItemsYouPay - SetItemsYouPay!
|
Number of items you pay |
setOnlyOncePerOrder - SetOnlyOncePerOrder!
|
If it is only once per order or not |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setItemsYouTake": SetItemsYouTake,
"setItemsYouPay": SetItemsYouPay,
"setOnlyOncePerOrder": SetOnlyOncePerOrder
}
AddTextDynamicCondition
Description
For TextDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setText - SetTextConditionValue!
|
String value |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setText": SetTextConditionValue
}
AddTouchpointDynamicCondition
Description
For TouchpointDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setTouchpoint - SetTouchpoint!
|
Touchpoint id |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setTouchpoint": SetTouchpoint
}
AddUserInterestDynamicCondition
Description
For UserInterestDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setIdentifier - SetIdentifier!
|
Identifier value |
addSimpleCondition - AddSimpleCondition!
|
Reference to simple condition |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setIdentifier": SetIdentifier,
"addSimpleCondition": AddSimpleCondition
}
AddUserRole
AddUserTypeDynamicCondition
Description
For UserTypeDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
setUserType - SetUserTypeConditionValue!
|
User type value |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated,
"setUserType": SetUserTypeConditionValue
}
AddVoidDynamicCondition
Description
For VoidDynamicConditionEntity
Fields
| Input Field | Description |
|---|---|
setDynamicConditionDescription - SetDynamicConditionDescription!
|
Condition description id |
setNegated - SetNegated
|
Negated option |
Example
{
"setDynamicConditionDescription": SetDynamicConditionDescription,
"setNegated": SetNegated
}
AdditionalHtmlStylesGetPayload
Fields
| Field Name | Description |
|---|---|
additionalStyles - String
|
Example
{"additionalStyles": "abc123"}
AffectedContents
Fields
| Field Name | Description |
|---|---|
contentsWithSameValidity - [CampaignReference!]
|
Contents with same validity of the updated campaign |
contentsWithHoles - [CampaignReference!]
|
Contents with holes between them |
followupOverwrittenByCampaign - [CampaignReference!]
|
The follow up contents that will be overwritten by the campaign |
previousOverwrittenByCampaign - [CampaignReference!]
|
The previous contents that will be overwritten by the campaign |
ongoingOverwrittenByCampaignAfterExtendingEndDate - [CampaignReference!]
|
The contents that will continue to be overwritten by the campaignAfter Extending end date |
ongoingOverwrittenByCampaignAfterShorteningEndDate - [CampaignReference!]
|
After Shortening End Date |
ongoingOverwrittenByCampaignAfterExtendingStartDate - [CampaignReference!]
|
After Extending Start Date |
ongoingOverwrittenByCampaignAfterShorteningStartDate - [CampaignReference!]
|
After Shortening Start Date |
followupOverwritesForCampaign - [CampaignReference!]
|
The followup contents that will overwrite the campaign |
previousOverwritesForCampaign - [CampaignReference!]
|
The previous contents that will overwrite the campaign |
ongoingOverwritesForCampaignAfterExtendingEndDate - [CampaignReference!]
|
The contents that will overwrite the campaignAfter Extending End Date |
ongoingOverwritesForCampaignAfterShorteningEndDate - [CampaignReference!]
|
After Shortening End Date |
ongoingOverwritesForCampaignAfterExtendingStartDate - [CampaignReference!]
|
After Extending Start Date |
ongoingOverwritesForCampaignAfterShorteningStartDate - [CampaignReference!]
|
After Shortening Start Date |
followupContents - [CampaignReference!]
|
The follow-up contents |
Example
{
"contentsWithSameValidity": [PromotionEntity],
"contentsWithHoles": [PromotionEntity],
"followupOverwrittenByCampaign": [PromotionEntity],
"previousOverwrittenByCampaign": [PromotionEntity],
"ongoingOverwrittenByCampaignAfterExtendingEndDate": [
PromotionEntity
],
"ongoingOverwrittenByCampaignAfterShorteningEndDate": [
PromotionEntity
],
"ongoingOverwrittenByCampaignAfterExtendingStartDate": [
PromotionEntity
],
"ongoingOverwrittenByCampaignAfterShorteningStartDate": [
PromotionEntity
],
"followupOverwritesForCampaign": [PromotionEntity],
"previousOverwritesForCampaign": [PromotionEntity],
"ongoingOverwritesForCampaignAfterExtendingEndDate": [
PromotionEntity
],
"ongoingOverwritesForCampaignAfterShorteningEndDate": [
PromotionEntity
],
"ongoingOverwritesForCampaignAfterExtendingStartDate": [
PromotionEntity
],
"ongoingOverwritesForCampaignAfterShorteningStartDate": [
PromotionEntity
],
"followupContents": [PromotionEntity]
}
AiGeneratedImageDescription
AiGeneratedSynonym
AiGeneratedTranslation
AllAttributesFilterInput
Description
Filter and sorting options for attributes.
Fields
| Input Field | Description |
|---|---|
mcsInput - McsInput!
|
The mcs for the filter. |
scenarioId - Long!
|
A specific scenario ID. Used to check if found attributes are selected for this attribute. |
searchTerm - String
|
An optional searchterm to filter attributes with. If null or empty it will return all attributes. |
sorting - AllScenarioAttributeSortOption!
|
Sorting options for the returned attributes. |
paging - ScenarioAttributePaging!
|
Paging information. |
Example
{
"mcsInput": McsInput,
"scenarioId": {},
"searchTerm": "xyz789",
"sorting": AllScenarioAttributeSortOption,
"paging": ScenarioAttributePaging
}
AllScenarioAttributeSortColumn
Description
Enum representation of the columns of scenario attributes.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SELECTED"
AllScenarioAttributeSortOption
Description
Sorting options.
Fields
| Input Field | Description |
|---|---|
sortingColumn - AllScenarioAttributeSortColumn!
|
Sorting of the returned attributes. Default: Selected. Default = SELECTED |
sortingType - SortType!
|
Ordering of the returned attributes. Default: Ascending. Default = ASC |
Example
{"sortingColumn": "SELECTED", "sortingType": "ASC"}
AllowedValue
Description
A value that is allowed as value of a global parameter.
Fields
| Field Name | Description |
|---|---|
valueKey - String!
|
The value. |
displayNames - [MapType!]!
|
What would be displayed for this value in different languages. |
Example
{
"valueKey": "xyz789",
"displayNames": [MapType]
}
AlwaysAt
Fields
| Field Name | Description |
|---|---|
time - String!
|
HH:mm |
Example
{"time": "xyz789"}
AmountBenefitEntity
Description
Representation of an amount benefit
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the benefit. |
version - Long!
|
The version of the benefit. |
title - String
|
The maintained title of the benefit |
image - ImageEntity
|
The maintained image for the benefit |
discount - Float!
|
The discount amount applied |
benefitTarget - BenefitTarget!
|
Benefit target type |
currency - String
|
Currency |
Example
{
"id": "4",
"version": {},
"title": "xyz789",
"image": ImageEntity,
"discount": 123.45,
"benefitTarget": "ITEM",
"currency": "abc123"
}
ArchiveFilterInput
Description
INPUT
Fields
| Input Field | Description |
|---|---|
ids - [ID!]!
|
|
names - [String!]!
|
|
startWithNames - [String!]!
|
|
status - [TimeValidityStatus!]!
|
|
hasContent - Boolean
|
|
hidden - Boolean
|
Example
{
"ids": ["4"],
"names": ["abc123"],
"startWithNames": ["xyz789"],
"status": ["ACTIVE"],
"hasContent": true,
"hidden": false
}
ArchiveFindPayload
Description
TODO ISBO-12371 We need an own type for NavigationTreeEntry here
Fields
| Field Name | Description |
|---|---|
entries - [ArchiveTreeEntry!]!
|
|
totalCount - Int!
|
Example
{"entries": [ArchiveTreeEntry], "totalCount": 987}
ArchiveGroupByLetter
ArchiveGroupByLetterPayload
Fields
| Field Name | Description |
|---|---|
entries - [ArchiveGroupByLetter!]!
|
Example
{"entries": [ArchiveGroupByLetter]}
ArchivePagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging
|
|
sorting - ArchiveSortInput
|
Example
{
"paging": Paging,
"sorting": ArchiveSortInput
}
ArchiveSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder
|
|
sortColumn - ArchiveSortType
|
Example
{"sortOrder": "ASC", "sortColumn": "INFO"}
ArchiveSortType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INFO"
ArchiveTreeEntry
Description
Defines the types that can be part of the archive.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
|
deleteDate - DateTime
|
The date when the entry will be deleted or null if it won't be deleted |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
ancestors - [NavigationTreeEntry!]!
|
|
parent - NavigationTreeEntry
|
|
children - NavigationTreeEntryChildrenPayload!
|
|
Arguments
|
|
valid - Boolean!
|
|
originalTreeType - TreeType
|
|
Possible Types
| ArchiveTreeEntry Types |
|---|
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"name": "xyz789",
"deleteDate": "2007-12-03T10:15:30Z",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"ancestors": [NavigationTreeEntry],
"parent": NavigationTreeEntry,
"children": NavigationTreeEntryChildrenPayload,
"valid": false,
"originalTreeType": "ArchiveTree"
}
Article
Description
Represents an article.
Fields
| Field Name | Description |
|---|---|
articleIdentifier - Article_ID!
|
The shop-specified article identifier. |
totalNumberOfItems - Int!
|
The total number of items. |
items - [Item_2!]!
|
A shop-specified list of items that belong to this article. |
Arguments
|
|
Example
{
"articleIdentifier": Article_ID,
"totalNumberOfItems": 987,
"items": [Item_2]
}
ArticleFindPayload
Description
Represents the article find result.
Fields
| Field Name | Description |
|---|---|
entries - [Article!]!
|
A list of found articles. |
Example
{"entries": [Article]}
ArticleIgnoreListCreatePayload
Description
Payload wrapper object for creating article ignore list
Fields
| Field Name | Description |
|---|---|
entries - [DataExportArticleIgnoreList!]!
|
List of created article ignore list |
Example
{"entries": [DataExportArticleIgnoreList]}
ArticleIgnoreListDeletePayload
Description
Payload wrapper object for deleting articles ignore list
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Flag for success. |
Example
{"successful": true}
ArticleIgnoreListPagingInput
Fields
| Input Field | Description |
|---|---|
pagingInput - Paging!
|
Paging information. Default = {limit: 100, offset: 0} |
sortInput - ArticleIgnoreListSortInput!
|
Sorting information. {Default asc by name}. Default = {sortOrder: ASC, sortColumn: NAME} |
Example
{
"pagingInput": Paging,
"sortInput": ArticleIgnoreListSortInput
}
ArticleIgnoreListSortColumn
Description
Representation in which will the result be sorted
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NAME"
ArticleIgnoreListSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
list order value (default order is ASC). Default = ASC |
sortColumn - ArticleIgnoreListSortColumn!
|
Column names which are allowed to sort with. Default = NAME |
Example
{"sortOrder": "ASC", "sortColumn": "NAME"}
ArticleIgnoreListUpdatePayload
Description
Payload wrapper object for updating article ignore list
Fields
| Field Name | Description |
|---|---|
entries - [DataExportArticleIgnoreList!]!
|
Update article ignore lists |
Example
{"entries": [DataExportArticleIgnoreList]}
ArticleIgnoreListsFilterInput
Fields
| Input Field | Description |
|---|---|
searchTerm - String
|
String keyword to search within article ignore list name |
Example
{"searchTerm": "xyz789"}
ArticleIgnoreListsFindPayload
Description
A list of article ignore list records
Fields
| Field Name | Description |
|---|---|
entries - [DataExportArticleIgnoreList!]!
|
The list of article ignore lists |
totalCount - Int!
|
The complete count of article ignore list records |
Example
{
"entries": [DataExportArticleIgnoreList],
"totalCount": 987
}
ArticleLink
Description
The representation of an article link.
Example
{
"id": 4,
"version": {},
"openLinkInNewWindow": false,
"urlParameters": "abc123",
"articleId": "4"
}
ArticleLinkInput
Description
Additional information to describe an article link.
Fields
| Input Field | Description |
|---|---|
articleId - ID!
|
The ID of the article. |
Example
{"articleId": 4}
ArticleListScore
Description
Representation of a single article score.
This is only a start and should be extended with values you need.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this article score. |
version - Long!
|
The version of this article score. |
mcs - Mcs!
|
The MCS containing this article score. |
name - String!
|
The name of this article score set. |
isInherited - Boolean!
|
Flag that indicates whether this article score was inherited from a higher MCS. |
articleListScoreCards - [ArticleListScoreCard!]!
|
|
references - [ArticleListScoreReference!]!
|
The contents where this ArticleListScore is used |
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"name": "abc123",
"isInherited": false,
"articleListScoreCards": [
ArticleListScoreCardDirectValue
],
"references": [CategoryParameter]
}
ArticleListScoreBrandRange
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this article score. |
version - Long!
|
The version of this article score. |
weight - Int!
|
|
value - BrandEntity!
|
Example
{
"id": 4,
"version": {},
"weight": 987,
"value": BrandEntity
}
ArticleListScoreCard
Example
ArticleListScoreCardDirectValue
ArticleListScoreCardAttribute
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the article list score type. |
version - Long!
|
The version of the article list score type. |
mcs - Mcs!
|
The MCS containing the article list score type. |
level - AttributeLevel!
|
defines if the Score is applied to item or product. |
dataType - DataType!
|
the data type of the article list Score type. |
displayName - String!
|
The translated displayName for the users locale |
dataSource - String!
|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"level": "Product",
"dataType": "Number",
"displayName": "xyz789",
"dataSource": "abc123"
}
ArticleListScoreCardAttributeFindPayload
Fields
| Field Name | Description |
|---|---|
entries - [ArticleListScoreCardAttribute!]!
|
|
totalCount - Int!
|
Example
{
"entries": [ArticleListScoreCardAttribute],
"totalCount": 987
}
ArticleListScoreCardAttributeSortingInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
|
sortType - ArticleListScoreCardTypeSortType!
|
Example
{"sortOrder": "ASC", "sortType": "INFO"}
ArticleListScoreCardBoolean
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this article score. |
version - Long!
|
The version of this article score. |
mcs - Mcs!
|
The MCS containing this article score. |
cardType - ArticleListScoreCardAttribute!
|
The type of the score card. |
weight - Int!
|
The weight of the score card. |
boolean - Boolean!
|
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"cardType": ArticleListScoreCardAttribute,
"weight": 123,
"boolean": true
}
ArticleListScoreCardBrand
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this article score. |
version - Long!
|
The version of this article score. |
mcs - Mcs!
|
The MCS containing this article score. |
cardType - ArticleListScoreCardAttribute!
|
The type of the score card. |
weight - Int!
|
The weight of the score card. |
ranges - [ArticleListScoreBrandRange!]!
|
|
other - ArticleListScoreOtherRange!
|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"cardType": ArticleListScoreCardAttribute,
"weight": 123,
"ranges": [ArticleListScoreBrandRange],
"other": ArticleListScoreOtherRange
}
ArticleListScoreCardCategory
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this article score. |
version - Long!
|
The version of this article score. |
mcs - Mcs!
|
The MCS containing this article score. |
cardType - ArticleListScoreCardAttribute!
|
The type of the score card. |
weight - Int!
|
The weight of the score card. |
ranges - [ArticleListScoreCategoryRange!]!
|
|
other - ArticleListScoreOtherRange!
|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"cardType": ArticleListScoreCardAttribute,
"weight": 987,
"ranges": [ArticleListScoreCategoryRange],
"other": ArticleListScoreOtherRange
}
ArticleListScoreCardDirectValue
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this article score. |
version - Long!
|
The version of this article score. |
mcs - Mcs!
|
The MCS containing this article score. |
cardType - ArticleListScoreCardAttribute!
|
The type of the score card. |
weight - Int!
|
The weight of the score card. |
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"cardType": ArticleListScoreCardAttribute,
"weight": 123
}
ArticleListScoreCardDouble
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this article score. |
version - Long!
|
The version of this article score. |
mcs - Mcs!
|
The MCS containing this article score. |
cardType - ArticleListScoreCardAttribute!
|
The type of the score card. |
weight - Int!
|
The weight of the score card. |
ranges - [ArticleListScoreDoubleRange!]!
|
|
other - ArticleListScoreOtherRange!
|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"cardType": ArticleListScoreCardAttribute,
"weight": 987,
"ranges": [ArticleListScoreDoubleGreaterThanRange],
"other": ArticleListScoreOtherRange
}
ArticleListScoreCardInt
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this article score. |
version - Long!
|
The version of this article score. |
mcs - Mcs!
|
The MCS containing this article score. |
cardType - ArticleListScoreCardAttribute!
|
The type of the score card. |
weight - Int!
|
The weight of the score card. |
ranges - [ArticleListScoreIntRange!]!
|
|
other - ArticleListScoreOtherRange!
|
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"cardType": ArticleListScoreCardAttribute,
"weight": 987,
"ranges": [ArticleListScoreIntGreaterThanRange],
"other": ArticleListScoreOtherRange
}
ArticleListScoreCardString
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this article score. |
version - Long!
|
The version of this article score. |
mcs - Mcs!
|
The MCS containing this article score. |
cardType - ArticleListScoreCardAttribute!
|
The type of the score card. |
weight - Int!
|
The weight of the score card. |
ranges - [ArticleListScoreStringRange!]!
|
|
other - ArticleListScoreOtherRange!
|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"cardType": ArticleListScoreCardAttribute,
"weight": 123,
"ranges": [ArticleListScoreStringRange],
"other": ArticleListScoreOtherRange
}
ArticleListScoreCardTypeSortType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"INFO"
ArticleListScoreCategoryRange
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this article score. |
version - Long!
|
The version of this article score. |
weight - Int!
|
|
value - NavigationTreeEntry!
|
Example
{
"id": 4,
"version": {},
"weight": 987,
"value": NavigationTreeEntry
}
ArticleListScoreCopyPayload
Fields
| Field Name | Description |
|---|---|
entries - [ArticleListScore!]!
|
Example
{"entries": [ArticleListScore]}
ArticleListScoreCreatePayload
Fields
| Field Name | Description |
|---|---|
entries - [ArticleListScore!]!
|
Example
{"entries": [ArticleListScore]}
ArticleListScoreDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": false}
ArticleListScoreDoubleBetweenRange
ArticleListScoreDoubleGreaterThanRange
ArticleListScoreDoubleLessThanRange
ArticleListScoreDoubleRange
Example
ArticleListScoreDoubleGreaterThanRange
ArticleListScoreFilterInput
ArticleListScoreFindPayload
Description
A list of article scores without further details as a result
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
The total amount of results found, unaffected by paging |
entries - [ArticleListScore!]!
|
The result list of article score, affected by paging |
Example
{"totalCount": 123, "entries": [ArticleListScore]}
ArticleListScoreIntBetweenRange
ArticleListScoreIntGreaterThanRange
ArticleListScoreIntLessThanRange
ArticleListScoreIntRange
Example
ArticleListScoreIntGreaterThanRange
ArticleListScoreOtherRange
ArticleListScorePagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
|
sorting - ArticleListScoreSortingInput!
|
Example
{
"paging": Paging,
"sorting": ArticleListScoreSortingInput
}
ArticleListScorePreviewInput
Fields
| Input Field | Description |
|---|---|
targetCategory - EntityId!
|
|
op - ArticleListScorePreviewOperation
|
Example
{
"targetCategory": EntityId,
"op": ArticleListScorePreviewOperation
}
ArticleListScorePreviewOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
add - CreateArticleListScoreInput
|
|
update - UpdateArticleListScoreInput
|
Example
{
"add": CreateArticleListScoreInput,
"update": UpdateArticleListScoreInput
}
ArticleListScorePreviewPayload
Fields
| Field Name | Description |
|---|---|
entries - [ScoredPreviewEntry!]!
|
|
totalCount - Int!
|
Example
{"entries": [ScoredPreviewEntry], "totalCount": 987}
ArticleListScoreReference
Description
Representation of content where this ArticleListScore is used
Example
CategoryParameter
ArticleListScoreSortingInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
|
sortType - ArticleScoreSortType!
|
Example
{"sortOrder": "ASC", "sortType": "INFO"}
ArticleListScoreStringRange
ArticleListScoreUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [ArticleListScore!]!
|
Example
{"entries": [ArticleListScore]}
ArticlePaging
Fields
| Input Field | Description |
|---|---|
sortType - ArticleSorting!
|
The sort type for sorting the returned articles. Default: None. Default = NONE |
sortOrder - SortOrder!
|
" The sort order for the returned articles. Default: Ascending. Default = ASC |
offset - Int!
|
Offset of results that should be skipped. Default: 0. Default = 0 |
limit - Int!
|
Limit of results per page. Default: 100. Default = 100 |
Example
{"sortType": "NONE", "sortOrder": "ASC", "offset": 123, "limit": 123}
ArticleScoreSortType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INFO"
ArticleSearchEntry
Description
Represents one search hit.
Fields
| Field Name | Description |
|---|---|
articles - [Article!]!
|
A list of articles that this search hit can be represented by. |
Example
{"articles": [Article]}
ArticleSearchInput
Fields
| Input Field | Description |
|---|---|
searchTerms - [String!]!
|
The search terms to search for |
paging - ArticlePaging!
|
Paging information to return a specific part of the results. Default = {sortType: NONE, sortOrder: ASC, offset: 0, limit: 100} |
mcsInput - McsInput!
|
The mcs for the search |
Example
{
"searchTerms": ["abc123"],
"paging": ArticlePaging,
"mcsInput": McsInput
}
ArticleSearchPayload
Description
Represents the article search result.
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
Total number of entries. |
entries - [ArticleSearchEntry!]!
|
A list of article search entries paged by the given input. |
Example
{"totalCount": 987, "entries": [ArticleSearchEntry]}
ArticleSorting
Values
| Enum Value | Description |
|---|---|
|
|
Sorts by simple id ascending |
|
|
Sorts by status boolean |
|
|
Sorts by SKUs |
|
|
Sorts by name |
|
|
Sorts by brand |
|
|
Sorts by price amount independent of the currency |
Example
"NONE"
Article_ID
Description
A scalar representing the identifier for an article defined by the shop via SearchResultEntryLookupStrategy.
Example
Article_ID
ArticlesResultItem
Description
A list of items as a result
Fields
| Field Name | Description |
|---|---|
total - Int!
|
The total amount of results found, unaffected by paging |
items - [AbstractItem]!
|
The result list of items, affected by paging |
Example
{"total": 123, "items": [Item]}
Asset
Description
The representation of an asset.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the entity. |
version - Long!
|
The version of the entity. |
name - String!
|
File name |
mcs - Mcs!
|
Shop which this image was uploaded to |
contentType - String
|
File type (e.g. png/pdf/zip, ...etc) |
assetCategory - AssetCategory
|
Enum for Asset category to be used in icon rendering |
size - Long
|
File size in bytes (after optimization). in the first upload it will be equal to originalSize |
keywords - [String!]!
|
List of keywords |
url - String
|
URL for files |
uploadedDate - DateTime
|
The first time this file was uploaded |
lastModified - DateTime
|
The time this file was edited/updated |
uploadedUser - UserInformation
|
The user who uploaded this file |
editedUser - UserInformation
|
The last user who edited/updated this file |
assetType - AssetType
|
Enum represents the actual Asset types |
Possible Types
| Asset Types |
|---|
Example
{
"id": 4,
"version": {},
"name": "xyz789",
"mcs": Mcs,
"contentType": "xyz789",
"assetCategory": "IMAGE",
"size": {},
"keywords": ["abc123"],
"url": "xyz789",
"uploadedDate": "2007-12-03T10:15:30Z",
"lastModified": "2007-12-03T10:15:30Z",
"uploadedUser": UserInformation,
"editedUser": UserInformation,
"assetType": "BINARY_IMAGE"
}
AssetCategory
Values
| Enum Value | Description |
|---|---|
|
|
Images/photos only |
|
|
Video types (mp4, ...etc) |
|
|
PDF files |
|
|
Static content |
|
|
Compressed files |
|
|
Microsoft office files (word, excel, ...etc) |
|
|
Other types than the predefined ones |
Example
"IMAGE"
AssetCreatePayload
Fields
| Field Name | Description |
|---|---|
entries - [Asset!]!
|
Example
{"entries": [Asset]}
AssetDeleteModel
AssetDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": false}
AssetEntity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the entity. |
version - Long!
|
The version of the entity. |
name - String!
|
File name |
mcs - Mcs!
|
Shop which this image was uploaded to |
contentType - String
|
File type (e.g. png/pdf/zip, ...etc) |
assetCategory - AssetCategory
|
Enum for Asset type to be used in icon rendering |
size - Long
|
File size in bytes (after optimization). in the first upload it will be equal to originalSize |
keywords - [String!]!
|
List of keywords |
url - String
|
URL for files |
uploadedDate - DateTime
|
The first time this file was uploaded |
lastModified - DateTime
|
The time this file was edited/updated |
uploadedUser - UserInformation
|
The user who uploaded this file |
editedUser - UserInformation
|
The last user who edited/updated this file |
assetType - AssetType
|
Enum represents the actual Asset types |
Example
{
"id": 4,
"version": {},
"name": "abc123",
"mcs": Mcs,
"contentType": "xyz789",
"assetCategory": "IMAGE",
"size": {},
"keywords": ["xyz789"],
"url": "abc123",
"uploadedDate": "2007-12-03T10:15:30Z",
"lastModified": "2007-12-03T10:15:30Z",
"uploadedUser": UserInformation,
"editedUser": UserInformation,
"assetType": "BINARY_IMAGE"
}
AssetFormat
AssetLink
Description
The representation of an asset link.
Example
{
"id": "4",
"version": {},
"openLinkInNewWindow": false,
"urlParameters": "xyz789",
"asset": Asset
}
AssetLinkInput
Description
Additional information to describe an asset link.
Fields
| Input Field | Description |
|---|---|
assetId - ID!
|
The ID of the asset. |
Example
{"assetId": "4"}
AssetOptimizationEnabledPayload
Fields
| Field Name | Description |
|---|---|
isOptimizationEnabled - Boolean!
|
Boolean isOptimizationEnabled |
Example
{"isOptimizationEnabled": true}
AssetSearchFilterInput
Fields
| Input Field | Description |
|---|---|
searchTerm - String
|
String keyword to search with |
currentUserOnly - Boolean!
|
Only uploaded by current user. Default = false |
assetCategories - [AssetCategory!]!
|
Asset type (All, Images/Photos, videos, pdf, zip, office, others). Default = [IMAGE, VIDEO, PDF, STATIC_CONTENT, ZIP, OFFICE, OTHERS] |
startDate - DateTime
|
Uploaded date is greater than or equal from date |
endDate - DateTime
|
Uploaded date is less than or equal to date |
sorting - AssetSortingInput!
|
Sorting option column and type. Default = {sortOrder: DESC, sortColumn: INFO} |
paging - Paging!
|
Paging filter. Default = {limit: 100, offset: 0} |
Example
{
"searchTerm": "xyz789",
"currentUserOnly": false,
"assetCategories": ["IMAGE"],
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"sorting": AssetSortingInput,
"paging": Paging
}
AssetSortColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"INFO"
AssetSortingInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
list order value (default order is DESC). Default = DESC |
sortColumn - AssetSortColumn!
|
Column names which are allowed to search for. Default = INFO |
Example
{"sortOrder": "ASC", "sortColumn": "INFO"}
AssetTagsEntity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The id of the entity |
version - Long!
|
The version of the entity |
language - String!
|
Language of the title and alt values |
title - String
|
Image's mcs specific title attribute |
alt - String
|
Image's mcs specific alt attribute |
defaultLanguage - Boolean!
|
Indicates if this is the default value |
Example
{
"id": "4",
"version": {},
"language": "xyz789",
"title": "abc123",
"alt": "xyz789",
"defaultLanguage": false
}
AssetType
Values
| Enum Value | Description |
|---|---|
|
|
Binary image |
|
|
External image |
|
|
Internal resource image |
|
|
Plugin |
|
|
Template |
|
|
static content |
|
|
Linkable asset |
Example
"BINARY_IMAGE"
AssetUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [Asset!]!
|
Example
{"entries": [Asset]}
Assets
AssignAbTestInput
AttributeDefinitionGroup
AttributeDescriptionGroupRightEntity
Description
User right for a parameter group
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Id of entity |
version - Long!
|
Version of entity |
name - String!
|
Name of right |
privileges - [Privilege!]!
|
List of allowed privileges for this right |
rightType - RightType!
|
Type of right (GROUP) |
parentId - ID
|
Id of parent entity |
rightGroup - RightGroupEntity
|
Right group entity |
parent - Boolean!
|
Flag to indicate whether this right is shown on parent mcss or not |
attributeDescGroup - AttributeDefinitionGroup
|
The attribute definition group of this right |
childrenRights - [AttributeDescriptionGroupRightEntity!]!
|
Children of user right |
Example
{
"id": "4",
"version": {},
"name": "xyz789",
"privileges": ["GRANTED"],
"rightType": "MENU",
"parentId": "4",
"rightGroup": RightGroupEntity,
"parent": false,
"attributeDescGroup": AttributeDefinitionGroup,
"childrenRights": [AttributeDescriptionGroupRightEntity]
}
AttributeDescriptionType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
key - String!
|
|
displayName - String!
|
|
group - AttributeDefinitionGroup!
|
|
abTestable - Boolean!
|
|
customerSegmentsAllowed - Boolean!
|
|
exportable - Boolean!
|
|
linkable - Boolean!
|
indicate whether an attribute can be linked to other object. Linking attribute is used for category and page parameters. |
standard - Boolean!
|
true for standard ishop core attribute and false for shop specific ones |
mandatory - Boolean!
|
indicates whether the value must be present for this type. |
helpText - String
|
|
hasHelpText - Boolean!
|
|
mutationCommandType - String!
|
|
allowedValues - [AllowedValue!]!
|
|
searchable - Boolean!
|
indicates whether the value for this attribute description could be indexed by the content search. |
valueType - AttributeValueType!
|
Possible Types
| AttributeDescriptionType Types |
|---|
Example
{
"id": 4,
"version": {},
"key": "abc123",
"displayName": "abc123",
"group": AttributeDefinitionGroup,
"abTestable": true,
"customerSegmentsAllowed": false,
"exportable": false,
"linkable": false,
"standard": false,
"mandatory": false,
"helpText": "xyz789",
"hasHelpText": true,
"mutationCommandType": "xyz789",
"allowedValues": [AllowedValue],
"searchable": true,
"valueType": "Text"
}
AttributeLevel
Description
Enum describing on which object type an attribute is defined.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Product"
AttributeLink
Types
| Union Types |
|---|
Example
ArticleLink
AttributeLinkInput
Description
Information to describe a link content attribute.
Fields
| Input Field | Description |
|---|---|
id - ID
|
The ID of the link content attribute. |
version - Long
|
The version of the link content attribute. |
openLinkInNewWindow - Boolean
|
Should the link be opened in a new window?. Default = false |
urlParameters - String
|
The URL parameters of the link. |
mcsInput - McsInput!
|
The mcs of the link content attribute. |
type - LinkType!
|
The type of the supplied link. |
articleLinkInput - ArticleLinkInput
|
An article link. When the link is an article link only this field may be filled. |
assetLinkInput - AssetLinkInput
|
An asset link. When the link is an asset link only this field may be filled. |
brandLinkInput - BrandLinkInput
|
A brand link. When the link is a brand link only this field may be filled. |
externalLinkInput - ExternalLinkInput
|
An external link. When the link is an external link only this field may be filled. |
layerLinkInput - LayerLinkInput
|
A layer link. When the link is a layer link only this field may be filled. |
pageLinkInput - PageLinkInput
|
A page link. When the link is a page link only this field may be filled. |
searchTermLinkInput - SearchTermLinkInput
|
A search term link. When the link is a search term link only this field may be filled. |
seoTermLinkInput - SEOTermLinkInput
|
A SEO term link. When the link is a SEO term link only this field may be filled. |
Example
{
"id": "4",
"version": {},
"openLinkInNewWindow": true,
"urlParameters": "abc123",
"mcsInput": McsInput,
"type": "ArticleLink",
"articleLinkInput": ArticleLinkInput,
"assetLinkInput": AssetLinkInput,
"brandLinkInput": BrandLinkInput,
"externalLinkInput": ExternalLinkInput,
"layerLinkInput": LayerLinkInput,
"pageLinkInput": PageLinkInput,
"searchTermLinkInput": SearchTermLinkInput,
"seoTermLinkInput": SEOTermLinkInput
}
AttributeOption
Description
Representation of an attribute option.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this attribute option. |
version - Long!
|
The version of this attribute option. |
value - String!
|
The value of this attribute option. |
displayNames - [MapType!]!
|
A list of display names for different languages. |
Example
{
"id": "4",
"version": {},
"value": "abc123",
"displayNames": [MapType]
}
AttributeOptionInput
AttributeTypeFilterInput
AttributeTypeFindPayload
Description
TYPES
Fields
| Field Name | Description |
|---|---|
entries - [AttributeDescriptionType!]!
|
|
totalCount - Int!
|
Example
{"entries": [AttributeDescriptionType], "totalCount": 987}
AttributeTypeUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [AttributeDescriptionType!]!
|
Example
{"entries": [AttributeDescriptionType]}
AttributeValueType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Text"
Audit
AvailabilityConditionType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
description - String
|
|
availabilityValue - [AvailabilityValue!]!
|
Example
{
"id": "4",
"displayName": "xyz789",
"description": "xyz789",
"availabilityValue": [AvailabilityValue]
}
AvailabilityValue
BackofficeCategory
Description
Backoffice representation of a shop category
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique ID of this category |
version - Long!
|
A version of the category entity |
simpleId - String!
|
The simple ID of this category |
name - String!
|
The human readable name of the category |
nameWithLocale - String!
|
The human readable name of the category translated according to the selected language |
primaryId - String!
|
The full, unique ID of this category |
mcs - Mcs!
|
The MCS containing this category |
ranking - Int!
|
The ranking helps decide the exact relation to other categories. |
path - String
|
The path for this category (Path from root to this category as category names). |
url - String
|
The URL path for this category (URL from root to this category as category URLs). |
valid - Boolean!
|
A flag describing if this category is valid |
smart - Boolean!
|
A flag describing if this category is a smartcategory |
parents - [BackofficeCategory!]!
|
A List of categories that are direct or indirect parents of this category. |
online - Boolean!
|
A flag describing if this category is online. |
childrenCount - Int
|
Children count to be used for expanding parents |
childCategories - [BackofficeCategory!]!
|
A List of categories that are direct or indirect parents of this category. |
status - CategoryStatus
|
INVALID: This category is invalid all the time VALID: This category is valid all the time FUTURE_VALID: This category will be available in the future and will be valid FUTURE_INVALID: This category will be available in the future and won't be valid |
Example
{
"id": 4,
"version": {},
"simpleId": "abc123",
"name": "xyz789",
"nameWithLocale": "abc123",
"primaryId": "abc123",
"mcs": Mcs,
"ranking": 123,
"path": "xyz789",
"url": "xyz789",
"valid": true,
"smart": true,
"parents": [BackofficeCategory],
"online": true,
"childrenCount": 123,
"childCategories": [BackofficeCategory],
"status": "INVALID"
}
BackofficeCategoryInput
Description
A Filter to describe categories
Fields
| Input Field | Description |
|---|---|
id - ID
|
The unique ID of a category |
version - Long
|
The version of the category. |
simpleId - String
|
the simple ID of a category |
mcsInput - McsInput!
|
The mcs of the category. |
searchTerm - String
|
A searchterm to create a category-like search from |
showFilterLevel - Boolean
|
Should Filter-Level Categories also be shown? Default is False. Default = false |
Example
{
"id": 4,
"version": {},
"simpleId": "abc123",
"mcsInput": McsInput,
"searchTerm": "xyz789",
"showFilterLevel": false
}
BackofficeMultiChannelSelector
Description
A split description of a MCS.
Fields
| Field Name | Description |
|---|---|
complete - Boolean!
|
A flag telling if this MCS is complete. |
brand - String
|
A brandname, if this MCS is for a specific brand. |
channel - String
|
A channel name, if this MCS is for a specific channel. |
country - String
|
A country, if this MCS is for a specific country. |
currency - String
|
A currency, if this MCS is for a specific currency. |
language - String
|
A language, if this MCS is for a specific language. |
store - String
|
A store name, if this MCS is for a specific store. |
Example
{
"complete": false,
"brand": "xyz789",
"channel": "xyz789",
"country": "abc123",
"currency": "xyz789",
"language": "abc123",
"store": "xyz789"
}
BackofficeUserInfoAudit
Fields
| Field Name | Description |
|---|---|
created - DateTime!
|
The date of creation |
updated - DateTime!
|
The date of the last update |
createdBy - UserInformation
|
BackofficeUser who created entity |
updatedBy - UserInformation
|
BackofficeUser who updated entity |
Example
{
"created": "2007-12-03T10:15:30Z",
"updated": "2007-12-03T10:15:30Z",
"createdBy": UserInformation,
"updatedBy": UserInformation
}
BandwidthInfo
Description
A bandwidth value
Fields
| Field Name | Description |
|---|---|
mcs - Mcs
|
The MCS. might be null for global fallback. |
bandwidthValue - Int!
|
The actual bandwidth value |
fallbackValue - BandwidthInfo
|
A possible fallback value of the global MCS. is null if mcs=null. |
isInherited - Boolean!
|
A check if the MCS is inherited from a given MCS. A simple check if mcs==referenceMcs |
Example
{
"mcs": Mcs,
"bandwidthValue": 123,
"fallbackValue": BandwidthInfo,
"isInherited": false
}
BaseContentAttributeInput
Description
A basic, not further divisible content attribute. At any time, only one of the value options in this object may be filled.
Fields
| Input Field | Description |
|---|---|
id - ID
|
The unique ID of this content attribute. |
version - Long
|
The version. |
stringList - [String!]
|
A list of Strings. For the type stringList only this field may be filled. |
integerValue - Int
|
An integer value. When the value is a integer value only this field may be filled. |
string - String
|
A String value. When the field is a normal text only this field may be filled. |
option - AttributeOptionInput
|
An option. This is the input for the option value for ComboBoxes. When the field is a combo box only this field may be filled. |
link - AttributeLinkInput
|
A link value. When the field is a link only this field may be filled. |
Example
{
"id": "4",
"version": {},
"stringList": ["abc123"],
"integerValue": 123,
"string": "abc123",
"option": AttributeOptionInput,
"link": AttributeLinkInput
}
BaseUrlPayload
Description
Data export base URL
Fields
| Field Name | Description |
|---|---|
baseUrl - String!
|
The base URL |
Example
{"baseUrl": "abc123"}
BenefitEntity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the benefit. |
version - Long!
|
The version of the benefit. |
title - String
|
The maintained title of the benefit |
image - ImageEntity
|
The maintained image for the benefit |
Example
{
"id": 4,
"version": {},
"title": "xyz789",
"image": ImageEntity
}
BenefitTarget
Description
Benefit target type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ITEM"
BigDecimal
Description
A scalar representing Java's java.math.BigDecimal
Example
BigDecimal
BoMcs
Description
Representation of standard MultiChannelSelector and MultiChannelSelector of translation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Id of entity |
version - Long!
|
Version of entity |
displayString - String!
|
Display name of MultiChannelSelector |
parent - Boolean!
|
A flag telling if this MultiChannelSelector has a parent |
parentMcs - BoMcs
|
The parent MultiChannelSelector of this MultiChannelSelector |
mcs - MultiChannelSelector!
|
Brand, language, country etc. information of MultiChannelSelector |
Example
{
"id": 4,
"version": {},
"displayString": "xyz789",
"parent": false,
"parentMcs": BoMcs,
"mcs": MultiChannelSelector
}
Boolean
Description
The Boolean scalar type represents true or false.
BooleanConditionValue
Fields
| Field Name | Description |
|---|---|
value - Boolean!
|
Example
{"value": true}
BooleanValue
Fields
| Field Name | Description |
|---|---|
boolean - Boolean!
|
Example
{"boolean": false}
BrandAttributeLink
Fields
| Field Name | Description |
|---|---|
link - AttributeLink!
|
|
mcs - Mcs!
|
Example
{"link": ArticleLink, "mcs": Mcs}
BrandCategory
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
|
deleteDate - DateTime
|
The date when the entry will be deleted or null if it won't be deleted |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
ancestors - [NavigationTreeEntry!]!
|
|
parent - NavigationTreeEntry
|
|
children - NavigationTreeEntryChildrenPayload!
|
|
Arguments
|
|
previewUrl - String!
|
|
Arguments
|
|
valid - Boolean!
|
|
status - CategoryStatus!
|
|
publishStatus - PublishStatus!
|
|
description - String
|
|
invalidReason - String
|
|
timeValidity - TimeValidity!
|
|
timeStatus - TimeValidityStatus!
|
use status attribute instead of timeStatus See: ISBO-15517 |
criteria - BrandCategoryCondition
|
|
sourceCategories - [NamedBrandCategory!]!
|
|
brandBlockList - [BrandEntity!]!
|
|
overwrittenValue - NavigationTreeEntry
|
|
originalTreeType - TreeType
|
|
paths - [String!]!
|
|
referenceType - PageReferenceType!
|
|
categoryParameters - CategoryParameterFindPayload!
|
|
Arguments
|
|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"name": "xyz789",
"deleteDate": "2007-12-03T10:15:30Z",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"ancestors": [NavigationTreeEntry],
"parent": NavigationTreeEntry,
"children": NavigationTreeEntryChildrenPayload,
"previewUrl": "abc123",
"valid": true,
"status": "INVALID",
"publishStatus": "PUBLISHED",
"description": "abc123",
"invalidReason": "xyz789",
"timeValidity": Campaign,
"timeStatus": "ACTIVE",
"criteria": BrandCategoryCondition,
"sourceCategories": [NamedBrandCategory],
"brandBlockList": [BrandEntity],
"overwrittenValue": NavigationTreeEntry,
"originalTreeType": "ArchiveTree",
"paths": ["abc123"],
"referenceType": "NONE",
"categoryParameters": CategoryParameterFindPayload
}
BrandCategoryChild
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
|
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
ancestors - [NavigationTreeEntry!]!
|
|
parent - NavigationTreeEntry!
|
|
children - NavigationTreeEntryChildrenPayload!
|
|
Arguments
|
|
valid - Boolean!
|
|
paths - [String!]!
|
|
status - CategoryStatus!
|
|
referenceType - PageReferenceType!
|
|
categoryParameters - CategoryParameterFindPayload!
|
|
Arguments
|
|
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"name": "xyz789",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"ancestors": [NavigationTreeEntry],
"parent": NavigationTreeEntry,
"children": NavigationTreeEntryChildrenPayload,
"valid": true,
"paths": ["xyz789"],
"status": "INVALID",
"referenceType": "NONE",
"categoryParameters": CategoryParameterFindPayload
}
BrandCategoryCondition
BrandConditionType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
description - String
|
|
brands - [BrandEntity!]!
|
Example
{
"id": 4,
"displayName": "xyz789",
"description": "abc123",
"brands": [BrandEntity]
}
BrandEntity
Description
Representation of a brand. This is only a start and should be extended with values you need.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this brand. |
version - Long!
|
The version of this brand. |
mcs - Mcs!
|
The MCS containing this brand. |
name - String!
|
The name of this brand. |
valid - Boolean!
|
The validity of this brand. |
updatedBy - UserInformation
|
The user who edited the brand |
status - BrandStatus!
|
The status of the brand |
images - [BrandImage!]!
|
The list of images for this brand. |
links - [BrandAttributeLink!]!
|
The list of links for this brand. |
parameters - [BrandParameter!]!
|
The list of brand parameters for this brand. |
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"name": "xyz789",
"valid": false,
"updatedBy": UserInformation,
"status": "VALID",
"images": [BrandImage],
"links": [BrandAttributeLink],
"parameters": [BrandParameter]
}
BrandFilterInput
Description
Filter options to find brand.
Fields
| Input Field | Description |
|---|---|
id - [ID!]
|
The brand IDs to search for. |
searchTerms - [String!]
|
List of search terms to look for in brand name. |
brandStatus - [BrandStatus!]
|
List of brand status to search for. |
noLinksAssigned - Boolean!
|
Flag to retrieve brands with no links assigned. Default = false |
currentUserOnly - Boolean
|
The backoffice user that created the brand |
Example
{
"id": [4],
"searchTerms": ["abc123"],
"brandStatus": ["VALID"],
"noLinksAssigned": true,
"currentUserOnly": true
}
BrandFindPayload
Description
A list of brands without further details as a result
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
The total amount of results found, unaffected by paging |
entries - [BrandEntity!]!
|
The result list of brands, affected by paging |
Example
{"totalCount": 123, "entries": [BrandEntity]}
BrandImage
Fields
| Field Name | Description |
|---|---|
image - ImageEntity!
|
|
mcs - Mcs!
|
Example
{"image": ImageEntity, "mcs": Mcs}
BrandLink
Description
The representation of a brand link.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this link. |
version - Long!
|
The version of this link. |
openLinkInNewWindow - Boolean!
|
Should the link be opened in a new window? |
urlParameters - String
|
The URL parameters of this link. |
anchorLink - String
|
The Anchor link of this link |
brand - BrandEntity!
|
The brand entity. |
Example
{
"id": 4,
"version": {},
"openLinkInNewWindow": false,
"urlParameters": "xyz789",
"anchorLink": "xyz789",
"brand": BrandEntity
}
BrandLinkInput
Description
Additional information to describe a brand link.
Fields
| Input Field | Description |
|---|---|
brandId - ID!
|
The ID of the brand. |
Example
{"brandId": 4}
BrandListConditionType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
description - String
|
|
brands - [BrandEntity!]!
|
Example
{
"id": "4",
"displayName": "xyz789",
"description": "abc123",
"brands": [BrandEntity]
}
BrandListConditionValue
Fields
| Field Name | Description |
|---|---|
value - [String!]!
|
Example
{"value": ["abc123"]}
BrandListValue
Fields
| Field Name | Description |
|---|---|
brands - [BrandEntity!]!
|
Example
{"brands": [BrandEntity]}
BrandPagingInput
Description
All relevant information needed to conduct a search
Fields
| Input Field | Description |
|---|---|
pagingInput - Paging!
|
Paging information Default return 100 entries from start. Default = {limit: 100, offset: 0} |
sortInput - BrandSortingInput!
|
Sorting information Default Ascending on brand name. Default = {sortOrder: ASC, sortType: NAME} |
Example
{
"pagingInput": Paging,
"sortInput": BrandSortingInput
}
BrandParameter
Description
Brand parameters
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this brand parameter. |
version - Long!
|
The version of this brand parameter. |
mcs - Mcs!
|
The mcs of this brand parameter. |
brand - BrandEntity!
|
The brand of this brand parameter |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
The audit and userInfo of this brand parameter. |
inherited - Boolean!
|
The inherited boolean of this brand parameter. |
parameterType - AttributeDescriptionType!
|
The parameterType of this brand parameter. |
attributeName - String!
|
The attributeName of this brand parameter. |
attributeValue - DynamicAttributeValue!
|
The attributeValue of this brand parameter. |
description - String
|
The description of this brand parameter. |
overwrites - BrandParameter
|
The parameter which is overwritten from upper mcs to show it as broken |
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"brand": BrandEntity,
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"inherited": true,
"parameterType": AttributeDescriptionType,
"attributeName": "xyz789",
"attributeValue": DynamicAttributeValue,
"description": "abc123",
"overwrites": BrandParameter
}
BrandParameterCopyPayload
Fields
| Field Name | Description |
|---|---|
entries - [BrandParameter!]!
|
Example
{"entries": [BrandParameter]}
BrandParameterCreatePayload
Fields
| Field Name | Description |
|---|---|
entries - [BrandParameter!]!
|
List of brand parameters |
Example
{"entries": [BrandParameter]}
BrandParameterDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Is successful deletion |
Example
{"successful": true}
BrandParameterFilterInput
BrandParameterFindPayload
Description
PAYLOADS
Fields
| Field Name | Description |
|---|---|
entries - [BrandParameter!]!
|
|
totalCount - Int!
|
Example
{"entries": [BrandParameter], "totalCount": 987}
BrandParameterUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [BrandParameter!]!
|
List of brand parameters |
Example
{"entries": [BrandParameter]}
BrandSortTypeInput
Description
Enum describing by what descriptor the returned brands should be sorted
Values
| Enum Value | Description |
|---|---|
|
|
Sort by brand name |
|
|
Sorts by inherited mcs, with entries of the current mcs always at the bottom. Sorting within the mcs entries is not defined. |
Example
"NAME"
BrandSortingInput
Description
Sorting information
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder
|
The sorting order. Default Ascending. Default = ASC |
sortType - BrandSortTypeInput
|
Which parameter should the result be sorted on. Default: brand name. Default = NAME |
Example
{"sortOrder": "ASC", "sortType": "NAME"}
BrandStatus
Description
ENUMS
Values
| Enum Value | Description |
|---|---|
|
|
The brand has image filled in |
|
|
The brand has not image filled in |
|
|
No products belonging to this brand are currently online |
Example
"VALID"
BrandUpdatePayload
Description
PAYLOADS
Fields
| Field Name | Description |
|---|---|
entries - [BrandEntity!]!
|
List of brand parameters |
Example
{"entries": [BrandEntity]}
Campaign
Description
Representation of a single campaign.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this campaign. |
version - Long!
|
The version of this campaign. |
name - String!
|
The name of this campaign. |
mcs - Mcs!
|
The MCS containing this campaign. |
startDate - DateTime!
|
The start of execution for this campaign. |
endDate - DateTime
|
The end of execution for this campaign. |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
Campaign audit includes createdAt, updatedAt, createdBy, and updatedBy. |
status - TimeValidityStatus!
|
The campaign status gives information about it's life cycle. |
references - [CampaignReference!]
|
The contents that reference the campaign |
Example
{
"id": 4,
"version": {},
"name": "abc123",
"mcs": Mcs,
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"status": "ACTIVE",
"references": [PromotionEntity]
}
CampaignCreatePayload
Description
Payload wrapper object for creating campaigns.
Fields
| Field Name | Description |
|---|---|
entries - [Campaign!]!
|
The list of created campaigns. |
Example
{"entries": [Campaign]}
CampaignDateInput
Fields
| Input Field | Description |
|---|---|
date - DateTime
|
New date |
Example
{"date": "2007-12-03T10:15:30Z"}
CampaignDeletePayload
Description
Payload wrapper object for deleting campaigns.
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Flag for success. |
Example
{"successful": true}
CampaignFilterInput
Description
Filter options to find campaigns.
Fields
| Input Field | Description |
|---|---|
id - [ID!]
|
The campaign IDs to search for. |
searchTerms - [String!]
|
List of search terms to look for in campaign name. |
status - [TimeValidityStatus!]
|
only results with given status will be returned if empty or null, results of all states will be returned multiple entries possible |
Example
{
"id": ["4"],
"searchTerms": ["xyz789"],
"status": ["ACTIVE"]
}
CampaignFindPayload
Description
A list of campaigns as a result
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
The total amount of results found, unaffected by paging |
entries - [Campaign!]!
|
The result list of campaigns, affected by paging |
Example
{"totalCount": 987, "entries": [Campaign]}
CampaignPagingInput
Description
All relevant information needed to conduct a search
Fields
| Input Field | Description |
|---|---|
pagingInput - Paging!
|
Paging information Default return 100 entries from start. Default = {limit: 100, offset: 0} |
sortInput - CampaignSortingInput!
|
Sorting information Default Ascending on campaign name. Default = {sortOrder: ASC, sortType: INFO} |
Example
{
"pagingInput": Paging,
"sortInput": CampaignSortingInput
}
CampaignReadInput
Description
Filter options to find a campaign.
This instance is only used for read input to get a customer segment.
Example
{
"id": "4",
"version": {},
"name": "xyz789",
"mcsInput": McsInput
}
CampaignReference
Description
Representation of content that reference the campaign
Example
PromotionEntity
CampaignSortTypeInput
Description
Enum describing by what descriptor the returned campaigns should be sorted
Values
| Enum Value | Description |
|---|---|
|
|
Sort by campaign name |
|
|
Sort by valid from date |
|
|
Sort by valid to date |
|
|
Sort by created at date |
|
|
Sort by updated at date |
|
|
Sorts by inherited mcs, with entries of the current mcs always at the bottom. Sorting within the mcs entries is not defined. |
|
|
Sort by campaign status |
Example
"NAME"
CampaignSortingInput
Description
Sorting information
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder
|
The sorting order. Default Ascending. Default = ASC |
sortType - CampaignSortTypeInput
|
Which parameter should the result be sorted on. Default: inherited campaigns. Default = INFO |
Example
{"sortOrder": "ASC", "sortType": "NAME"}
CampaignUpdatePayload
Description
Payload wrapper object for updating campaigns.
Fields
| Field Name | Description |
|---|---|
entries - [Campaign!]!
|
The list of updated campaigns. |
Example
{"entries": [Campaign]}
CampaignValidateUpdateInput
Description
Input for checking conflicts after editing contents or campaigns. Only one input is allowed.
Fields
| Input Field | Description |
|---|---|
campaignId - ID!
|
Id of campaign that the user wants to edit |
campaignStartDateInput - CampaignDateInput
|
Input to validate start date update |
campaignEndDateInput - CampaignDateInput
|
Input to validate end date update |
Example
{
"campaignId": "4",
"campaignStartDateInput": CampaignDateInput,
"campaignEndDateInput": CampaignDateInput
}
CampaignValidateUpdatePayload
Description
Payload of checking conflicts
Fields
| Field Name | Description |
|---|---|
campaign - Campaign!
|
Campaign to be edited |
affectedContents - AffectedContents!
|
The contents that will be affected in case of updating the campaign |
Example
{
"campaign": Campaign,
"affectedContents": AffectedContents
}
CanonicalCategoriesFindPayload
Description
A list of Canonical Categories
Fields
| Field Name | Description |
|---|---|
entries - [NavigationTreeEntry!]!
|
Example
{"entries": [NavigationTreeEntry]}
CategoryConditionOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Within"
CategoryConditionValue
Fields
| Field Name | Description |
|---|---|
value - NavigationTreeEntry
|
Represenets Category object. Nullable in case not exsits in OS |
operator - CategoryConditionOperator
|
Represenets Category operator (Within, NotWithin) |
Example
{"value": NavigationTreeEntry, "operator": "Within"}
CategoryHiddenListValue
Fields
| Field Name | Description |
|---|---|
hideIn - [HideCategory!]!
|
Example
{"hideIn": ["URL"]}
CategoryIgnoreListCreatePayload
Description
Payload wrapper object for creating category ignore list
Fields
| Field Name | Description |
|---|---|
entries - [DataExportCategoryIgnoreList!]!
|
List of created category ignore list |
Example
{"entries": [DataExportCategoryIgnoreList]}
CategoryIgnoreListDeletePayload
Description
Payload wrapper object for deleting category ignore list
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Flag for success. |
Example
{"successful": true}
CategoryIgnoreListPagingInput
Fields
| Input Field | Description |
|---|---|
pagingInput - Paging!
|
Paging information. Default = {limit: 100, offset: 0} |
sortInput - CategoryIgnoreListSortInput!
|
Sorting information. {Default asc by name}. Default = {sortOrder: ASC, sortColumn: NAME} |
Example
{
"pagingInput": Paging,
"sortInput": CategoryIgnoreListSortInput
}
CategoryIgnoreListSortColumn
Description
Representation in which will the result be sorted
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NAME"
CategoryIgnoreListSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
list order value (default order is ASC). Default = ASC |
sortColumn - CategoryIgnoreListSortColumn!
|
Column names which are allowed to sort with. Default = NAME |
Example
{"sortOrder": "ASC", "sortColumn": "NAME"}
CategoryIgnoreListUpdatePayload
Description
Payload wrapper object for updating category ignore list
Fields
| Field Name | Description |
|---|---|
entries - [DataExportCategoryIgnoreList!]!
|
Updated category ignore list |
Example
{"entries": [DataExportCategoryIgnoreList]}
CategoryIgnoreListsFilterInput
Fields
| Input Field | Description |
|---|---|
searchTerm - String
|
String keyword to search within category ignore list name |
Example
{"searchTerm": "xyz789"}
CategoryIgnoreListsFindPayload
Description
A list of category ignore list records
Fields
| Field Name | Description |
|---|---|
entries - [DataExportCategoryIgnoreList!]!
|
The list of category ignore lists |
totalCount - Int!
|
The complete count of category ignore list records |
Example
{
"entries": [DataExportCategoryIgnoreList],
"totalCount": 987
}
CategoryListConditionValue
Fields
| Field Name | Description |
|---|---|
value - [CategoryTree!]!
|
Represenets Categories List, can be empty in case categories not exsit in OS use LinkToCategoryTreeEntry |
categoryTreeEntries - [LinkToCategoryTreeEntry!]!
|
|
operator - CategoryConditionOperator!
|
Represenets Category operator (Within, NotWithin) |
Example
{
"value": [CategoryTree],
"categoryTreeEntries": [LinkToCategoryTreeEntry],
"operator": "Within"
}
CategoryListValue
Fields
| Field Name | Description |
|---|---|
categoryList - [NavigationTreeEntry!]!
|
Example
{"categoryList": [NavigationTreeEntry]}
CategoryPage
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
name - String!
|
|
valid - Boolean!
|
|
mcs - Mcs!
|
|
category - GraphQlCategory!
|
use NavigationTreeEntry |
navigationTreeEntry - NavigationTreeEntry!
|
|
referenceType - PageReferenceType!
|
Example
{
"id": "4",
"version": {},
"name": "xyz789",
"valid": false,
"mcs": Mcs,
"category": GraphQlCategory,
"navigationTreeEntry": NavigationTreeEntry,
"referenceType": "NONE"
}
CategoryParameter
Description
TYPES
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
category - GraphQlCategory!
|
use CategoryTreeEntry |
categoryTreeEntry - CategoryTreeEntry!
|
|
mcs - Mcs!
|
|
inherited - Boolean!
|
|
overwrites - CategoryParameter
|
|
parameterType - AttributeDescriptionType!
|
|
attributeValue - DynamicAttributeValue!
|
|
linkedToCategories - CategoryParameterLinkTargets!
|
|
description - String
|
|
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
Example
{
"id": "4",
"version": {},
"category": GraphQlCategory,
"categoryTreeEntry": CategoryTreeEntry,
"mcs": Mcs,
"inherited": true,
"overwrites": CategoryParameter,
"parameterType": AttributeDescriptionType,
"attributeValue": DynamicAttributeValue,
"linkedToCategories": CategoryParameterLinkTargets,
"description": "xyz789",
"backofficeUserInfoAudit": BackofficeUserInfoAudit
}
CategoryParameterAttributeCopyPayload
Fields
| Field Name | Description |
|---|---|
entries - [CategoryParameter!]!
|
Example
{"entries": [CategoryParameter]}
CategoryParameterAttributeCreatePayload
Description
PAYLOADS
Fields
| Field Name | Description |
|---|---|
entries - [CategoryParameter!]!
|
Example
{"entries": [CategoryParameter]}
CategoryParameterAttributeDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": true}
CategoryParameterAttributeUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [CategoryParameter!]!
|
Example
{"entries": [CategoryParameter]}
CategoryParameterFilterInput
Description
QUERY INPUT
Fields
| Input Field | Description |
|---|---|
parameterIds - [ID!]
|
|
categoryIds - [ID!]
|
|
showLinkedParameter - Boolean!
|
|
parameterTypeById - [ID!]
|
|
parameterTypeByKey - [String!]
|
|
searchValue - String
|
|
status - [TimeValidityStatus!]
|
|
campaignId - ID
|
When filter for campaign, filter for start or end will be ignored |
startDate - DateTime
|
|
endDate - DateTime
|
Example
{
"parameterIds": ["4"],
"categoryIds": ["4"],
"showLinkedParameter": false,
"parameterTypeById": [4],
"parameterTypeByKey": ["xyz789"],
"searchValue": "abc123",
"status": ["ACTIVE"],
"campaignId": 4,
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z"
}
CategoryParameterFindPayload
Description
PAYLOADS
Fields
| Field Name | Description |
|---|---|
entries - [CategoryParameter!]!
|
|
totalCount - Int
|
Example
{"entries": [CategoryParameter], "totalCount": 123}
CategoryParameterLinkTargets
Fields
| Field Name | Description |
|---|---|
linkTo - [LinkToCategoryTreeEntry!]!
|
|
Arguments
|
|
overwriteExistingValue - Boolean!
|
|
Example
{
"linkTo": [LinkToCategoryTreeEntry],
"overwriteExistingValue": false
}
CategoryStatus
Values
| Enum Value | Description |
|---|---|
|
|
Category is invalid all the time |
|
|
Category is valid |
|
|
If the category will be available in the future and will be valid |
|
|
If the category will be available in the future and won't be valid |
Example
"INVALID"
CategoryTree
Description
deprecated use LinkToCategoryTreeEntry
Fields
| Field Name | Description |
|---|---|
category - NavigationTreeEntry
|
Backoffice category, can be null due to missing category inside object storage |
includeSubTree - Boolean
|
Determine if the selected category should include children or not |
mcs - Mcs!
|
The MCS which this record was added |
Example
{
"category": NavigationTreeEntry,
"includeSubTree": true,
"mcs": Mcs
}
CategoryTreeEntry
Description
Defines the types that can be part of the category tree.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
|
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
ancestors - [NavigationTreeEntry!]!
|
|
parent - NavigationTreeEntry
|
|
children - NavigationTreeEntryChildrenPayload!
|
|
Arguments
|
|
valid - Boolean!
|
|
referenceType - PageReferenceType!
|
|
categoryParameters - CategoryParameterFindPayload!
|
|
Arguments
|
|
Possible Types
| CategoryTreeEntry Types |
|---|
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"name": "xyz789",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"ancestors": [NavigationTreeEntry],
"parent": NavigationTreeEntry,
"children": NavigationTreeEntryChildrenPayload,
"valid": false,
"referenceType": "NONE",
"categoryParameters": CategoryParameterFindPayload
}
CategoryTreeFilterInput
Description
INPUT
Fields
| Input Field | Description |
|---|---|
ids - [ID!]!
|
Category entity ids to be searched inside navigation tree nodes paths, which is referenced to CategoryEntity. Default = [] |
names - [String!]!
|
|
status - [TimeValidityStatus!]!
|
|
hasContent - Boolean
|
|
hidden - Boolean
|
|
navigationPageTypes - [NavigationPageTypes!]!
|
Example
{
"ids": [4],
"names": ["abc123"],
"status": ["ACTIVE"],
"hasContent": true,
"hidden": false,
"navigationPageTypes": ["PIM_CATEGORY"]
}
CategoryTreeFindPayload
Description
TYPES
Fields
| Field Name | Description |
|---|---|
entries - [NavigationTreeEntry!]!
|
|
totalCount - Int!
|
Example
{"entries": [NavigationTreeEntry], "totalCount": 987}
CategoryTreeNodeCopyPayload
Fields
| Field Name | Description |
|---|---|
entries - [NavigationTreeEntry!]!
|
Example
{"entries": [NavigationTreeEntry]}
CategoryTreeNodeCreatePayload
Description
TYPES
Fields
| Field Name | Description |
|---|---|
entries - [NavigationTreeEntry!]!
|
Example
{"entries": [NavigationTreeEntry]}
CategoryTreeNodeDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": true}
CategoryTreeNodePreviewFilterInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
Example
{"id": "4"}
CategoryTreeNodePreviewInput
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
add - CreateCategoryTreeNodeInput
|
|
update - UpdateCategoryTreeNodeInput
|
Example
{
"add": CreateCategoryTreeNodeInput,
"update": UpdateCategoryTreeNodeInput
}
CategoryTreeNodePreviewPayload
Fields
| Field Name | Description |
|---|---|
node - PreviewCategory!
|
Example
{"node": PreviewCategory}
CategoryTreeNodeUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [NavigationTreeEntry!]!
|
Example
{"entries": [NavigationTreeEntry]}
CategoryTreePagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging
|
|
sorting - CategoryTreeSortInput
|
Example
{
"paging": Paging,
"sorting": CategoryTreeSortInput
}
CategoryTreeSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder
|
|
sortColumn - CategoryTreeSortType
|
Example
{"sortOrder": "ASC", "sortColumn": "RANKING"}
CategoryTreeSortType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"RANKING"
CategoryValue
Fields
| Field Name | Description |
|---|---|
categoryTreeEntry - CategoryTreeEntry!
|
Example
{"categoryTreeEntry": CategoryTreeEntry}
CheckAiHubStatusPayload
ClipboardContainerContent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
gridElementContainer - GridElementContainer
|
Example
{
"id": 4,
"version": {},
"gridElementContainer": GridElementContainer
}
ClipboardDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": false}
ColorListConditionType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
description - String
|
|
colors - [FilterValue!]!
|
Example
{
"id": 4,
"displayName": "abc123",
"description": "abc123",
"colors": [FilterValue]
}
ColorListConditionValue
Fields
| Field Name | Description |
|---|---|
value - [String!]!
|
Example
{"value": ["xyz789"]}
ComboBox
Fields
| Field Name | Description |
|---|---|
option - AttributeOption
|
Example
{"option": AttributeOption}
ComboboxConditionType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
description - String
|
|
allowedValues - [AllowedValue!]!
|
Example
{
"id": 4,
"displayName": "abc123",
"description": "xyz789",
"allowedValues": [AllowedValue]
}
CommonFilterConditionValue
ComparisonOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"GREATER_THAN_EQ"
ComplexCondition
Description
Complex condtion object has list of conditions & connected by operator
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the condition. |
version - Long
|
The version of the condition. |
conditions - [Condition!]!
|
List of conditions objects(either simple or complex) |
operator - Connect!
|
Connect operator between conditions (AND, OR) |
Example
{
"id": 4,
"version": {},
"conditions": [ComplexCondition],
"operator": "AND"
}
Condition
Types
| Union Types |
|---|
Example
ComplexCondition
ConditionType
Example
{
"id": 4,
"displayName": "xyz789",
"description": "abc123"
}
ConditionTypeFindPayload
Fields
| Field Name | Description |
|---|---|
elements - [ConditionType!]!
|
|
totalCount - Int!
|
Example
{"elements": [ConditionType], "totalCount": 123}
ConditionValue
Types
| Union Types |
|---|
Example
BooleanConditionValue
Configuration
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"configKey": "xyz789",
"configValue": "xyz789"
}
ConfigurationFilterInput
Fields
| Input Field | Description |
|---|---|
configKey - String
|
The config key to search for |
Example
{"configKey": "abc123"}
ConfigurationFindPayload
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
The total amount of results found, unaffected by paging |
entries - [Configuration!]!
|
The result list of configurations, affected by paging |
Example
{"totalCount": 123, "entries": [Configuration]}
ConfigurationPagingInput
Fields
| Input Field | Description |
|---|---|
sortingInput - ConfigurationSorting!
|
Sorting information. Default = {sortColumn: INFO, sortOrder: DESC} |
pagingInput - Paging!
|
Paging information. Default = {limit: 100, offset: 0} |
Example
{
"sortingInput": ConfigurationSorting,
"pagingInput": Paging
}
ConfigurationSortColumn
Description
Enum Representation of the columns used for sorting in Configurations.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"INFO"
ConfigurationSorting
Description
Sorting information.
Fields
| Input Field | Description |
|---|---|
sortColumn - ConfigurationSortColumn!
|
The column by which the Configuration should be sorted. Default: INFO. Default = INFO |
sortOrder - SortOrder!
|
The sort direction. Default: Descending. Default = DESC |
Example
{"sortColumn": "INFO", "sortOrder": "ASC"}
Connect
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AND"
ConnectedIProductStatus
Description
Representation of all relevant connected products status
Example
{"id": 4, "version": {}, "productId": {}, "useCaseId": {}, "active": false}
ConnectedIProductsFilterInput
ConnectedIProductsPagingInput
Description
Paging to connected product status
Fields
| Input Field | Description |
|---|---|
sortOn - ConnectedIProductsSortingInput!
|
Sorting information.{Default Descending on Id field}. Default = {sortOrder: ASC, sortColumn: PRODUCT_ID} |
paging - Paging!
|
Paging information.{Default return 100 entries from start}. Default = {limit: 100, offset: 0} |
Example
{
"sortOn": ConnectedIProductsSortingInput,
"paging": Paging
}
ConnectedIProductsSortColumn
Description
Representation in which will the result be sorted
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PRODUCT_ID"
ConnectedIProductsSortingInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
list order value (default order is ASC). Default = ASC |
sortColumn - ConnectedIProductsSortColumn!
|
Column names which are allowed to sort with. Default = PRODUCT_ID |
Example
{"sortOrder": "ASC", "sortColumn": "PRODUCT_ID"}
ConnectedIProductsStatusCreatePayload
Fields
| Field Name | Description |
|---|---|
entries - [ConnectedIProductStatus!]!
|
List of connected iProducts status |
Example
{"entries": [ConnectedIProductStatus]}
ConnectedIProductsStatusDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": true}
ConnectedIProductsStatusFindPayload
Fields
| Field Name | Description |
|---|---|
entries - [ConnectedIProductStatus!]!
|
The list of voucher groups after applying paging, sorting and filtering. |
totalCount - Int!
|
The count of voucher groups |
Example
{"entries": [ConnectedIProductStatus], "totalCount": 123}
ContentAttribute
Description
A content Attribute database entity. It might be divided into differing content Attributes by either customer segments or AB-Testscenarios. At any time, only one of the value options in this object may be filled.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique ID of this content attribute |
version - Long!
|
The version |
status - GlobalParameterStatus!
|
The status of this content attribute, giving additional information about it's life cycle |
stringList - [String!]!
|
A list of Strings For the type stringList this field has to be filled. If this Content Attribute is further divided, no value will be displayed here. When the field is a string list only this value will be filled. |
integerValue - Int
|
An integer value. When the value is a integer value this field has to be filled. If this Content Attribute is further divided, no value will be displayed here. When the field is an integer only this value will be filled. |
string - String
|
A String value When the field is a normal text this has to be filled. If this Content Attribute is further divided, no value will be displayed here. When the field is a string only this value will be filled. |
option - AttributeOption
|
An option This is the input for the option value for ComboBoxes. If this Content Attribute is further divided, no value will be displayed here. When the field is a combo box only this value will be filled. |
link - AttributeLink
|
A link. When the field is a link this has to be filled. If this Content Attribute is further divided, no value will be displayed here. When the field is a link only this field value will be filled. |
startDate - DateTime!
|
The start of the time frame where this content attribute should be used. |
endDate - DateTime
|
The end of the time frame where this content attribute should be used. |
campaign - Campaign
|
Optional value giving a campaign context to this content attribute. |
customerSegmented - Boolean!
|
A flag describing if this Content attribute is divided by customer segments. |
abTested - Boolean!
|
A flag describing if this Content attribute is divided by AB-Testscenarios. |
customerSegmentContentAttributes - [CustomerSegmentContentAttribute!]!
|
A List of content attribute values for specific customer segments. If this content attribute is not divided by customer segments, this value will be left blank. |
scenarioContentAttributes - [AbScenarioContentAttribute!]!
|
A List of content attribute values for specific AB-Testscenarios. If this content attribute is not divided by AB-Testscenarios, this value will be left blank. |
Example
{
"id": "4",
"version": {},
"status": "ALL",
"stringList": ["xyz789"],
"integerValue": 987,
"string": "abc123",
"option": AttributeOption,
"link": ArticleLink,
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"campaign": Campaign,
"customerSegmented": true,
"abTested": true,
"customerSegmentContentAttributes": [
CustomerSegmentContentAttribute
],
"scenarioContentAttributes": [
AbScenarioContentAttribute
]
}
ContentAttributeDynamicValue
Types
| Union Types |
|---|
Example
CustomerSegmentedList
ContentAttributeInput
Description
A content Attribute. It might be divided into differing content Attributes by either customer segments or AB-Testscenarios.
Fields
| Input Field | Description |
|---|---|
baseContentInput - BaseContentAttributeInput
|
The content attribute value. If this content attribute is further divided by customer segments or AB-Testscenarios, this value must be left blank. |
startDate - DateTime
|
The start of the time frame where this content attribute should be used. |
endDate - DateTime
|
The end of the time frame where this content attribute should be used. |
campaign - CampaignReadInput
|
Optional value giving a campaign context to this content attribute. |
customerSegmentContentAttributes - [CustomerSegmentContentAttributeInput!]
|
A List of content attribute values for specific customer segments. If this content attribute is not divided by customer segments, this value must be left blank. |
scenarioContentAttributes - [AbScenarioContentAttributeInput!]
|
A List of content attribute values for specific AB-Testscenarios. If this content attribute is not divided by AB-Testscenarios, this value must be left blank. |
Example
{
"baseContentInput": BaseContentAttributeInput,
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"campaign": CampaignReadInput,
"customerSegmentContentAttributes": [
CustomerSegmentContentAttributeInput
],
"scenarioContentAttributes": [
AbScenarioContentAttributeInput
]
}
ContentNodeFilterInput
Description
INPUT
Fields
| Input Field | Description |
|---|---|
ids - [ID!]!
|
|
names - [String!]!
|
|
status - [TimeValidityStatus!]!
|
|
hasContent - Boolean
|
|
hidden - Boolean
|
Example
{
"ids": ["4"],
"names": ["abc123"],
"status": ["ACTIVE"],
"hasContent": true,
"hidden": false
}
ContentNodeFindPayload
Description
TYPES
Fields
| Field Name | Description |
|---|---|
entries - [CuratedPage!]!
|
|
totalCount - Int!
|
Example
{"entries": [CuratedPage], "totalCount": 123}
ContentNodePagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging
|
|
sorting - ContentNodeSortInput
|
Example
{
"paging": Paging,
"sorting": ContentNodeSortInput
}
ContentNodeSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder
|
|
sortColumn - ContentNodeSortType
|
Example
{"sortOrder": "ASC", "sortColumn": "INFO"}
ContentNodeSortType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"INFO"
ContentParameterLinkTargets
Fields
| Field Name | Description |
|---|---|
linkToLandingTreeEntry - [LinkToLandingTreeEntry!]!
|
|
Arguments
|
|
linkToContentTreeEntry - [LinkToContentTreeEntry!]!
|
|
Arguments
|
|
linkToMaintainTreeEntry - [LinkToMaintainTreeEntry!]!
|
|
Arguments
|
|
linkToProductPageTreeEntry - [LinkToProductPageTreeEntry!]!
|
|
Arguments
|
|
linkToSearchTermGroupTreeEntry - [LinkToSearchTermGroupTreeEntry!]!
|
|
Arguments
|
|
overwriteExistingValue - Boolean!
|
|
Example
{
"linkToLandingTreeEntry": [LinkToLandingTreeEntry],
"linkToContentTreeEntry": [LinkToContentTreeEntry],
"linkToMaintainTreeEntry": [LinkToMaintainTreeEntry],
"linkToProductPageTreeEntry": [
LinkToProductPageTreeEntry
],
"linkToSearchTermGroupTreeEntry": [
LinkToSearchTermGroupTreeEntry
],
"overwriteExistingValue": true
}
ContentTimelineEvent
Description
Contentchanges or Gridchanges on current mcs
Fields
| Field Name | Description |
|---|---|
start - DateTime
|
|
end - DateTime
|
|
eventType - ContentTimelineEventType!
|
Example
{
"start": "2007-12-03T10:15:30Z",
"end": "2007-12-03T10:15:30Z",
"eventType": "COMPLETE_RASTER"
}
ContentTimelineEventType
Values
| Enum Value | Description |
|---|---|
|
|
all is maintained |
|
|
some gridcontainer are maintained |
|
|
grid is there, but all gridcontainer are empty |
Example
"COMPLETE_RASTER"
ContentTimelineFilterInput
Description
Resultlist contains all active events inside given timerange for given page. Optionally filtered by given CustomerSegment and/or AbScenario
Example
{
"startTime": "2007-12-03T10:15:30Z",
"endTime": "2007-12-03T10:15:30Z",
"pageId": 4,
"customerSegmentId": "4",
"abScenarioId": 4
}
ContentTimelineFindPayload
Fields
| Field Name | Description |
|---|---|
entries - [TimelineEvent!]!
|
|
totalCount - Int!
|
Example
{"entries": [InheritedTimelineEvent], "totalCount": 123}
ContentTimelinePagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
|
sorting - ContentTimelineSortingInput!
|
Example
{
"paging": Paging,
"sorting": ContentTimelineSortingInput
}
ContentTimelineSortColumn
Values
| Enum Value | Description |
|---|---|
|
|
Example
"TIME"
ContentTimelineSortingInput
Fields
| Input Field | Description |
|---|---|
sortColumn - ContentTimelineSortColumn!
|
TIME: Resultlist is sorted by type and then by startDate. Default = TIME |
sortOrder - SortOrder!
|
ASC: - type -> InheritedTimelineEvent, ContentTimelineEvent, AbTimelineEvent, PreviousTimelineEvent, NextTimelineEvent
|
Example
{"sortColumn": "TIME", "sortOrder": "ASC"}
ContentTreeEntry
Description
Defines the types that can be part of the content tree.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
|
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
ancestors - [NavigationTreeEntry!]!
|
|
parent - NavigationTreeEntry
|
|
children - NavigationTreeEntryChildrenPayload!
|
|
Arguments
|
|
valid - Boolean!
|
|
status - CategoryStatus!
|
|
overwrittenValue - NavigationTreeEntry
|
|
referenceType - PageReferenceType!
|
|
Possible Types
| ContentTreeEntry Types |
|---|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"name": "abc123",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"ancestors": [NavigationTreeEntry],
"parent": NavigationTreeEntry,
"children": NavigationTreeEntryChildrenPayload,
"valid": false,
"status": "INVALID",
"overwrittenValue": NavigationTreeEntry,
"referenceType": "NONE"
}
ContentTreeLink
Description
The representation of a content tree link.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this link. |
version - Long!
|
The version of this link. |
openLinkInNewWindow - Boolean!
|
Should the link be opened in a new window? |
anchorLink - String
|
The Anchor link of this link |
urlParameters - String
|
The URL parameters of this link. |
node - ContentTreeNode!
|
The content tree node entity. |
Example
{
"id": 4,
"version": {},
"openLinkInNewWindow": true,
"anchorLink": "xyz789",
"urlParameters": "xyz789",
"node": ContentTreeNode
}
ContentTreeNode
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
name - String!
|
|
mcs - Mcs!
|
The MCS containing this node. |
parentNode - ID
|
parent node id or null |
parentNodeNode - ContentTreeNode
|
full parent node or null |
hasChildren - Boolean!
|
Flag if this node has children |
children - [ContentTreeNode!]!
|
|
childrenCount - Long!
|
|
pageId - ID!
|
Example
{
"id": 4,
"version": {},
"name": "abc123",
"mcs": Mcs,
"parentNode": "4",
"parentNodeNode": ContentTreeNode,
"hasChildren": true,
"children": [ContentTreeNode],
"childrenCount": {},
"pageId": "4"
}
ContentTreeNodeCopyPayload
Fields
| Field Name | Description |
|---|---|
entries - [CuratedPage!]!
|
Example
{"entries": [CuratedPage]}
ContentTreeNodeCreatePayload
Description
PAYLOAD
Fields
| Field Name | Description |
|---|---|
entries - [CuratedPage!]!
|
Example
{"entries": [CuratedPage]}
ContentTreeNodeDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": false}
ContentTreeNodeFilterInput
ContentTreeNodeFindPayload
Description
A list of content tree nodes without further details as a result
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
The total amount of results found, unaffected by paging |
entries - [ContentTreeNode!]!
|
The result list of nodes, affected by paging |
Example
{"totalCount": 123, "entries": [ContentTreeNode]}
ContentTreeNodePagingInput
Description
All relevant information needed to conduct a search
Fields
| Input Field | Description |
|---|---|
pagingInput - Paging!
|
Paging information Default return 100 entries from start. Default = {limit: 100, offset: 0} |
sortInput - ContentTreeNodeSortingInput!
|
Sorting information Default Ascending on content tree node page name. Default = {sortOrder: ASC, sortType: NAME} |
Example
{
"pagingInput": Paging,
"sortInput": ContentTreeNodeSortingInput
}
ContentTreeNodeSortTypeInput
Description
Enum describing by what descriptor the returned content tree nodes should be sorted
Values
| Enum Value | Description |
|---|---|
|
|
Sort by name |
Example
"NAME"
ContentTreeNodeSortingInput
Description
Sorting information
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
The sorting order. Default Ascending. Default = ASC |
sortType - ContentTreeNodeSortTypeInput!
|
Which parameter should the result be sorted on. Default: name. Default = NAME |
Example
{"sortOrder": "ASC", "sortType": "NAME"}
ContentTreeNodeUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [CuratedPage!]!
|
Example
{"entries": [CuratedPage]}
ContentTreeParameter
Description
TYPES
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
contentPage - CuratedPage!
|
|
page - Page!
|
This is only a temporary fix and should be fixed with ISBO-12965. |
mcs - Mcs!
|
|
inherited - Boolean!
|
|
overwrites - PageParameter
|
|
parameterType - AttributeDescriptionType!
|
|
attributeValue - DynamicAttributeValue!
|
|
linkTo - ContentParameterLinkTargets!
|
|
description - String
|
|
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
pageType - PageReferenceType!
|
Example
{
"id": "4",
"version": {},
"contentPage": CuratedPage,
"page": Page,
"mcs": Mcs,
"inherited": false,
"overwrites": PageParameter,
"parameterType": AttributeDescriptionType,
"attributeValue": DynamicAttributeValue,
"linkTo": ContentParameterLinkTargets,
"description": "xyz789",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"pageType": "NONE"
}
ContentTreeParameterAttributeCopyPayload
Fields
| Field Name | Description |
|---|---|
entries - [ContentTreeParameter!]!
|
Example
{"entries": [ContentTreeParameter]}
ContentTreeParameterAttributeCreatePayload
Description
PAYLOADS
Fields
| Field Name | Description |
|---|---|
entries - [ContentTreeParameter!]!
|
Example
{"entries": [ContentTreeParameter]}
ContentTreeParameterAttributeDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": true}
ContentTreeParameterAttributeUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [ContentTreeParameter!]!
|
Example
{"entries": [ContentTreeParameter]}
ContentTreeParameterFilterInput
Description
QUERY INPUT
Fields
| Input Field | Description |
|---|---|
parameterIds - [ID!]
|
|
pageIds - [ID!]
|
|
showLinkedParameter - Boolean!
|
|
parameterTypeById - [ID!]
|
|
parameterTypeByKey - [String!]
|
|
searchValue - String
|
|
status - [TimeValidityStatus!]
|
|
campaignId - ID
|
When filter for campaign, filter for start or end will be ignored |
startDate - DateTime
|
|
endDate - DateTime
|
Example
{
"parameterIds": ["4"],
"pageIds": ["4"],
"showLinkedParameter": false,
"parameterTypeById": ["4"],
"parameterTypeByKey": ["abc123"],
"searchValue": "xyz789",
"status": ["ACTIVE"],
"campaignId": 4,
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z"
}
ContentTreeParameterFindPayload
Description
PAYLOADS
Fields
| Field Name | Description |
|---|---|
entries - [ContentTreeParameter!]!
|
|
totalCount - Int!
|
Example
{"entries": [ContentTreeParameter], "totalCount": 987}
ContentType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
name - String!
|
|
icon - String!
|
|
teaserTemplates - [TeaserTemplate!]!
|
|
attributes - [AttributeDescriptionType!]!
|
Example
{
"id": "4",
"version": {},
"name": "xyz789",
"icon": "xyz789",
"teaserTemplates": [TeaserTemplate],
"attributes": [AttributeDescriptionType]
}
ContentTypeFilterInput
Fields
| Input Field | Description |
|---|---|
contentIds - [ID!]
|
Example
{"contentIds": ["4"]}
ContentTypeFindPayload
Fields
| Field Name | Description |
|---|---|
entries - [ContentType!]!
|
|
totalCount - Int!
|
Example
{"entries": [ContentType], "totalCount": 123}
ConvertToAbTest
Fields
| Input Field | Description |
|---|---|
scenarioId - ID!
|
The scenario id of an test to which the parameter should be converted. The non-segmented value will be the first value, if not updated in a separate update command. |
Example
{"scenarioId": "4"}
ConvertToCustomerSegment
Fields
| Input Field | Description |
|---|---|
customerSegmentIds - [ID!]!
|
Example
{"customerSegmentIds": [4]}
Coordinates
CoordinatesInput
CopyArticleListScoreInput
Fields
| Input Field | Description |
|---|---|
idToCopy - EntityId!
|
|
ops - [UpdateArticleListScoreOperation!]!
|
Example
{
"idToCopy": EntityId,
"ops": [UpdateArticleListScoreOperation]
}
CopyBrandParameterInput
Fields
| Input Field | Description |
|---|---|
idToCopy - EntityId!
|
ID of the parameter which should be copied |
ops - [CopyBrandParameterOperation!]!
|
Example
{
"idToCopy": EntityId,
"ops": [CopyBrandParameterOperation]
}
CopyBrandParameterOperation
Fields
| Input Field | Description |
|---|---|
setParameterDescription - SetParameterDescription
|
|
setTimeValidity - SetTimeValidity
|
|
removeTimeValidity - RemoveTimeValidity
|
|
updateValue - SetDynamicValueOperation
|
Example
{
"setParameterDescription": SetParameterDescription,
"setTimeValidity": SetTimeValidity,
"removeTimeValidity": RemoveTimeValidity,
"updateValue": SetDynamicValueOperation
}
CopyCategoryParameterInput
Fields
| Input Field | Description |
|---|---|
idToCopy - EntityId!
|
ID of the parameter which should be copied |
ops - [CopyCategoryParameterOperation!]!
|
The operations which are meant to executed for the attribute. |
Example
{
"idToCopy": EntityId,
"ops": [CopyCategoryParameterOperation]
}
CopyCategoryParameterOperation
Fields
| Input Field | Description |
|---|---|
setParameterDescription - SetParameterDescription
|
|
setTimeValidity - SetTimeValidity
|
|
removeTimeValidity - RemoveTimeValidity
|
|
updateValue - SetDynamicValueOperation
|
|
addLinkToCategoryTreeEntry - AddLinkToCategoryTreeEntry
|
|
removeLinkToCategoryTreeEntry - RemoveLinkToCategoryTreeEntry
|
|
setOverwriteExistingValue - SetOverwriteExistingValue
|
|
setCategoryId - SetCategoryId
|
Example
{
"setParameterDescription": SetParameterDescription,
"setTimeValidity": SetTimeValidity,
"removeTimeValidity": RemoveTimeValidity,
"updateValue": SetDynamicValueOperation,
"addLinkToCategoryTreeEntry": AddLinkToCategoryTreeEntry,
"removeLinkToCategoryTreeEntry": RemoveLinkToCategoryTreeEntry,
"setOverwriteExistingValue": SetOverwriteExistingValue,
"setCategoryId": SetCategoryId
}
CopyCategoryTreeNodeInput
Description
COPY
Fields
| Input Field | Description |
|---|---|
idToCopy - EntityId!
|
|
ops - [CopyCategoryTreeNodeOperation!]!
|
Example
{
"idToCopy": EntityId,
"ops": [CopyCategoryTreeNodeOperation]
}
CopyCategoryTreeNodeOperation
Fields
| Input Field | Description |
|---|---|
updateCuratedPage - UpdateCuratedPageOperation
|
|
updateSmartCategory - UpdateSmartCategoryOperation
|
|
updateFilterCategory - UpdateFilterCategoryOperation
|
|
updateBrandCategory - UpdateBrandCategoryOperation
|
|
updateFilterLevel - UpdateFilterLevelOperation
|
Example
{
"updateCuratedPage": UpdateCuratedPageOperation,
"updateSmartCategory": UpdateSmartCategoryOperation,
"updateFilterCategory": UpdateFilterCategoryOperation,
"updateBrandCategory": UpdateBrandCategoryOperation,
"updateFilterLevel": UpdateFilterLevelOperation
}
CopyContainer
Fields
| Input Field | Description |
|---|---|
idToCopy - EntityId!
|
|
ops - [UpdateContainerOperation!]!
|
Example
{
"idToCopy": EntityId,
"ops": [UpdateContainerOperation]
}
CopyContainerToClipboardInput
CopyContainerToClipboardPayload
Fields
| Field Name | Description |
|---|---|
entries - [ClipboardContainerContent!]!
|
Example
{"entries": [ClipboardContainerContent]}
CopyContentTreeNodeInput
Fields
| Input Field | Description |
|---|---|
idToCopy - EntityId!
|
|
ops - [UpdateContentPageOperation!]!
|
Example
{
"idToCopy": EntityId,
"ops": [UpdateContentPageOperation]
}
CopyContentTreeParameterInput
Fields
| Input Field | Description |
|---|---|
idToCopy - EntityId!
|
ID of the parameter which should be copied |
ops - [CopyContentTreeParameterOperation!]!
|
The operations which are meant to executed for the attribute. |
Example
{
"idToCopy": EntityId,
"ops": [CopyContentTreeParameterOperation]
}
CopyContentTreeParameterOperation
Fields
| Input Field | Description |
|---|---|
setParameterDescription - SetParameterDescription
|
|
setTimeValidity - SetTimeValidity
|
|
removeTimeValidity - RemoveTimeValidity
|
|
updateValue - SetDynamicValueOperation
|
|
addLinkToLandingTreeEntry - AddLinkToLandingTreeEntry
|
|
removeLinkToLandingTreeEntry - RemoveLinkToLandingTreeEntry
|
|
addLinkToContentTreeEntry - AddLinkToContentTreeEntry
|
|
removeLinkToContentTreeEntry - RemoveLinkToContentTreeEntry
|
|
addLinkToMaintainTreeEntry - AddLinkToMaintainTreeEntry
|
|
removeLinkToMaintainTreeEntry - RemoveLinkToMaintainTreeEntry
|
|
setOverwriteExistingValue - SetOverwriteExistingValue
|
|
addLinkToProductPageTreeEntry - AddLinkToProductPageTreeEntry
|
|
removeLinkToProductPageTreeEntry - RemoveLinkToProductPageTreeEntry
|
|
addLinkToSearchTermGroupTreeEntry - AddLinkToSearchTermGroupTreeEntry
|
|
removeLinkToSearchTermGroupTreeEntry - RemoveLinkToSearchTermGroupTreeEntry
|
|
setContentTreeId - SetContentTreeId
|
Example
{
"setParameterDescription": SetParameterDescription,
"setTimeValidity": SetTimeValidity,
"removeTimeValidity": RemoveTimeValidity,
"updateValue": SetDynamicValueOperation,
"addLinkToLandingTreeEntry": AddLinkToLandingTreeEntry,
"removeLinkToLandingTreeEntry": RemoveLinkToLandingTreeEntry,
"addLinkToContentTreeEntry": AddLinkToContentTreeEntry,
"removeLinkToContentTreeEntry": RemoveLinkToContentTreeEntry,
"addLinkToMaintainTreeEntry": AddLinkToMaintainTreeEntry,
"removeLinkToMaintainTreeEntry": RemoveLinkToMaintainTreeEntry,
"setOverwriteExistingValue": SetOverwriteExistingValue,
"addLinkToProductPageTreeEntry": AddLinkToProductPageTreeEntry,
"removeLinkToProductPageTreeEntry": RemoveLinkToProductPageTreeEntry,
"addLinkToSearchTermGroupTreeEntry": AddLinkToSearchTermGroupTreeEntry,
"removeLinkToSearchTermGroupTreeEntry": RemoveLinkToSearchTermGroupTreeEntry,
"setContentTreeId": SetContentTreeId
}
CopyGlobalParameterInput
Fields
| Input Field | Description |
|---|---|
idToCopy - EntityId!
|
ID of the parameter which should be copied |
ops - [CopyGlobalParameterOperation!]!
|
The operations which are meant to executed for the attribute. |
Example
{
"idToCopy": EntityId,
"ops": [CopyGlobalParameterOperation]
}
CopyGlobalParameterOperation
Fields
| Input Field | Description |
|---|---|
setAttributeName - SetAttributeName
|
|
setParameterDescription - SetParameterDescription
|
|
setTimeValidity - SetTimeValidity
|
|
removeTimeValidity - RemoveTimeValidity
|
|
updateValue - SetDynamicValueOperation
|
Example
{
"setAttributeName": SetAttributeName,
"setParameterDescription": SetParameterDescription,
"setTimeValidity": SetTimeValidity,
"removeTimeValidity": RemoveTimeValidity,
"updateValue": SetDynamicValueOperation
}
CopyLandingPageInput
Fields
| Input Field | Description |
|---|---|
idToCopy - EntityId!
|
|
ops - [UpdateLandingPageOperation!]!
|
Example
{
"idToCopy": EntityId,
"ops": [UpdateLandingPageOperation]
}
CopyPageParameterInput
Fields
| Input Field | Description |
|---|---|
idToCopy - EntityId!
|
ID of the parameter which should be copied |
ops - [CopyPageParameterOperation!]!
|
The operations which are meant to executed for the attribute. |
Example
{
"idToCopy": EntityId,
"ops": [CopyPageParameterOperation]
}
CopyPageParameterOperation
Fields
| Input Field | Description |
|---|---|
setParameterDescription - SetParameterDescription
|
|
setTimeValidity - SetTimeValidity
|
|
removeTimeValidity - RemoveTimeValidity
|
|
updateValue - SetDynamicValueOperation
|
|
removeCustomerSegmentedValues - [RemoveCustomerSegmentedValue!]
|
|
convertToCustomerSegment - ConvertToCustomerSegment
|
|
addLinkToLandingTreeEntry - AddLinkToLandingTreeEntry
|
|
removeLinkToLandingTreeEntry - RemoveLinkToLandingTreeEntry
|
|
addLinkToContentTreeEntry - AddLinkToContentTreeEntry
|
|
removeLinkToContentTreeEntry - RemoveLinkToContentTreeEntry
|
|
addLinkToMaintainTreeEntry - AddLinkToMaintainTreeEntry
|
|
removeLinkToMaintainTreeEntry - RemoveLinkToMaintainTreeEntry
|
|
setOverwriteExistingValue - SetOverwriteExistingValue
|
|
addLinkToProductPageTreeEntry - AddLinkToProductPageTreeEntry
|
|
removeLinkToProductPageTreeEntry - RemoveLinkToProductPageTreeEntry
|
|
addLinkToSearchTermGroupTreeEntry - AddLinkToSearchTermGroupTreeEntry
|
|
removeLinkToSearchTermGroupTreeEntry - RemoveLinkToSearchTermGroupTreeEntry
|
|
setPageId - SetPageId
|
Example
{
"setParameterDescription": SetParameterDescription,
"setTimeValidity": SetTimeValidity,
"removeTimeValidity": RemoveTimeValidity,
"updateValue": SetDynamicValueOperation,
"removeCustomerSegmentedValues": [
RemoveCustomerSegmentedValue
],
"convertToCustomerSegment": ConvertToCustomerSegment,
"addLinkToLandingTreeEntry": AddLinkToLandingTreeEntry,
"removeLinkToLandingTreeEntry": RemoveLinkToLandingTreeEntry,
"addLinkToContentTreeEntry": AddLinkToContentTreeEntry,
"removeLinkToContentTreeEntry": RemoveLinkToContentTreeEntry,
"addLinkToMaintainTreeEntry": AddLinkToMaintainTreeEntry,
"removeLinkToMaintainTreeEntry": RemoveLinkToMaintainTreeEntry,
"setOverwriteExistingValue": SetOverwriteExistingValue,
"addLinkToProductPageTreeEntry": AddLinkToProductPageTreeEntry,
"removeLinkToProductPageTreeEntry": RemoveLinkToProductPageTreeEntry,
"addLinkToSearchTermGroupTreeEntry": AddLinkToSearchTermGroupTreeEntry,
"removeLinkToSearchTermGroupTreeEntry": RemoveLinkToSearchTermGroupTreeEntry,
"setPageId": SetPageId
}
CopySearchIndexScenarioInput
Fields
| Input Field | Description |
|---|---|
idToCopy - EntityId!
|
|
ops - [UpdateSearchIndexScenarioOperation!]!
|
Example
{
"idToCopy": EntityId,
"ops": [UpdateSearchIndexScenarioOperation]
}
CreateAbTestInput
Description
Representation of a new AbTest
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
A name for the Abtest. |
setValidityPeriod - SetValidityPeriod!
|
Start and End date of this Abtest |
setScenarios - [CreateAbTestScenarioInput!]!
|
A List of additional Scenarios to add to this Abtest. Default = [] |
setDescription - SetDescription
|
A description for the AbTest |
setHypothesis - SetHypothesis
|
A Hypothesis for the AbTest |
Example
{
"setName": SetName,
"setValidityPeriod": SetValidityPeriod,
"setScenarios": [CreateAbTestScenarioInput],
"setDescription": SetDescription,
"setHypothesis": SetHypothesis
}
CreateAbTestScenarioInput
Description
Representation of a new AB-Testscenario.
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
The name of this scenario |
setWeight - SetWeight!
|
The weight applied to this scenario. |
setAbTestTrackingCode - SetAbTestTrackingCode
|
An optional tracking code for this scenario. |
setDefault - SetDefault!
|
A flag that indicates if this is the default scenario |
Example
{
"setName": SetName,
"setWeight": SetWeight,
"setAbTestTrackingCode": SetAbTestTrackingCode,
"setDefault": SetDefault
}
CreateArticleListScoreInput
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
|
addCard - [AddArticleListScoreCard!]!
|
Example
{
"setName": SetName,
"addCard": [AddArticleListScoreCard]
}
CreateArticlesIgnoreListInput
Description
Input parameters for Article Ignore List
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
Set name command |
setGranularity - SetGranularity!
|
Set granularity command |
addArticles - [AddArticleIgnoreElement!]!
|
Add articles to the list |
Example
{
"setName": SetName,
"setGranularity": SetGranularity,
"addArticles": [AddArticleIgnoreElement]
}
CreateAssetFormatInput
Description
A set of operations to create a new asset format
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
The name of the asset format |
setWidth - SetWidth!
|
The width of the asset format |
setHeight - SetHeight!
|
The height of the asset format |
Example
{
"setName": SetName,
"setWidth": SetWidth,
"setHeight": SetHeight
}
CreateAssetTags
Fields
| Input Field | Description |
|---|---|
setAssetTagsLanguage - SetAssetTagsLanguage!
|
The language of the title and alt tags |
setTitle - SetTitle
|
The title tag |
setAlt - SetAlt
|
The alt tag |
setAssetTagsDefaultLanguage - SetAssetTagsDefaultLanguage!
|
Indicates if these are the default values |
Example
{
"setAssetTagsLanguage": SetAssetTagsLanguage,
"setTitle": SetTitle,
"setAlt": SetAlt,
"setAssetTagsDefaultLanguage": SetAssetTagsDefaultLanguage
}
CreateBinaryImageInput
Fields
| Input Field | Description |
|---|---|
setImportedId - SetImportedId!
|
Asset imported id inside cached bytes |
setName - SetName!
|
Asset name |
setTitle - SetTitle
|
Asset title tag |
setAlt - SetAlt
|
Asset alt tag |
setKeywords - SetKeywords
|
Asset Keywords |
setMcs - SetMcs!
|
Asset mcs |
setOptimized - SetOptimized
|
Set optimized |
Example
{
"setImportedId": SetImportedId,
"setName": SetName,
"setTitle": SetTitle,
"setAlt": SetAlt,
"setKeywords": SetKeywords,
"setMcs": SetMcs,
"setOptimized": SetOptimized
}
CreateBrandParameterInput
Fields
| Input Field | Description |
|---|---|
setBrandId - SetBrandId!
|
Brand id |
setAttribute - SetAttribute!
|
Attribute key and validity period |
setValue - SetDynamicValueOperation!
|
Attribute value |
Example
{
"setBrandId": SetBrandId,
"setAttribute": SetAttribute,
"setValue": SetDynamicValueOperation
}
CreateCampaignInput
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
Campaign name |
setValidityPeriod - SetValidityPeriod!
|
Timeframe of campaign |
Example
{
"setName": SetName,
"setValidityPeriod": SetValidityPeriod
}
CreateCategoriesIgnoreListInput
Description
Input parameters for Category Ignore List
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
Set name command |
addCategories - [AddIgnoredCategory!]!
|
Set categories to export data from |
Example
{
"setName": SetName,
"addCategories": [AddIgnoredCategory]
}
CreateCategoryParameterAttributeInput
Description
MUTATION INPUT
Fields
| Input Field | Description |
|---|---|
setCategoryId - SetCategoryId!
|
|
setAttribute - SetAttribute!
|
|
setValue - SetDynamicValueOperation!
|
Example
{
"setCategoryId": SetCategoryId,
"setAttribute": SetAttribute,
"setValue": SetDynamicValueOperation
}
CreateCategoryTreeNodeInput
Description
CREATE
Fields
| Input Field | Description |
|---|---|
setCuratedPageNode - SetCuratedPageNode
|
|
setSmartCategoryNode - SetSmartCategoryNode
|
|
setFilterCategoryNode - SetFilterCategoryNode
|
|
setBrandCategoryNode - SetBrandCategoryNode
|
|
setFilterLevelNode - SetFilterLevelNode
|
Example
{
"setCuratedPageNode": SetCuratedPageNode,
"setSmartCategoryNode": SetSmartCategoryNode,
"setFilterCategoryNode": SetFilterCategoryNode,
"setBrandCategoryNode": SetBrandCategoryNode,
"setFilterLevelNode": SetFilterLevelNode
}
CreateCommonVoucherInput
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
The name of the entity |
setMcs - SetMcs!
|
The mcs id of the entity |
setNumberOfGeneratedCodes - SetNumberOfGeneratedCodes!
|
The number of the generated voucher codes (custom, prefix) |
setMaxPerCodeRedeemCount - SetMaxPerCodeRedeemCount!
|
The maximum number of times the code can be used for redemption |
setMaxPerUserRedeemCount - SetMaxPerUserRedeemCount!
|
The maximum number of times the user can redeem the voucher |
setGenerator - SetGenerator!
|
Different types of generators |
Example
{
"setName": SetName,
"setMcs": SetMcs,
"setNumberOfGeneratedCodes": SetNumberOfGeneratedCodes,
"setMaxPerCodeRedeemCount": SetMaxPerCodeRedeemCount,
"setMaxPerUserRedeemCount": SetMaxPerUserRedeemCount,
"setGenerator": SetGenerator
}
CreateConnectedIProductsStatusInput
Fields
| Input Field | Description |
|---|---|
setConnectedIProductProductId - SetConnectedIProductProductId!
|
Set connected iProduct product id |
setConnectedIProductUseCaseId - SetConnectedIProductUseCaseId!
|
Set connected iProduct use case id |
setConnectedIProductStatus - SetConnectedIProductStatus!
|
Set connected iProduct status |
Example
{
"setConnectedIProductProductId": SetConnectedIProductProductId,
"setConnectedIProductUseCaseId": SetConnectedIProductUseCaseId,
"setConnectedIProductStatus": SetConnectedIProductStatus
}
CreateContainer
Fields
| Input Field | Description |
|---|---|
setTimeValidity - SetTimeValidity
|
|
addCustomerSegment - [AddCustomerSegment!]!
|
|
createTeaser - SetTeaserValue!
|
Example
{
"setTimeValidity": SetTimeValidity,
"addCustomerSegment": [AddCustomerSegment],
"createTeaser": SetTeaserValue
}
CreateContentTreeNodeInput
Description
INPUT
Fields
| Input Field | Description |
|---|---|
setNodePositionOperation - SetContentNodePositionOperation!
|
|
setCuratedPage - SetCuratedPage!
|
Example
{
"setNodePositionOperation": SetContentNodePositionOperation,
"setCuratedPage": SetCuratedPage
}
CreateContentTreeParameterAttributeInput
Description
MUTATION INPUT
Fields
| Input Field | Description |
|---|---|
setPageId - SetPageId!
|
|
setAttribute - SetAttribute!
|
|
setValue - SetDynamicValueOperation!
|
Example
{
"setPageId": SetPageId,
"setAttribute": SetAttribute,
"setValue": SetDynamicValueOperation
}
CreateCustomerSegmentInput
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
The name |
setMcs - SetMcs!
|
The mcs |
setDescription - SetDescription
|
The description |
setType - SetType!
|
The customer segment type |
setGroup - SetGroup!
|
Group and priority data |
addOrCondition - AddOrCustomerSegmentCondition!
|
The parent condition which should be OR condition |
Example
{
"setName": SetName,
"setMcs": SetMcs,
"setDescription": SetDescription,
"setType": SetType,
"setGroup": SetGroup,
"addOrCondition": AddOrCustomerSegmentCondition
}
CreateDataExportInput
Description
Input parameters for Data Export
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
Data Export name |
setEmail - SetEmail
|
|
setCompressionType - SetCompressionType!
|
Compression Type |
setExportType - SetExportType!
|
Export Type |
setGranularity - SetGranularity!
|
Granularity |
setCategoriesIgnoreList - SetCategoriesIgnoreList
|
Categories that will be ignored |
setArticlesIgnoreList - SetArticlesIgnoreList
|
Articles that will be ignored |
setReplacementList - SetReplacementList
|
The list of replaced strings within the data to be exported |
addOrCondition - AddOrDataExportCondition
|
The parent condition which should be OR condition |
setExportFormat - SetExportFormat!
|
Export format |
Example
{
"setName": SetName,
"setEmail": SetEmail,
"setCompressionType": SetCompressionType,
"setExportType": SetExportType,
"setGranularity": SetGranularity,
"setCategoriesIgnoreList": SetCategoriesIgnoreList,
"setArticlesIgnoreList": SetArticlesIgnoreList,
"setReplacementList": SetReplacementList,
"addOrCondition": AddOrDataExportCondition,
"setExportFormat": SetExportFormat
}
CreateDataExportPreviewInput
Description
Input parameter for Data Export preview create input
Fields
| Input Field | Description |
|---|---|
setGranularity - SetGranularity!
|
Granularity |
setArticlesIgnoreList - SetArticlesIgnoreList
|
Articles that will be ignored |
setCategoriesIgnoreList - SetCategoriesIgnoreList
|
Categories that will be ignored |
setReplacementList - SetReplacementList
|
The list of replaced strings within the data to be exported |
addOrCondition - AddOrDataExportCondition
|
The parent condition which should be OR condition |
setPreviewExportFormat - SetPreviewExportFormat!
|
Export format |
Example
{
"setGranularity": SetGranularity,
"setArticlesIgnoreList": SetArticlesIgnoreList,
"setCategoriesIgnoreList": SetCategoriesIgnoreList,
"setReplacementList": SetReplacementList,
"addOrCondition": AddOrDataExportCondition,
"setPreviewExportFormat": SetPreviewExportFormat
}
CreateFormatInput
Description
Input parameters for Export Format
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
Set name command |
setReadOnly - SetReadOnly!
|
Set readonly format command |
setTemplateFormat - SetTemplateFormat!
|
Set Template Format |
Example
{
"setName": SetName,
"setReadOnly": SetReadOnly,
"setTemplateFormat": SetTemplateFormat
}
CreateGlobalParameterInput
Fields
| Input Field | Description |
|---|---|
setAttribute - SetGlobalParameterAttribute!
|
|
setValue - SetDynamicValueOperation!
|
Example
{
"setAttribute": SetGlobalParameterAttribute,
"setValue": SetDynamicValueOperation
}
CreateGridContainer
Fields
| Input Field | Description |
|---|---|
setGridContainerParameter - SetGridContainerParameter
|
Grid container parameter |
setGridContainerWidth - SetGridContainerWidth!
|
Grid container width |
setGridContainerHeight - SetGridContainerHeight!
|
Grid container height |
setXCoordinate - SetXCoordinate!
|
Grid container X coordinate |
setYCoordinate - SetYCoordinate!
|
Grid container Y coordinate |
setTrackingCode - SetGridContainerTrackingCode
|
Grid container tracking code |
setGridContainerType - SetGridContainerType
|
Grid container type |
Example
{
"setGridContainerParameter": SetGridContainerParameter,
"setGridContainerWidth": SetGridContainerWidth,
"setGridContainerHeight": SetGridContainerHeight,
"setXCoordinate": SetXCoordinate,
"setYCoordinate": SetYCoordinate,
"setTrackingCode": SetGridContainerTrackingCode,
"setGridContainerType": SetGridContainerType
}
CreateGridElement
Fields
| Input Field | Description |
|---|---|
setValidityRange - SetValidityRange!
|
|
setGridContainerWidth - SetGridContainerWidth!
|
only from(StartDate) is expected here corresponding to spot selected in timeline |
setGridContainerHeight - SetGridContainerHeight!
|
|
setXCoordinate - SetXCoordinate!
|
|
setYCoordinate - SetYCoordinate!
|
|
setTrackingCode - SetGridContainerTrackingCode
|
|
setGridContainerType - SetGridContainerType!
|
Example
{
"setValidityRange": SetValidityRange,
"setGridContainerWidth": SetGridContainerWidth,
"setGridContainerHeight": SetGridContainerHeight,
"setXCoordinate": SetXCoordinate,
"setYCoordinate": SetYCoordinate,
"setTrackingCode": SetGridContainerTrackingCode,
"setGridContainerType": SetGridContainerType
}
CreateGridInput
Fields
| Input Field | Description |
|---|---|
setNavigationTreeEntry - SetNavigationTreeEntry!
|
|
setValidityRange - SetValidityRange!
|
|
setGridTemplate - SetGridTemplate!
|
|
setAbScenario - SetAbScenario
|
Example
{
"setNavigationTreeEntry": SetNavigationTreeEntry,
"setValidityRange": SetValidityRange,
"setGridTemplate": SetGridTemplate,
"setAbScenario": SetAbScenario
}
CreateGridTemplateInput
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
Grid template name |
setTemplateId - SetRenderingTemplateId!
|
The TemplateType which defines this GridTemplate |
setContainers - SetGridContainers!
|
Grid template containers |
Example
{
"setName": SetName,
"setTemplateId": SetRenderingTemplateId,
"setContainers": SetGridContainers
}
CreateLandingPageInput
Description
INPUT
Fields
| Input Field | Description |
|---|---|
setCuratedPage - SetCuratedPage!
|
Example
{"setCuratedPage": SetCuratedPage}
CreateLemmaInput
Description
Representaion of a new lemma
Fields
| Input Field | Description |
|---|---|
setMcs - SetMcs!
|
The MCS to create the lemma in. |
setSearchTerms - SetSearchTerms!
|
The search terms affected by this lemma. |
setWordStem - SetWordStem!
|
The word stem of this lemma. |
Example
{
"setMcs": SetMcs,
"setSearchTerms": SetSearchTerms,
"setWordStem": SetWordStem
}
CreateLinkableAssetInput
Fields
| Input Field | Description |
|---|---|
setImportedId - SetImportedId!
|
Asset imported id inside cached bytes |
setName - SetName!
|
Asset name |
setKeywords - SetKeywords!
|
Asset Keywords |
setMcs - SetMcs!
|
Asset mcs |
Example
{
"setImportedId": SetImportedId,
"setName": SetName,
"setKeywords": SetKeywords,
"setMcs": SetMcs
}
CreatePageParameterAttributeInput
Description
MUTATION INPUT
Fields
| Input Field | Description |
|---|---|
setPageId - SetPageId!
|
|
setAttribute - SetAttribute!
|
|
setValue - SetDynamicValueOperation!
|
Example
{
"setPageId": SetPageId,
"setAttribute": SetAttribute,
"setValue": SetDynamicValueOperation
}
CreatePersonalVoucherInput
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
The name of the entity |
setMcs - SetMcs!
|
The mcs id of the entity |
setMaxPerUserRedeemCount - SetMaxPerUserRedeemCount!
|
The maximum number of times the user can redeem the voucher |
setImportedCodesAndClients - SetImportedCodesAndClients!
|
The imported key for the uploaded file with the regex |
Example
{
"setName": SetName,
"setMcs": SetMcs,
"setMaxPerUserRedeemCount": SetMaxPerUserRedeemCount,
"setImportedCodesAndClients": SetImportedCodesAndClients
}
CreateProductPageInput
Description
INPUT
Fields
| Input Field | Description |
|---|---|
setProductId - SetProductId!
|
Example
{"setProductId": SetProductId}
CreatePromotionInput
Fields
| Input Field | Description |
|---|---|
setMcs - SetMcs!
|
The mcs |
setActive - SetActive
|
The mcs which you want to activate this promotion If it is used in the upper mcs (sub-master or master), it will be activated/deactivated for all completed children mcss |
setName - SetName!
|
The name |
setDescription - SetDescription
|
The description |
setTimeValidity - SetPromotionTimeValidity!
|
Time validity range or campaign reference |
addOrCondition - AddOrPromotionCondition!
|
The parent condition which should be OR condition |
addBenefits - [AddBenefit!]!
|
List of promotion's benefits |
setBrokenInheritanceFrom - SetBrokenInheritanceFrom
|
Reference to original field when applying break inheritance logic |
setImported - SetImported!
|
If this promotion was imported from external system or not. Default = {value: false} |
setReadOnly - SetReadOnly!
|
If this promotion is readonly or not. Default = {value: false} |
Example
{
"setMcs": SetMcs,
"setActive": SetActive,
"setName": SetName,
"setDescription": SetDescription,
"setTimeValidity": SetPromotionTimeValidity,
"addOrCondition": AddOrPromotionCondition,
"addBenefits": [AddBenefit],
"setBrokenInheritanceFrom": SetBrokenInheritanceFrom,
"setImported": SetImported,
"setReadOnly": SetReadOnly
}
CreateReplacementListInput
Description
Input parameters for Replacement list
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
Set name command |
addReplacement - [AddReplacement!]
|
Add replacement to the list |
Example
{
"setName": SetName,
"addReplacement": [AddReplacement]
}
CreateRoleInput
Description
Operations to create single role with menu/group rights
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
Operation to set name of role |
setDescription - SetDescription
|
Operation to description name of role |
addRoleRights - [AddRoleRight!]!
|
Operations to add menu/group right to role |
Example
{
"setName": SetName,
"setDescription": SetDescription,
"addRoleRights": [AddRoleRight]
}
CreateSearchExclusionInput
Description
Representaion of a new search exclusion.
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
A name for the search exclusion. |
setMcs - SetMcs!
|
The MCS to create the search exclusion in. |
setExactFlag - SetExactFlag!
|
A flag deciding if this search exclusion affects only exact matches or all containing matches. Default: True, hits only exact matches. Default = {value: true} |
setSearchTerms - SetSearchTerms!
|
The search terms affected by this search exclusion. |
addExclusions - [AddExclustion!]!
|
A List of excluded articles and categories to add to this search exclusions. |
Example
{
"setName": SetName,
"setMcs": SetMcs,
"setExactFlag": SetExactFlag,
"setSearchTerms": SetSearchTerms,
"addExclusions": [AddExclustion]
}
CreateSearchIndexScenarioInput
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
|
setScenarioFactor - SetScenarioFactor!
|
|
setTrackingCode - SetSearchIndexScenarioTrackingCode
|
|
addAttribute - [AddSearchIndexAttribute!]
|
Example
{
"setName": SetName,
"setScenarioFactor": SetScenarioFactor,
"setTrackingCode": SetSearchIndexScenarioTrackingCode,
"addAttribute": [AddSearchIndexAttribute]
}
CreateSearchTermGroupInput
Description
A set of operations to create a new search term group.
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
A name for the search term group. |
setMcs - SetMcs!
|
The MCS to create the search term group in. |
setExactFlag - SetExactFlag!
|
A flag deciding if this search term group affects only exact matches or all containing matches. Default: True, hits only exact matches. Default = {value: true} |
setSearchTerms - SetSearchTerms!
|
The search terms inside this group |
Example
{
"setName": SetName,
"setMcs": SetMcs,
"setExactFlag": SetExactFlag,
"setSearchTerms": SetSearchTerms
}
CreateSeoTermInput
Fields
| Input Field | Description |
|---|---|
setSeoTerm - SetSeoTerm!
|
A term for the seo term. |
setSeoUrl - SetSeoUrl!
|
A pretty url for the seo term. |
setSeoMainTerm - SetSeoMainTerm!
|
A mainTerm for the seo term. Default = {value: false} |
setSeoCategory - SetSeoCategory!
|
Selected category of seo term |
Example
{
"setSeoTerm": SetSeoTerm,
"setSeoUrl": SetSeoUrl,
"setSeoMainTerm": SetSeoMainTerm,
"setSeoCategory": SetSeoCategory
}
CreateStaticContentInput
Fields
| Input Field | Description |
|---|---|
setImportedId - SetImportedId!
|
Asset imported id inside cached bytes |
setName - SetName!
|
Asset name |
setKeywords - SetKeywords!
|
Asset Keywords |
setMcs - SetMcs!
|
Asset mcs |
Example
{
"setImportedId": SetImportedId,
"setName": SetName,
"setKeywords": SetKeywords,
"setMcs": SetMcs
}
CreateTouchpointInput
Description
A set of operations to create a new touchpoint
Fields
| Input Field | Description |
|---|---|
setName - SetName!
|
The name of the touchpoint |
setMcs - SetMcs!
|
The mcs of the touchpoint |
setDescription - SetDescription
|
The description of the touchpoint |
setPersisted - SetPersisted
|
Set Persisted |
addOrCondition - AddOrTouchpointCondition
|
Dynamic conditions |
Example
{
"setName": SetName,
"setMcs": SetMcs,
"setDescription": SetDescription,
"setPersisted": SetPersisted,
"addOrCondition": AddOrTouchpointCondition
}
CreateTranslationInput
Description
Operations to create single translation
Fields
| Input Field | Description |
|---|---|
setMessageKey - SetMessageKey!
|
Operation to set message key |
setMessageValue - SetMessageValue!
|
Operation to set translation |
setMessageMcs - SetMessageMcs!
|
Operation to set MultiChannelSelector |
Example
{
"setMessageKey": SetMessageKey,
"setMessageValue": SetMessageValue,
"setMessageMcs": SetMessageMcs
}
CreateUserInformationInput
Fields
| Input Field | Description |
|---|---|
setUserName - SetUserName!
|
Set user username |
setUserPassword - SetUserPassword!
|
Set user password |
setUserEmail - SetUserEmail
|
Set user email |
addUserRoles - [AddUserRole!]!
|
Set user add user roles |
Example
{
"setUserName": SetUserName,
"setUserPassword": SetUserPassword,
"setUserEmail": SetUserEmail,
"addUserRoles": [AddUserRole]
}
CreateUserRoleInput
Description
Operations to create single user/role relation
Fields
| Input Field | Description |
|---|---|
setUser - SetUser!
|
Operation to set user |
setRole - SetRole!
|
Operation to set role |
addMcss - [AddMcs!]!
|
Operations to add MultiChannelSelector |
Example
{
"setUser": SetUser,
"setRole": SetRole,
"addMcss": [AddMcs]
}
CronExpression
Fields
| Field Name | Description |
|---|---|
expression - String!
|
Example
{"expression": "xyz789"}
CuratedPage
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
|
deleteDate - DateTime
|
The date when the entry will be deleted or null if it won't be deleted |
parent - NavigationTreeEntry
|
|
ancestors - [NavigationTreeEntry!]!
|
|
children - NavigationTreeEntryChildrenPayload!
|
|
Arguments
|
|
valid - Boolean!
|
|
status - CategoryStatus!
|
|
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
url - String
|
Url should accept null value for raster page and global category |
previewUrl - String!
|
|
Arguments
|
|
description - String
|
|
pageType - CuratedPageType!
|
|
timeValidity - TimeValidity!
|
|
timeStatus - TimeValidityStatus!
|
use status attribute instead of timeStatus See: ISBO-15517 |
overwrittenValue - NavigationTreeEntry
|
|
originalTreeType - TreeType
|
|
paths - [String!]!
|
|
referenceType - PageReferenceType!
|
|
categoryParameters - CategoryParameterFindPayload!
|
|
Arguments
|
|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"name": "xyz789",
"deleteDate": "2007-12-03T10:15:30Z",
"parent": NavigationTreeEntry,
"ancestors": [NavigationTreeEntry],
"children": NavigationTreeEntryChildrenPayload,
"valid": false,
"status": "INVALID",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"url": "xyz789",
"previewUrl": "abc123",
"description": "abc123",
"pageType": "CONTENT",
"timeValidity": Campaign,
"timeStatus": "ACTIVE",
"overwrittenValue": NavigationTreeEntry,
"originalTreeType": "ArchiveTree",
"paths": ["xyz789"],
"referenceType": "NONE",
"categoryParameters": CategoryParameterFindPayload
}
CuratedPageType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONTENT"
CustomerSegment
Description
Representation of a single customer segment. This is only a start and should be extended with values you need.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the customer segment. |
version - Long!
|
The version of the customer segment. |
name - String!
|
The name of the customer segment. |
mcs - Mcs!
|
The MCS of the customer segment. |
description - String
|
An optional textual description of the customer segment. |
deleted - Boolean!
|
A flag telling if this customer segment is deleted. |
type - CustomerSegmentType!
|
The type of this customer segment. |
dynamic - Boolean!
|
A flag telling if this MCS is dynamic. |
conditions - ComplexCondition!
|
Customer segment conditions |
group - CustomerSegmentGroup!
|
Customer segment group static/dynamic |
brokenInheritanceFrom - Long
|
Reference to original row, which was broken from |
isStandardCustomerSegment - Boolean!
|
A flag telling if this is the standard customer segment |
Example
{
"id": "4",
"version": {},
"name": "abc123",
"mcs": Mcs,
"description": "xyz789",
"deleted": false,
"type": "BuiltIn",
"dynamic": true,
"conditions": ComplexCondition,
"group": CustomerSegmentGroup,
"brokenInheritanceFrom": {},
"isStandardCustomerSegment": false
}
CustomerSegmentContentAttribute
Description
A content attribute for a specific customer segment
Fields
| Field Name | Description |
|---|---|
contentAttribute - ContentAttribute!
|
The content attribute |
customerSegment - CustomerSegment
|
The customer segment |
Example
{
"contentAttribute": ContentAttribute,
"customerSegment": CustomerSegment
}
CustomerSegmentContentAttributeInput
Description
A single content attribute for a specific customer segment
Fields
| Input Field | Description |
|---|---|
contentAttribute - BaseContentAttributeInput!
|
The content attribute value. |
customerSegment - CustomerSegmentReadInput
|
The customer segment. |
Example
{
"contentAttribute": BaseContentAttributeInput,
"customerSegment": CustomerSegmentReadInput
}
CustomerSegmentFilter
Fields
| Input Field | Description |
|---|---|
value - ID!
|
Example
{"value": "4"}
CustomerSegmentFindPayload
Description
A list of customer segments
Fields
| Field Name | Description |
|---|---|
entries - [CustomerSegment!]!
|
The list of customer segments after applying paging information. |
totalCount - Int!
|
The complete count of customer segments |
Example
{"entries": [CustomerSegment], "totalCount": 123}
CustomerSegmentGroup
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the customer segment group. |
version - Long
|
The version of the customer segment group. |
name - String
|
The name of the customer segment group. |
mcs - Mcs!
|
The MCS of the customer segment group. |
segments - [CustomerSegment!]!
|
The list of customer segments after applying paging information. |
priority - Int!
|
The priority of this customer segment group over other customer segments. |
dynamic - Boolean!
|
A flag telling if this group is dynamic. |
Example
{
"id": "4",
"version": {},
"name": "xyz789",
"mcs": Mcs,
"segments": [CustomerSegment],
"priority": 123,
"dynamic": true
}
CustomerSegmentGroupFilter
Fields
| Input Field | Description |
|---|---|
groupId - ID
|
Customer segment group id, used to reload a specific group |
customerSegmentId - ID
|
Customer segment id, used to reload a specific row |
searchTerm - String
|
String keyword to search with |
touchpointId - ID
|
Touchpoint Id, used to find customer segments using it |
hideStandard - Boolean!
|
Hide the Standard Customer Segment. Default = false |
Example
{
"groupId": "4",
"customerSegmentId": 4,
"searchTerm": "xyz789",
"touchpointId": "4",
"hideStandard": true
}
CustomerSegmentGroupFindPayload
Description
A list of customer segment groups
Fields
| Field Name | Description |
|---|---|
entries - [CustomerSegmentGroup!]!
|
The list of customer segment groups after applying paging information. |
totalCount - Int!
|
The complete count of segment groups |
Example
{"entries": [CustomerSegmentGroup], "totalCount": 123}
CustomerSegmentGroupPagingInput
Fields
| Input Field | Description |
|---|---|
pagingInput - Paging!
|
Paging information.{Default return 100 entries from start}. Default = {limit: 100, offset: 0} |
sortInput - CustomerSegmentGroupSortInput!
|
Sorting information.{Default Descending on PRIORITY field}. Default = {sortOrder: ASC, sortColumn: PRIORITY} |
Example
{
"pagingInput": Paging,
"sortInput": CustomerSegmentGroupSortInput
}
CustomerSegmentGroupSortColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ID"
CustomerSegmentGroupSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
list order value (default order is ASC). Default = ASC |
sortColumn - CustomerSegmentGroupSortColumn!
|
Column names which are allowed to sort with. Default = PRIORITY |
Example
{"sortOrder": "ASC", "sortColumn": "ID"}
CustomerSegmentGroupUpdatePayload
Description
A list of customer segment groups
Fields
| Field Name | Description |
|---|---|
entries - [CustomerSegmentGroup!]!
|
The list of customer segment groups after applying paging information. |
Example
{"entries": [CustomerSegmentGroup]}
CustomerSegmentInput
Description
check if customer segment is linked input
Fields
| Input Field | Description |
|---|---|
customerSegmentId - Long!
|
Example
{"customerSegmentId": {}}
CustomerSegmentReadInput
Description
A description of customer segments. This instance is only used for read input to get an customer segment.
Example
{
"id": 4,
"version": {},
"name": "xyz789",
"mcsInput": McsInput
}
CustomerSegmentType
Description
Enum representation of the types of customer segments.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BuiltIn"
CustomerSegmentedList
Fields
| Field Name | Description |
|---|---|
entries - [CustomerSegmentedValue!]!
|
Example
{"entries": [CustomerSegmentedValue]}
CustomerSegmentedValue
Fields
| Field Name | Description |
|---|---|
customerSegments - [CustomerSegment!]!
|
|
value - DynamicValue!
|
Example
{
"customerSegments": [CustomerSegment],
"value": StringValue
}
DashboardFilterInput
Description
A complex object containing a date range and other information needed on the dashboard.
Fields
| Input Field | Description |
|---|---|
startDate - DateTime
|
The starting date of the searched timeframe |
endDate - DateTime
|
The end date of the searched timeframe |
downSample - String
|
Size information about the displaying screen to match the amount of data sent back |
metric - String!
|
Used for giving context to the 'findKpi' function |
aggregator - String
|
custom aggregator to use while aggregating kpi data |
Example
{
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"downSample": "xyz789",
"metric": "xyz789",
"aggregator": "abc123"
}
DataExportArticleIgnoreList
Description
Representation of a single Article Ignore List record
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the article ignore list |
version - Long!
|
The version of the article ignore list |
mcs - Mcs!
|
The MCS of the article ignore list |
name - String!
|
The name of the article ignore list |
granularity - ExportGranularity!
|
The level of article ignore list granularity |
articles - [Article]
|
The list of articles that will be ignored |
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"name": "abc123",
"granularity": "PRODUCT",
"articles": [Article]
}
DataExportCategoryIgnoreList
Description
Representation of a single Category Ignore List record
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the category ignore list |
version - Long!
|
The version of the category ignore list |
mcs - Mcs!
|
The MCS of the category ignore list |
name - String!
|
The name of the category ignore list |
exportCategories - [LinkToCategoryTreeEntry!]!
|
List of categories that will be ignored |
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"name": "abc123",
"exportCategories": [LinkToCategoryTreeEntry]
}
DataExportCreatePayload
Description
Payload wrapper object for creating data export
Fields
| Field Name | Description |
|---|---|
entries - [DataExportEntity!]!
|
List of created data exports |
Example
{"entries": [DataExportEntity]}
DataExportDeletePayload
Description
Payload wrapper object for deleting data export
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Flag for success. |
Example
{"successful": true}
DataExportEntity
Description
Representation of a single Data Export record
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the data export |
version - Long!
|
The version of the data export |
name - String!
|
The name of the data export |
mcs - Mcs!
|
The MCS of the data export |
email - String
|
An optional textual of the email address for status updates |
lastExecutionDate - DateTime
|
The time of the last data export execution |
nextExecutionDate - DateTime
|
The time of the next data export execution |
granularity - ExportGranularity!
|
The level of export granularity |
status - ExportStatus!
|
The status of the last data export execution successful/failed/running |
compressionType - ExportCompressionType!
|
The data export compression type |
exportType - ExportTypeValue!
|
The data export type |
articlesIgnoreList - DataExportArticleIgnoreList
|
The excluded articles from the export |
categoriesIgnoreList - DataExportCategoryIgnoreList
|
The excluded categories from the export |
exportFormat - DataExportFormat!
|
The format in which the export is exported |
conditions - ComplexCondition
|
The export filter conditions |
replacementList - DataExportReplacementList
|
The replaced strings within the data to be exported |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
The audit and userInfo of this data export record |
Example
{
"id": "4",
"version": {},
"name": "abc123",
"mcs": Mcs,
"email": "abc123",
"lastExecutionDate": "2007-12-03T10:15:30Z",
"nextExecutionDate": "2007-12-03T10:15:30Z",
"granularity": "PRODUCT",
"status": "OK",
"compressionType": "NONE",
"exportType": HttpType,
"articlesIgnoreList": DataExportArticleIgnoreList,
"categoriesIgnoreList": DataExportCategoryIgnoreList,
"exportFormat": DataExportFormat,
"conditions": ComplexCondition,
"replacementList": DataExportReplacementList,
"backofficeUserInfoAudit": BackofficeUserInfoAudit
}
DataExportFindPayload
Description
A list of data export records
Fields
| Field Name | Description |
|---|---|
entries - [DataExportEntity!]!
|
The list of data exports after applying paging information |
totalCount - Int!
|
The complete count of data export records |
Example
{"entries": [DataExportEntity], "totalCount": 987}
DataExportFormat
Description
Representation of a single Format List record
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"name": "abc123",
"templateFormat": "abc123",
"readOnly": true
}
DataExportPreviewInput
Fields
| Input Field | Description |
|---|---|
add - CreateDataExportPreviewInput
|
Add parameter for new export |
update - UpdateDataExportPreviewInput
|
Update input for existing export |
Example
{
"add": CreateDataExportPreviewInput,
"update": UpdateDataExportPreviewInput
}
DataExportPreviewPayload
Description
Payload wrapper object for previewing data export
Fields
| Field Name | Description |
|---|---|
fileContent - String!
|
Content of data previewed |
Example
{"fileContent": "xyz789"}
DataExportReplacement
DataExportReplacementList
Description
Representation of a single Replacement List record
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the replacement list |
version - Long!
|
The version of the replacement list |
mcs - Mcs!
|
The MCS of the replacement list |
name - String!
|
The name of the replacement list |
values - [DataExportReplacement!]
|
Export Map |
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"name": "abc123",
"values": [DataExportReplacement]
}
DataExportRunPayload
Description
Payload wrapper object for running data export
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Flag for success. |
Example
{"successful": true}
DataExportSortColumn
Description
Representation in which will the result be sorted
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
DataExportSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
list order value (default order is ASC). Default = ASC |
sortColumn - DataExportSortColumn!
|
Column names which are allowed to sort with. Default = NAME |
Example
{"sortOrder": "ASC", "sortColumn": "NAME"}
DataExportType
Description
Enum representing the types of export
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"HTTP"
DataExportUpdatePayload
Description
Payload wrapper object for updating data export
Fields
| Field Name | Description |
|---|---|
entries - [DataExportEntity!]!
|
List of updated data exports |
Example
{"entries": [DataExportEntity]}
DataExportsFilterInput
Fields
| Input Field | Description |
|---|---|
ids - [ID!]
|
selected data export ID |
searchTerm - String
|
string keyword to search within name or export format |
types - [DataExportType!]
|
filtering the export data according to a given type (HTTP/FTP) |
status - [ExportStatus!]
|
filtering the data exports according to a given status |
Example
{
"ids": [4],
"searchTerm": "abc123",
"types": ["HTTP"],
"status": ["OK"]
}
DataExportsPagingInput
Fields
| Input Field | Description |
|---|---|
pagingInput - Paging!
|
Paging information. Default = {limit: 100, offset: 0} |
sortInput - DataExportSortInput!
|
Sorting information. {Default asc by name}. Default = {sortOrder: ASC, sortColumn: NAME} |
Example
{
"pagingInput": Paging,
"sortInput": DataExportSortInput
}
DataType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Number"
DatabaseEntity
DateConditionValue
Fields
| Field Name | Description |
|---|---|
value - DateTime!
|
Example
{"value": "2007-12-03T10:15:30Z"}
DateRange
DateTime
Description
An RFC-3339 compliant scalar representing Java's java.time.LocalDateTime
Example
"2007-12-03T10:15:30Z"
DateValue
Fields
| Field Name | Description |
|---|---|
value - DateTime!
|
Example
{"value": "2007-12-03T10:15:30Z"}
DefaultSmartNode
Fields
| Field Name | Description |
|---|---|
name - String
|
Node Name |
isCompleted - Boolean!
|
is Completed |
score - Int!
|
Score, represents number of completed items |
type - SmartAssistantNodeType
|
Node Type |
Example
{
"name": "abc123",
"isCompleted": true,
"score": 987,
"type": "DefaultArticleScoringForCategories"
}
DeleteCampaignInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Id of campaign to be deleted |
ops - [DeleteCampaignOperation!]!
|
List of operations to specify whether to delete campaign references or to unlink them only |
Example
{
"id": EntityId,
"ops": [DeleteCampaignOperation]
}
DeleteCampaignOperation
Fields
| Input Field | Description |
|---|---|
deleteReferences - DeleteReferences
|
Command sent to delete campaign references. |
Example
{"deleteReferences": "DELETE"}
DeleteReferences
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DELETE"
DescriptionsForImage
Fields
| Field Name | Description |
|---|---|
identifier - String!
|
|
imageDescriptions - [AiGeneratedImageDescription!]!
|
Example
{
"identifier": "abc123",
"imageDescriptions": [AiGeneratedImageDescription]
}
Dimension
DoubleConditionValue
Fields
| Field Name | Description |
|---|---|
value - Float!
|
Example
{"value": 123.45}
DoubleStringValue
DoubleStringWithHTMLValue
DoubleTextConditionValue
Fields
| Field Name | Description |
|---|---|
value - DoubleTextValue!
|
Example
{"value": DoubleTextValue}
DoubleTextValue
DynamicAttributeValue
Fields
| Field Name | Description |
|---|---|
timeValidity - TimeValidity!
|
|
status - TimeValidityStatus!
|
|
value - ContentAttributeDynamicValue!
|
|
linkTrackingInfo - String
|
Example
{
"timeValidity": Campaign,
"status": "ACTIVE",
"value": CustomerSegmentedList,
"linkTrackingInfo": "xyz789"
}
DynamicConditionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Text"
DynamicValue
Types
| Union Types |
|---|
Example
StringValue
ElementPosition
EndGridElement
EntityId
EveryHours
Fields
| Field Name | Description |
|---|---|
hours - Long!
|
Example
{"hours": {}}
EveryMinutes
Fields
| Field Name | Description |
|---|---|
minutes - Long!
|
Example
{"minutes": {}}
ExactTimeFilter
Fields
| Input Field | Description |
|---|---|
value - DateTime!
|
Example
{"value": "2007-12-03T10:15:30Z"}
ExportCompressionType
Description
Enum representing the compression types of export
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NONE"
ExportGranularity
Description
Enum representing the level of export granularity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PRODUCT"
ExportScheduleValue
Types
| Union Types |
|---|
Example
Now
ExportStatus
Description
Enum representing the status filter of exports
Values
| Enum Value | Description |
|---|---|
|
|
Last data export execution was successful |
|
|
Last data export execution failed |
|
|
Data export operation is running |
Example
"OK"
ExportTypeValue
ExternalLink
Description
The representation of an external link.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this link. |
version - Long!
|
The version of this link. |
openLinkInNewWindow - Boolean!
|
Should the link be opened in a new window? |
urlParameters - String
|
The URL parameters of this link. |
anchorLink - String
|
The Anchor link of this link |
externalUrl - String!
|
The URL of the external link. |
numberOfRedirects - Int!
|
|
redirectType - String
|
|
ignoreValidate - Boolean!
|
Example
{
"id": 4,
"version": {},
"openLinkInNewWindow": true,
"urlParameters": "abc123",
"anchorLink": "abc123",
"externalUrl": "abc123",
"numberOfRedirects": 123,
"redirectType": "abc123",
"ignoreValidate": true
}
ExternalLinkInput
Description
Additional information to describe an external link.
Example
{
"externalUrl": "abc123",
"numberOfRedirects": 987,
"redirectType": "xyz789",
"ignoreValidate": true
}
ExtractZipFileInput
Fields
| Input Field | Description |
|---|---|
uploadedMcsString - String!
|
The uploaded Mcs display string |
importedId - Long!
|
Asset imported id inside cached bytes |
zipImportedType - ZipImportType
|
Selected Zip import type option |
Example
{
"uploadedMcsString": "abc123",
"importedId": {},
"zipImportedType": "BULK_IMAGES"
}
FieldNamesFilterInput
Fields
| Input Field | Description |
|---|---|
searchTerm - String
|
The searchTerm is used to filter by name |
Example
{"searchTerm": "xyz789"}
FieldNamesFindPayload
Fields
| Field Name | Description |
|---|---|
entries - [String!]
|
List of Fields |
Example
{"entries": ["xyz789"]}
FieldNamesPagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
Paging information.{Default return 100 entries from start}. Default = {limit: 100, offset: 0} |
Example
{"paging": Paging}
FilterCategory
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
|
deleteDate - DateTime
|
The date when the entry will be deleted or null if it won't be deleted |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
ancestors - [NavigationTreeEntry!]!
|
|
parent - NavigationTreeEntry
|
|
children - NavigationTreeEntryChildrenPayload!
|
|
Arguments
|
|
valid - Boolean!
|
|
status - CategoryStatus!
|
|
publishStatus - PublishStatus!
|
|
url - String
|
|
previewUrl - String!
|
|
Arguments
|
|
description - String
|
|
invalidReason - String
|
|
timeValidity - TimeValidity!
|
|
timeStatus - TimeValidityStatus!
|
use status attribute instead of timeStatus See: ISBO-15517 |
criteria - FilterCategoryCondition
|
|
sourceCategories - [PimCategory!]!
|
|
blocklistCategories - [NavigationTreeEntry!]!
|
|
overwrittenValue - NavigationTreeEntry
|
|
originalTreeType - TreeType
|
|
paths - [String!]!
|
|
referenceType - PageReferenceType!
|
|
categoryParameters - CategoryParameterFindPayload!
|
|
Arguments
|
|
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"name": "xyz789",
"deleteDate": "2007-12-03T10:15:30Z",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"ancestors": [NavigationTreeEntry],
"parent": NavigationTreeEntry,
"children": NavigationTreeEntryChildrenPayload,
"valid": true,
"status": "INVALID",
"publishStatus": "PUBLISHED",
"url": "abc123",
"previewUrl": "abc123",
"description": "xyz789",
"invalidReason": "xyz789",
"timeValidity": Campaign,
"timeStatus": "ACTIVE",
"criteria": FilterCategoryCondition,
"sourceCategories": [PimCategory],
"blocklistCategories": [NavigationTreeEntry],
"overwrittenValue": NavigationTreeEntry,
"originalTreeType": "ArchiveTree",
"paths": ["xyz789"],
"referenceType": "NONE",
"categoryParameters": CategoryParameterFindPayload
}
FilterCategoryChild
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
|
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
ancestors - [NavigationTreeEntry!]!
|
|
parent - NavigationTreeEntry!
|
|
children - NavigationTreeEntryChildrenPayload!
|
|
Arguments
|
|
valid - Boolean!
|
|
paths - [String!]!
|
|
status - CategoryStatus!
|
|
referenceType - PageReferenceType!
|
|
categoryParameters - CategoryParameterFindPayload!
|
|
Arguments
|
|
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"name": "xyz789",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"ancestors": [NavigationTreeEntry],
"parent": NavigationTreeEntry,
"children": NavigationTreeEntryChildrenPayload,
"valid": true,
"paths": ["abc123"],
"status": "INVALID",
"referenceType": "NONE",
"categoryParameters": CategoryParameterFindPayload
}
FilterCategoryCondition
Fields
| Field Name | Description |
|---|---|
dynamicCondition - Condition
|
|
limitType - FilterLimitType!
|
|
limitValue - Int!
|
|
useSkuSort - Boolean!
|
Example
{
"dynamicCondition": ComplexCondition,
"limitType": "None",
"limitValue": 123,
"useSkuSort": false
}
FilterConditionType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
description - String
|
|
filters - [SmartFilter!]!
|
Example
{
"id": "4",
"displayName": "abc123",
"description": "abc123",
"filters": [SmartFilter]
}
FilterFindPayload
Description
Filters payload
Fields
| Field Name | Description |
|---|---|
entries - [SmartFilter!]!
|
The list available smart filters. |
totalCount - Int!
|
The complete count of filters |
Example
{"entries": [SmartFilter], "totalCount": 987}
FilterLevel
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
|
deleteDate - DateTime
|
The date when the entry will be deleted or null if it won't be deleted |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
ancestors - [NavigationTreeEntry!]!
|
|
parent - NavigationTreeEntry
|
|
children - NavigationTreeEntryChildrenPayload!
|
|
Arguments
|
|
valid - Boolean!
|
|
status - CategoryStatus!
|
|
description - String
|
|
criteria - FilterLevelCondition!
|
|
overwrittenValue - NavigationTreeEntry
|
|
originalTreeType - TreeType
|
|
referenceType - PageReferenceType!
|
|
categoryParameters - CategoryParameterFindPayload!
|
|
Arguments
|
|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"name": "xyz789",
"deleteDate": "2007-12-03T10:15:30Z",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"ancestors": [NavigationTreeEntry],
"parent": NavigationTreeEntry,
"children": NavigationTreeEntryChildrenPayload,
"valid": false,
"status": "INVALID",
"description": "xyz789",
"criteria": FilterLevelCondition,
"overwrittenValue": NavigationTreeEntry,
"originalTreeType": "ArchiveTree",
"referenceType": "NONE",
"categoryParameters": CategoryParameterFindPayload
}
FilterLevelCondition
Fields
| Field Name | Description |
|---|---|
dynamicCondition - Condition
|
Example
{"dynamicCondition": ComplexCondition}
FilterLimitType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"None"
FilterListValue
Fields
| Field Name | Description |
|---|---|
filterList - [String!]!
|
Example
{"filterList": ["abc123"]}
FilterSortColumn
Description
Representation in which will the result be sorted
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"URL_KEY"
FilterSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
list order value (default order is DESC). Default = ASC |
sortColumn - FilterSortColumn!
|
Column names which are allowed to sort with. Default = DISPLAY_NAME |
Example
{"sortOrder": "ASC", "sortColumn": "URL_KEY"}
FilterValue
FiltersFilterInput
Fields
| Input Field | Description |
|---|---|
urlName - String
|
URL name for specific filter |
Example
{"urlName": "abc123"}
FiltersPagingInput
Fields
| Input Field | Description |
|---|---|
pagingInput - Paging!
|
Paging information.{Default return 100 entries from start}. Default = {limit: 100, offset: 0} |
sortInput - FilterSortInput!
|
Sorting information.{Default Descending on Id field}. Default = {sortOrder: ASC, sortColumn: DISPLAY_NAME} |
Example
{
"pagingInput": Paging,
"sortInput": FilterSortInput
}
FindArticleFilterInput
Description
Represents the article find criteria.
Fields
| Input Field | Description |
|---|---|
articleIdentifier - [Article_ID!]!
|
A list of article identifier. |
mcsInput - McsInput!
|
The mcs in which the search for items is done. |
Example
{
"articleIdentifier": [Article_ID],
"mcsInput": McsInput
}
FindBySimpleIdFilterInput
Fields
| Input Field | Description |
|---|---|
simpleId - String!
|
Example
{"simpleId": "abc123"}
FindBySimpleIdPayload
Fields
| Field Name | Description |
|---|---|
osbIShopObjects - [OsbIShopObject!]!
|
Example
{"osbIShopObjects": [OsbCategory]}
FindByTypeFilterInput
Fields
| Input Field | Description |
|---|---|
type - OsbType!
|
Example
{"type": "ITEM"}
FindByTypePayload
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
osbIShopObjects - [OsbIShopObject!]!
|
Example
{"totalCount": 123, "osbIShopObjects": [OsbCategory]}
FindGridElementContainerInput
Fields
| Input Field | Description |
|---|---|
gridElement - ID!
|
|
exactTime - DateTime!
|
|
customerSegment - ID
|
If the container is customer segmented and no ID is given, all most defined containers per customer segment are returned. If for the given customer segment ID is no container maintained, the most defined container of the default customer segment is returned. |
Example
{
"gridElement": 4,
"exactTime": "2007-12-03T10:15:30Z",
"customerSegment": "4"
}
FindGridInput
FindInAttributeFilterInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
mcs - [McsInput!]!
|
|
operation - OsbAttributeFilterOperationUnion!
|
Example
{
"name": "abc123",
"mcs": [McsInput],
"operation": OsbAttributeFilterOperationUnion
}
FindInAttributePayload
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
osbIShopObjects - [OsbIShopObject!]!
|
Example
{"totalCount": 987, "osbIShopObjects": [OsbCategory]}
FindInIndexFilterInput
FindInIndexPayload
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
searchResults - [OsbSearchResult!]!
|
Example
{"totalCount": 987, "searchResults": [OsbSearchResult]}
FindPayload
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
Possible Types
| FindPayload Types |
|---|
Example
{"totalCount": 123}
FindRootCategoryFilterInput
Fields
| Input Field | Description |
|---|---|
mcs - [McsInput!]!
|
Example
{"mcs": [McsInput]}
FindRootCategoryPayload
Fields
| Field Name | Description |
|---|---|
rootCategory - [OsbCategory!]!
|
Example
{"rootCategory": [OsbCategory]}
FindSearchDiagnosisInput
Description
Options for running a search with full explanation.
Fields
| Input Field | Description |
|---|---|
paging - SearchDiagnosisPaging
|
Paging information. |
searchTerm - String!
|
A searchterm to search for. |
scenarioIndex - Int
|
The index of the scenario to use for searching. Default: -1. Default = -1 |
categoryId - String
|
The ID of a category to search in. |
Example
{
"paging": SearchDiagnosisPaging,
"searchTerm": "xyz789",
"scenarioIndex": 123,
"categoryId": "abc123"
}
FindSearchExclusionInput
Description
Paging and filter information for search exclusions.
Fields
| Input Field | Description |
|---|---|
paging - SearchExclusionPagingInput!
|
Paging information. Default = {sortType: INFO, sortOrder: DESC, offset: 0, limit: 100} |
filter - SearchExclusionFilter!
|
Filter information. Default = {onlyExact: false, searchTerms: [], withParentMcs: true} |
name - String
|
An optional name for this filter input. |
mcsInput - McsInput!
|
The mcs for the search. |
Example
{
"paging": SearchExclusionPagingInput,
"filter": SearchExclusionFilter,
"name": "xyz789",
"mcsInput": McsInput
}
FindSearchIndexScenarioAttributeInput
Description
Sorting and paging information for search index attributes.
Fields
| Input Field | Description |
|---|---|
filter - SearchIndexScenarioAttributeFilterInput!
|
Filter information. |
paging - SearchIndexScenarioAttributePagingInput!
|
Paging information. Default = {sortColumn: INFO, sortOrder: ASC, offset: 0, limit: 100} |
Example
{
"filter": SearchIndexScenarioAttributeFilterInput,
"paging": SearchIndexScenarioAttributePagingInput
}
FindSearchIndexingScenarioInput
Description
Sorting and paging information for search index scenarios.
Fields
| Input Field | Description |
|---|---|
filter - SearchIndexingScenarioFilterInput!
|
Filter information. |
paging - SearchIndexingScenarioPagingInput!
|
Paging information. Default = {sortColumn: INFO, sortOrder: DESC} |
Example
{
"filter": SearchIndexingScenarioFilterInput,
"paging": SearchIndexingScenarioPagingInput
}
FindSearchSuggestAttributesInput
Description
A searchterm and paging/MCS parameters describing a set of global parameters.
Fields
| Input Field | Description |
|---|---|
searchTerm - String!
|
The searchterm. Default: Empty String. Default = "" |
paging - SearchSuggestPagingInput!
|
Paging information |
mcsInput - McsInput!
|
The mcs input for the search. |
Example
{
"searchTerm": "abc123",
"paging": SearchSuggestPagingInput,
"mcsInput": McsInput
}
FindSearchTermGroupInput
Description
Representation about a search for search term groups
Fields
| Input Field | Description |
|---|---|
paging - SearchTermGroupPagingInput!
|
Information about paging. Default = {sorting: INFO, sortOrder: DESC, offset: 0, limit: 100} |
filter - SearchTermGroupFilterInput!
|
Additional filters. Default = {onlyExact: false, searchTerms: [], ids: []} |
Example
{
"paging": SearchTermGroupPagingInput,
"filter": SearchTermGroupFilterInput
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
FormatCreatePayload
Description
Payload wrapper object for creating export format
Fields
| Field Name | Description |
|---|---|
entries - [DataExportFormat!]!
|
List of created export format |
Example
{"entries": [DataExportFormat]}
FormatDeletePayload
Description
Payload wrapper object for deleting export format
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Flag for success. |
Example
{"successful": false}
FormatListPagingInput
Fields
| Input Field | Description |
|---|---|
pagingInput - Paging!
|
Paging information. Default = {limit: 100, offset: 0} |
sortInput - FormatListSortInput!
|
Sorting information. {Default asc by name}. Default = {sortOrder: ASC, sortColumn: NAME} |
Example
{
"pagingInput": Paging,
"sortInput": FormatListSortInput
}
FormatListSortColumn
Description
Representation in which will the result be sorted
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NAME"
FormatListSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
list order value (default order is ASC). Default = ASC |
sortColumn - FormatListSortColumn!
|
Column names which are allowed to sort with. Default = NAME |
Example
{"sortOrder": "ASC", "sortColumn": "NAME"}
FormatListsFilterInput
Fields
| Input Field | Description |
|---|---|
searchTerm - String
|
String keyword to search within format list name |
Example
{"searchTerm": "abc123"}
FormatListsFindPayload
Description
A list of format list records
Fields
| Field Name | Description |
|---|---|
entries - [DataExportFormat!]!
|
The list of format lists |
totalCount - Int!
|
The complete count of format list records |
Example
{"entries": [DataExportFormat], "totalCount": 123}
FormatUpdatePayload
Description
Payload wrapper object for updating export format
Fields
| Field Name | Description |
|---|---|
entries - [DataExportFormat!]!
|
Updated export format |
Example
{"entries": [DataExportFormat]}
FreeItemBenefitEntity
Description
Representation of a free item benefit
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the benefit. |
version - Long!
|
The version of the benefit. |
title - String
|
The maintained title of the benefit |
image - ImageEntity
|
The maintained image for the benefit |
benefitTarget - BenefitTarget!
|
Benefit target type |
itemIds - [String!]!
|
The selectable free items |
max - Int!
|
The max amount of selectable items |
Example
{
"id": "4",
"version": {},
"title": "abc123",
"image": ImageEntity,
"benefitTarget": "ITEM",
"itemIds": ["abc123"],
"max": 123
}
FreeShippingBenefitEntity
Description
Representation of a free shipping benefit
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the benefit. |
version - Long!
|
The version of the benefit. |
title - String
|
The maintained title of the benefit |
image - ImageEntity
|
The maintained image for the benefit |
benefitTarget - BenefitTarget!
|
Benefit target type |
Example
{
"id": "4",
"version": {},
"title": "abc123",
"image": ImageEntity,
"benefitTarget": "ITEM"
}
FtpType
Fields
| Field Name | Description |
|---|---|
fileName - String!
|
The exported file name |
url - String!
|
The exported file URL |
exportSchedule - ExportScheduleValue!
|
The scheduled export frequency |
Example
{
"fileName": "xyz789",
"url": "xyz789",
"exportSchedule": Now
}
GenerateImageDescriptionsInput
Fields
| Input Field | Description |
|---|---|
imageDetails - [ImageDetailsInput!]!
|
|
targetLanguages - [String!]!
|
|
ignoreImageText - Boolean!
|
|
useSingleQuotationMarks - Boolean!
|
|
imageDescriptionsGptModel - GptModel!
|
|
outputNoOfSentences - Int!
|
|
context - String
|
Example
{
"imageDetails": [ImageDetailsInput],
"targetLanguages": ["abc123"],
"ignoreImageText": false,
"useSingleQuotationMarks": true,
"imageDescriptionsGptModel": "GPT3T",
"outputNoOfSentences": 123,
"context": "abc123"
}
GenerateImageDescriptionsPayload
Fields
| Field Name | Description |
|---|---|
errorMessage - String
|
|
entries - [DescriptionsForImage!]!
|
Example
{
"errorMessage": "abc123",
"entries": [DescriptionsForImage]
}
GenerateSynonymsInput
Fields
| Input Field | Description |
|---|---|
searchTerms - [String!]!
|
|
inputLanguage - String
|
|
targetLanguage - [String!]!
|
|
descriptionLanguage - [String!]!
|
|
maxNumberOfHits - Int!
|
|
generationContext - String
|
|
includeDescription - Boolean!
|
|
synonymCreatorGptModel - GptModel!
|
|
creativityFactor - Float!
|
Max value: 1.0. Default = 0 |
ignoreSearchTermLimit - Boolean!
|
Ignores the limit of 50 search terms. Default = false |
Example
{
"searchTerms": ["xyz789"],
"inputLanguage": "abc123",
"targetLanguage": ["xyz789"],
"descriptionLanguage": ["xyz789"],
"maxNumberOfHits": 987,
"generationContext": "xyz789",
"includeDescription": false,
"synonymCreatorGptModel": "GPT3T",
"creativityFactor": 987.65,
"ignoreSearchTermLimit": true
}
GenerateSynonymsPayload
Fields
| Field Name | Description |
|---|---|
errorMessage - String
|
|
entries - [SynonymsForSearchTerm!]!
|
Example
{
"errorMessage": "abc123",
"entries": [SynonymsForSearchTerm]
}
GenerateTranslationsInput
Fields
| Input Field | Description |
|---|---|
inputLocale - String
|
|
targetLocales - [String!]!
|
|
translationDetails - [TranslationDetailsInput!]!
|
|
translationsCreatorGptModel - GptModel
|
Example
{
"inputLocale": "xyz789",
"targetLocales": ["abc123"],
"translationDetails": [TranslationDetailsInput],
"translationsCreatorGptModel": "GPT3T"
}
GenerateTranslationsPayload
Fields
| Field Name | Description |
|---|---|
errorMessage - String
|
|
entries - [TranslationsForInput!]!
|
Example
{
"errorMessage": "abc123",
"entries": [TranslationsForInput]
}
GenerateVoucherCodeCommonVoucher
Values
| Enum Value | Description |
|---|---|
|
|
Example
"GENERATE"
GenerateVoucherCodePersonalVoucher
Fields
| Input Field | Description |
|---|---|
setCustomerIdentifier - SetCustomerIdentifier!
|
Example
{"setCustomerIdentifier": SetCustomerIdentifier}
GlobalContentPage
GlobalParameter
Description
A description of a global parameter.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
A unique ID |
version - Long!
|
A version |
name - String!
|
The descriptive name of this parameter |
parameters - GlobalParameterAttributes!
|
A list of parameter attributes |
allowedValues - [AllowedValue!]!
|
A List of allowed Values in this parameter. |
options - [AttributeOption!]!
|
The possible values for this parameter. |
Example
{
"id": "4",
"version": {},
"name": "xyz789",
"parameters": GlobalParameterAttributes,
"allowedValues": [AllowedValue],
"options": [AttributeOption]
}
GlobalParameterAttribute
Description
A description of a global parameter attribute
Fields
| Field Name | Description |
|---|---|
id - ID!
|
A unique ID |
version - Long!
|
A version |
name - String!
|
The global attribute name |
inherited - Boolean!
|
Flag describing if this parameter is inherited from a higher MCS |
mcs - Mcs!
|
The MCS containing this parameter |
value - ContentAttribute!
|
The attribute value. This value might be further divided by AB-Testscenarios or customer segments. |
Example
{
"id": "4",
"version": {},
"name": "abc123",
"inherited": true,
"mcs": Mcs,
"value": ContentAttribute
}
GlobalParameterAttributeInput
Description
A description of a new global parameter attribute
Fields
| Input Field | Description |
|---|---|
id - ID
|
A unique ID |
version - Long
|
A version |
name - String!
|
The descriptive name of this attribute |
contentAttributeInput - ContentAttributeInput!
|
The attribute value. This value might be further divided by AB-Testscenarios or customer segments. |
Example
{
"id": 4,
"version": {},
"name": "xyz789",
"contentAttributeInput": ContentAttributeInput
}
GlobalParameterAttributes
Description
A list of global parameter attributes
Fields
| Field Name | Description |
|---|---|
entries - [GlobalParameterAttribute!]!
|
The list of attributes, affected by paging. |
totalCount - Int!
|
The total amount of attributes, unaffected by paging. Count is calculated for given filter and mcs |
Example
{"entries": [GlobalParameterAttribute], "totalCount": 987}
GlobalParameterCopyPayload
Fields
| Field Name | Description |
|---|---|
entries - [GlobalParameter_2!]!
|
Example
{"entries": [GlobalParameter_2]}
GlobalParameterCreatePayload
Fields
| Field Name | Description |
|---|---|
entries - [GlobalParameter_2!]!
|
Example
{"entries": [GlobalParameter_2]}
GlobalParameterDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": false}
GlobalParameterFilterInput
Description
Additional Filter information
Fields
| Input Field | Description |
|---|---|
status - GlobalParameterStatus!
|
The status to search for, giving additional information about it's life cycle. Default value is ALL. Default = ALL |
attribute - String
|
Global parameter attribute name |
value - Int
|
Global parameter attribute value |
searchTerms - [String!]
|
A List of search terms to look for. |
startDate - DateTime
|
The start of the time frame to search in. |
endDate - DateTime
|
The end of the time frame to search in. |
Example
{
"status": "ALL",
"attribute": "abc123",
"value": 987,
"searchTerms": ["abc123"],
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z"
}
GlobalParameterFilterInput2
Description
QUERY INPUT
Fields
| Input Field | Description |
|---|---|
parameterIds - [ID!]
|
|
parameterTypeById - [ID!]
|
|
parameterTypeByKey - [String!]
|
|
status - [TimeValidityStatus!]
|
|
campaignIds - ID
|
When filter for campaign, filter for start or end will be ignored |
startDate - DateTime
|
|
endDate - DateTime
|
|
attributeName - String
|
|
searchValue - String
|
Example
{
"parameterIds": ["4"],
"parameterTypeById": ["4"],
"parameterTypeByKey": ["xyz789"],
"status": ["ACTIVE"],
"campaignIds": "4",
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"attributeName": "abc123",
"searchValue": "xyz789"
}
GlobalParameterFindPayload
Description
PAYLOADS
Fields
| Field Name | Description |
|---|---|
entries - [GlobalParameter_2!]!
|
|
totalCount - Int!
|
Example
{"entries": [GlobalParameter_2], "totalCount": 987}
GlobalParameterInput
Description
A description of a new global parameter
Fields
| Input Field | Description |
|---|---|
id - ID
|
A unique ID |
version - Long
|
A version |
attributeDescriptionName - String
|
The descriptive name of this parameter |
mcsInput - McsInput!
|
The mcs of the parameter. |
parameters - [GlobalParameterAttributeInput!]!
|
A list of parameter attributes |
Example
{
"id": 4,
"version": {},
"attributeDescriptionName": "abc123",
"mcsInput": McsInput,
"parameters": [GlobalParameterAttributeInput]
}
GlobalParameterPagingInput
Description
Information about Paging
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder
|
The sorting order. Default is Ascending. Default = ASC |
sortType - GlobalParameterSortTypeInput
|
After what parameter should the result be sorted. Default: Default. Default = INFO |
limit - Int
|
Limit of results per page. Default: 100. Default = 100 |
offset - Int
|
Offset of results that should be skipped. Default: 0. Default = 0 |
Example
{"sortOrder": "ASC", "sortType": "STATUS", "limit": 123, "offset": 987}
GlobalParameterSearchInput
Description
All relevant information needed to conduct a search
Fields
| Input Field | Description |
|---|---|
paging - GlobalParameterPagingInput!
|
Paging information |
filter - GlobalParameterFilterInput
|
Additional Filter information |
searchTerm - String
|
The search term to search for |
mcsInput - McsInput!
|
The mcs for the search. |
Example
{
"paging": GlobalParameterPagingInput,
"filter": GlobalParameterFilterInput,
"searchTerm": "abc123",
"mcsInput": McsInput
}
GlobalParameterSortTypeInput
Description
Enum describing by what descriptor the returned parameters should be sorted
Values
| Enum Value | Description |
|---|---|
|
|
Sort by the status of the parameters |
|
|
Sort by attribute |
|
|
Sort by value |
|
|
Sort by start date |
|
|
Sort by end date |
|
|
Sorts by inherited mcs, with entries of the current mcs always at the bottom. Sorting within the mcs entries is not defined. |
Example
"STATUS"
GlobalParameterStatus
Description
The Parameter status gives Information about it's life cycle.
Values
| Enum Value | Description |
|---|---|
|
|
All Statuses are allowed |
|
|
The parameter is currently active |
|
|
The parameter is no longer active |
|
|
The parameter is not yet active |
Example
"ALL"
GlobalParameterUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [GlobalParameter_2!]!
|
Example
{"entries": [GlobalParameter_2]}
GlobalParameter_2
Description
TYPES
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
inherited - Boolean!
|
|
overwrites - GlobalParameter_2
|
|
parameterType - AttributeDescriptionType!
|
|
attributeName - String!
|
|
attributeValue - DynamicAttributeValue!
|
|
description - String
|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"inherited": false,
"overwrites": GlobalParameter_2,
"parameterType": AttributeDescriptionType,
"attributeName": "abc123",
"attributeValue": DynamicAttributeValue,
"description": "xyz789"
}
GlobalTreeFilterInput
Description
INPUT
Fields
| Input Field | Description |
|---|---|
ids - [ID!]!
|
|
names - [String!]!
|
|
hasContent - Boolean
|
Example
{
"ids": [4],
"names": ["xyz789"],
"hasContent": true
}
GlobalTreeFindPayload
Description
TYPES
Fields
| Field Name | Description |
|---|---|
entries - [GlobalContentPage!]!
|
|
totalCount - Int!
|
Example
{"entries": [GlobalContentPage], "totalCount": 123}
GlobalTreePagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging
|
|
sorting - GlobalTreeSortInput
|
Example
{
"paging": Paging,
"sorting": GlobalTreeSortInput
}
GlobalTreeSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder
|
|
sortColumn - GlobalTreeSortType
|
Example
{"sortOrder": "ASC", "sortColumn": "NAME"}
GlobalTreeSortType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NAME"
GoogleCategory
Description
Representation of a google category.
This is only a start and should be extended with values you need.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this google category. |
version - Long!
|
The version of this google category. |
name - String!
|
The name of this google category. |
createdDate - DateTime!
|
The date this category was imported |
level - Int!
|
The level in category tree, 0 if root element |
hasChildren - Boolean!
|
Flag if this category has children |
parentCategory - GoogleCategory
|
The parent category for this category. Null if it is the root element. |
ancestors - [GoogleCategory!]!
|
|
children - [GoogleCategory!]!
|
|
Arguments
|
|
Example
{
"id": "4",
"version": {},
"name": "abc123",
"createdDate": "2007-12-03T10:15:30Z",
"level": 987,
"hasChildren": true,
"parentCategory": GoogleCategory,
"ancestors": [GoogleCategory],
"children": [GoogleCategory]
}
GoogleCategoryFilterInput
Description
s Filter options to find google categories.
Example
{
"ids": [4],
"searchTerms": ["abc123"],
"levels": [987],
"parentIds": [4]
}
GoogleCategoryFindPayload
Description
A list of google categories without further details as a result
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
The total amount of results found, unaffected by paging |
entries - [GoogleCategory!]!
|
The result list of google categories, affected by paging |
Example
{"totalCount": 987, "entries": [GoogleCategory]}
GoogleCategoryPagingInput
Description
All relevant information needed to conduct a search
Fields
| Input Field | Description |
|---|---|
pagingInput - Paging!
|
Paging information Default return 100 entries from start. Default = {limit: 100, offset: 0} |
sortInput - GoogleCategorySortingInput!
|
Sorting information Default Ascending on google category id. Default = {sortOrder: ASC, sortType: NAME} |
Example
{
"pagingInput": Paging,
"sortInput": GoogleCategorySortingInput
}
GoogleCategorySortTypeInput
Description
Enum describing by what descriptor the returned google categories should be sorted
Values
| Enum Value | Description |
|---|---|
|
|
Sort by name |
Example
"NAME"
GoogleCategorySortingInput
Description
Sorting information
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
The sorting order. Default Ascending. Default = ASC |
sortType - GoogleCategorySortTypeInput!
|
Which parameter should the result be sorted on. Default: name. Default = NAME |
Example
{"sortOrder": "ASC", "sortType": "NAME"}
GptModel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"GPT3T"
GraphQlCategory
Description
deprecated use NavigationTreeEntry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique ID of this category |
version - Long!
|
A version of the category entity |
simpleId - String!
|
The simple ID of this category |
mcs - Mcs!
|
The MCS containing this category |
status - CategoryStatus
|
A flag describing if this category is online. |
valid - Boolean!
|
A flag describing if this category is valid |
Possible Types
| GraphQlCategory Types |
|---|
Example
{
"id": "4",
"version": {},
"simpleId": "xyz789",
"mcs": Mcs,
"status": "INVALID",
"valid": false
}
Grid
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
name - String!
|
|
timeValidity - DateRange!
|
|
mcs - Mcs!
|
|
inherited - Boolean!
|
|
abScenario - AbTestScenario
|
If and what ABScenario gets returned is depending on the given reference time. When no reference time is given, this will always return null |
Arguments
|
|
audit - BackofficeUserInfoAudit!
|
|
gridElements - GridElementPayload!
|
The grid elements are always sorted by row then by column. They can be filtered by reference time, so that only gridElements where the referenceTime falls in their timeValidity are returned. |
Arguments
|
|
Example
{
"id": "4",
"version": {},
"name": "xyz789",
"timeValidity": DateRange,
"mcs": Mcs,
"inherited": true,
"abScenario": AbTestScenario,
"audit": BackofficeUserInfoAudit,
"gridElements": GridElementPayload
}
GridAssignAbTestPayload
Fields
| Field Name | Description |
|---|---|
grid - Grid!
|
Example
{"grid": Grid}
GridContainerParameter
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
parameterType - AttributeDescriptionType!
|
|
attributeValue - DynamicAttributeValue!
|
|
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"parameterType": AttributeDescriptionType,
"attributeValue": DynamicAttributeValue,
"backofficeUserInfoAudit": BackofficeUserInfoAudit
}
GridContainerParameterPayload
Fields
| Field Name | Description |
|---|---|
entries - [GridContainerParameter]!
|
|
totalCount - Int!
|
Example
{"entries": [GridContainerParameter], "totalCount": 987}
GridContainerType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Normal"
GridCreatePayload
Fields
| Field Name | Description |
|---|---|
entries - [Grid!]!
|
Example
{"entries": [Grid]}
GridDeletePayload
Description
type GridCopyPayload { entries: [Grid!]! }
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": true}
GridElement
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
name - String!
|
|
trackingCode - String
|
|
type - GridContainerType!
|
|
position - ElementPosition!
|
|
parameter - GridContainerParameterPayload!
|
|
Arguments
|
|
audit - BackofficeUserInfoAudit!
|
|
container - GridElementContainerPayload!
|
|
Arguments
|
|
Example
{
"id": 4,
"version": {},
"name": "abc123",
"trackingCode": "xyz789",
"type": "Normal",
"position": ElementPosition,
"parameter": GridContainerParameterPayload,
"audit": BackofficeUserInfoAudit,
"container": GridElementContainerPayload
}
GridElementContainer
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
timeValidity - TimeValidity!
|
|
mcs - Mcs!
|
|
inherited - Boolean!
|
|
customerSegments - [CustomerSegment!]!
|
|
teaser - Teaser!
|
Example
{
"id": 4,
"version": {},
"timeValidity": Campaign,
"mcs": Mcs,
"inherited": true,
"customerSegments": [CustomerSegment],
"teaser": Teaser
}
GridElementContainerFilterOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
gridElement - GridElementFilter
|
|
exactTime - ExactTimeFilter
|
|
timeValidity - TimeValidityFilter
|
|
customerSegment - CustomerSegmentFilter
|
Example
{
"gridElement": GridElementFilter,
"exactTime": ExactTimeFilter,
"timeValidity": TimeValidityFilter,
"customerSegment": CustomerSegmentFilter
}
GridElementContainerPayload
Fields
| Field Name | Description |
|---|---|
entries - [GridElementContainer]!
|
|
totalCount - Int!
|
Example
{"entries": [GridElementContainer], "totalCount": 987}
GridElementContainerSortOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
time - TimeSort
|
Example
{"time": TimeSort}
GridElementFilter
Fields
| Input Field | Description |
|---|---|
value - [ID!]!
|
Example
{"value": ["4"]}
GridElementPayload
Fields
| Field Name | Description |
|---|---|
entries - [GridElement]!
|
|
totalCount - Int!
|
Example
{"entries": [GridElement], "totalCount": 987}
GridElementUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [GridElement!]!
|
FIXME ISBO-15449 which containers should be returned, filtering is needed here |
Example
{"entries": [GridElement]}
GridFilter
Fields
| Input Field | Description |
|---|---|
value - [ID!]!
|
Example
{"value": ["4"]}
GridFilterOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
grid - GridFilter
|
|
navigationTreeEntry - NavigationTreeEntryFilter
|
|
exactTime - ExactTimeFilter
|
|
abTestScenario - ABTestScenarioFilter
|
Example
{
"grid": GridFilter,
"navigationTreeEntry": NavigationTreeEntryFilter,
"exactTime": ExactTimeFilter,
"abTestScenario": ABTestScenarioFilter
}
GridPayload
GridSortOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
time - TimeSort
|
Example
{"time": TimeSort}
GridTemplate
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
inherited - Boolean!
|
|
name - String!
|
|
template - TeaserTemplate!
|
The TemplateType which defines this GridTemplate |
containers - [GridTemplateContainer!]!
|
A List of Containers which are included in this Template |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"inherited": false,
"name": "xyz789",
"template": TeaserTemplate,
"containers": [GridTemplateContainer],
"backofficeUserInfoAudit": BackofficeUserInfoAudit
}
GridTemplateContainer
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
The name, consisting of Rastername and the position of this container |
inherited - Boolean!
|
|
gridContainerTrackingCode - String
|
|
gridContainerType - GridContainerType!
|
The Type defines if a Container must be filled or not. This affects the status in Timeline |
xCoordinate - Int!
|
X Coordinate in number of columns |
yCoordinate - Int!
|
Y Coordinate in number of columns |
width - Int!
|
width in number of columns |
height - Int!
|
heigth in number of columns |
parameter - [GridContainerParameter!]!
|
optional parameters |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"name": "xyz789",
"inherited": false,
"gridContainerTrackingCode": "abc123",
"gridContainerType": "Normal",
"xCoordinate": 987,
"yCoordinate": 987,
"width": 987,
"height": 987,
"parameter": [GridContainerParameter],
"backofficeUserInfoAudit": BackofficeUserInfoAudit
}
GridTemplateCreatePayload
Fields
| Field Name | Description |
|---|---|
entries - [GridTemplate!]!
|
Example
{"entries": [GridTemplate]}
GridTemplateDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": true}
GridTemplateFilterInput
Example
{
"ids": [4],
"name": "xyz789",
"onlyCurrentUser": false
}
GridTemplateFindPayload
Fields
| Field Name | Description |
|---|---|
entries - [GridTemplate!]!
|
|
totalCount - Int!
|
Example
{"entries": [GridTemplate], "totalCount": 987}
GridTemplatePagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
|
sortOn - GridTemplateSortingInput!
|
Example
{
"paging": Paging,
"sortOn": GridTemplateSortingInput
}
GridTemplateSortColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"INFO"
GridTemplateSortingInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
|
sortColumn - GridTemplateSortColumn!
|
Example
{"sortOrder": "ASC", "sortColumn": "INFO"}
GridTemplateUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [GridTemplate!]!
|
Example
{"entries": [GridTemplate]}
GridUnassignAbTestPayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": true}
GridUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [Grid!]!
|
Example
{"entries": [Grid]}
GroupModel
Example
{
"groupId": 4,
"groupName": "xyz789",
"dynamic": false,
"priority": 987
}
HideCategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"URL"
HotSpotValue
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
hotSpotLink - AttributeLink!
|
|
hotSpotLinkTrackingParameter - String
|
|
hotSpotCoordinates - [Coordinates!]!
|
|
hotSpotText - String
|
Example
{
"id": "4",
"version": {},
"hotSpotLink": ArticleLink,
"hotSpotLinkTrackingParameter": "abc123",
"hotSpotCoordinates": [Coordinates],
"hotSpotText": "xyz789"
}
HotSpotValues
Fields
| Field Name | Description |
|---|---|
values - [HotSpotValue!]!
|
Example
{"values": [HotSpotValue]}
HourFormat
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AMPM"
HttpType
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
IShopObject
Description
The base interface for iSHOP objects
Example
{"id": 4, "fullyQualifiedId": 4, "valid": true}
ImageDetailsInput
ImageEntity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the entity. |
version - Long!
|
The version of the entity. |
name - String!
|
File name |
mcs - Mcs!
|
Shop which this image was uploaded to |
contentType - String
|
File type (e.g. png/pdf/zip, ...etc) |
assetCategory - AssetCategory
|
Enum for Asset type to be used in icon rendering |
size - Long
|
File size in bytes (after optimization). in the first upload it will be equal to originalSize |
keywords - [String!]!
|
List of keywords |
url - String
|
URL for files |
uploadedDate - DateTime
|
The first time this file was uploaded |
lastModified - DateTime
|
The time this file was edited/updated |
uploadedUser - UserInformation
|
The user who uploaded this file |
editedUser - UserInformation
|
The last user who edited/updated this file |
dimension - Dimension!
|
Image's dimension for width and height |
title - String
|
Image's title attribute |
alt - String
|
Image's alt attribute |
assetTags - [AssetTagsEntity!]!
|
Mcs specific alt- and title-tags |
optimized - Boolean
|
Optimized flag, if it was optimized before or not |
originalSize - Long
|
Original size before optimized |
assetType - AssetType
|
Enum represents the actual Asset types |
Example
{
"id": 4,
"version": {},
"name": "xyz789",
"mcs": Mcs,
"contentType": "xyz789",
"assetCategory": "IMAGE",
"size": {},
"keywords": ["xyz789"],
"url": "xyz789",
"uploadedDate": "2007-12-03T10:15:30Z",
"lastModified": "2007-12-03T10:15:30Z",
"uploadedUser": UserInformation,
"editedUser": UserInformation,
"dimension": Dimension,
"title": "abc123",
"alt": "xyz789",
"assetTags": [AssetTagsEntity],
"optimized": false,
"originalSize": {},
"assetType": "BINARY_IMAGE"
}
ImportedFileData
Fields
| Field Name | Description |
|---|---|
importedId - Long
|
|
fileName - String
|
|
fileSize - Long
|
|
contentType - String
|
|
checksum - String
|
|
assetCategory - AssetCategory
|
|
dimension - Dimension
|
|
uploadedMessageType - UploadedMessageType
|
|
uploadedStatus - UploadedStatus
|
|
statusMessages - [String]
|
Example
{
"importedId": {},
"fileName": "abc123",
"fileSize": {},
"contentType": "xyz789",
"checksum": "abc123",
"assetCategory": "IMAGE",
"dimension": Dimension,
"uploadedMessageType": "SAME_FILE_EXISTS",
"uploadedStatus": "SUCCESS",
"statusMessages": ["xyz789"]
}
IndexableAttribute
Fields
| Field Name | Description |
|---|---|
level - AttributeLevel!
|
|
attributeName - String!
|
|
displayName - String
|
|
description - String
|
Example
{
"level": "Product",
"attributeName": "abc123",
"displayName": "abc123",
"description": "xyz789"
}
IndexableAttributeFilterInput
Fields
| Input Field | Description |
|---|---|
level - AttributeLevel
|
|
attributeName - String
|
Example
{
"level": "Product",
"attributeName": "abc123"
}
IndexableAttributePagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
|
sorting - IndexableAttributeSortingInput!
|
Example
{
"paging": Paging,
"sorting": IndexableAttributeSortingInput
}
IndexableAttributeSortType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NAME"
IndexableAttributeSortingInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
|
sortType - IndexableAttributeSortType!
|
Example
{"sortOrder": "ASC", "sortType": "NAME"}
IndexingScenarioSortColumn
Description
Enum describing different columns of the search index scenarios.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Sorts bei inherited mcs, with entries of the current mcs always at the bottom. Sorting within the mcs entries is by name lexicographical ascending. |
Example
"NAME"
InformativeBenefitEntity
Description
Representation of an informative benefit
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the benefit. |
version - Long!
|
The version of the benefit. |
title - String
|
The maintained title of the benefit |
image - ImageEntity
|
The maintained image for the benefit |
informativeType - String!
|
The type of informative |
internalName - String
|
The internal name of informative |
Example
{
"id": 4,
"version": {},
"title": "abc123",
"image": ImageEntity,
"informativeType": "abc123",
"internalName": "xyz789"
}
InformativeBenefitFilterInput
Fields
| Input Field | Description |
|---|---|
searchTerm - String
|
Search term for values |
Example
{"searchTerm": "abc123"}
InformativeBenefitPagingInput
Fields
| Input Field | Description |
|---|---|
pagingInput - Paging!
|
Paging information.{Default return 100 entries from start}. Default = {limit: 100, offset: 0} |
Example
{"pagingInput": Paging}
InformativeBenefitsFindPayload
Description
A list of informative types with key and values
Fields
| Field Name | Description |
|---|---|
entries - [MapType!]!
|
The list of promotions after applying paging information |
totalCount - Int!
|
The complete count of promotions |
Example
{"entries": [MapType], "totalCount": 123}
InheritedTimelineEvent
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
IntValue
Fields
| Field Name | Description |
|---|---|
int - Int!
|
Example
{"int": 123}
IntegerComparisonConditionValue
Fields
| Field Name | Description |
|---|---|
value - Int!
|
|
operator - ComparisonOperator!
|
Example
{"value": 987, "operator": "GREATER_THAN_EQ"}
IntegerConditionValue
Fields
| Field Name | Description |
|---|---|
value - Int!
|
Example
{"value": 123}
Item
Description
Representation of an item
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of an item |
fullyQualifiedId - ID!
|
The full ID of the item |
valid - Boolean!
|
The validity state of an item |
articleNumber - String!
|
The unique ID of an item |
image - String
|
An optional image showing the item |
name - String!
|
A human-readable name |
brand - String
|
The brand of the item |
price - Money
|
The price of the item |
shopUrl - String
|
The url of where to find this item |
Example
{
"id": 4,
"fullyQualifiedId": "4",
"valid": true,
"articleNumber": "xyz789",
"image": "abc123",
"name": "abc123",
"brand": "xyz789",
"price": Money,
"shopUrl": "abc123"
}
ItemSortInput
Description
Represents the item sort criteria.
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
The sort order for sorting the items. Default = ASC |
sortType - ItemSortType!
|
The sort type for sorting the items. Default = ID |
Example
{"sortOrder": "ASC", "sortType": "ID"}
ItemSortType
Description
Represents the possible sort types to sort items.
Values
| Enum Value | Description |
|---|---|
|
|
Sorts by simple id ascending |
|
|
Sorts by status boolean |
|
|
Sorts by SKUs |
Example
"ID"
Item_2
Description
Representation of a shop item or variation.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The simple ID of this item. |
fullyQualifiedId - ID!
|
The full ID of this item. |
valid - Boolean!
|
The validity state of this item. |
product - Product
|
The product this item belongs to. |
url - String
|
The url to this item. |
imageUrl - String
|
The url to an image of this item. |
price - Money
|
The price of this item. |
Example
{
"id": "4",
"fullyQualifiedId": 4,
"valid": true,
"product": Product,
"url": "abc123",
"imageUrl": "xyz789",
"price": Money
}
KeyValueConditionType
KpiValue
Description
A single value in a kpi
Fields
| Field Name | Description |
|---|---|
value - Float!
|
The value |
Possible Types
| KpiValue Types |
|---|
Example
{"value": 987.65}
LandingPageCopyPayload
Fields
| Field Name | Description |
|---|---|
entries - [CuratedPage!]!
|
Example
{"entries": [CuratedPage]}
LandingPageCreatePayload
Description
TYPES
Fields
| Field Name | Description |
|---|---|
entries - [CuratedPage!]!
|
Example
{"entries": [CuratedPage]}
LandingPageDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": true}
LandingPageUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [CuratedPage!]!
|
Example
{"entries": [CuratedPage]}
LandingTreeEntry
Description
Defines the types that can be part of the landing page tree.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
|
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
ancestors - [NavigationTreeEntry!]!
|
|
parent - NavigationTreeEntry
|
|
children - NavigationTreeEntryChildrenPayload!
|
|
Arguments
|
|
valid - Boolean!
|
|
status - CategoryStatus!
|
|
overwrittenValue - NavigationTreeEntry
|
|
referenceType - PageReferenceType!
|
|
Possible Types
| LandingTreeEntry Types |
|---|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"name": "xyz789",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"ancestors": [NavigationTreeEntry],
"parent": NavigationTreeEntry,
"children": NavigationTreeEntryChildrenPayload,
"valid": true,
"status": "INVALID",
"overwrittenValue": NavigationTreeEntry,
"referenceType": "NONE"
}
LandingTreeFilterInput
Description
INPUT
Fields
| Input Field | Description |
|---|---|
ids - [ID!]!
|
|
names - [String!]!
|
|
status - [TimeValidityStatus!]!
|
|
hasContent - Boolean
|
|
hidden - Boolean
|
Example
{
"ids": ["4"],
"names": ["xyz789"],
"status": ["ACTIVE"],
"hasContent": true,
"hidden": false
}
LandingTreeFindPayload
Description
TYPES
Fields
| Field Name | Description |
|---|---|
entries - [CuratedPage!]!
|
|
totalCount - Int!
|
Example
{"entries": [CuratedPage], "totalCount": 123}
LandingTreePagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging
|
|
sorting - LandingTreeSortInput
|
Example
{
"paging": Paging,
"sorting": LandingTreeSortInput
}
LandingTreeSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder
|
|
sortColumn - LandingTreeSortType
|
Example
{"sortOrder": "ASC", "sortColumn": "INFO"}
LandingTreeSortType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INFO"
LayerLink
Description
The representation of a layer link.
Example
{
"id": 4,
"version": {},
"openLinkInNewWindow": false,
"urlParameters": "xyz789",
"layerInfo": "abc123"
}
LayerLinkInput
Description
Additional information to describe a layer link.
Fields
| Input Field | Description |
|---|---|
layerInfo - String!
|
The information about the layer. |
Example
{"layerInfo": "xyz789"}
LegacyContentReference
Description
deprecated this is only a crutch and should be replaced with type for raster element when themeplanning api is finished
Fields
| Field Name | Description |
|---|---|
pageName - String!
|
|
pageType - PageReferenceType!
|
|
contentName - String
|
|
mcs - Mcs!
|
|
customerSegments - [CustomerSegment!]!
|
|
scenario - AbTestScenario
|
|
pageAncestors - [NavigationTreeEntry!]!
|
Example
{
"pageName": "xyz789",
"pageType": "NONE",
"contentName": "xyz789",
"mcs": Mcs,
"customerSegments": [CustomerSegment],
"scenario": AbTestScenario,
"pageAncestors": [NavigationTreeEntry]
}
Lemma
Description
A single lemma entry.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the lemma entry. |
version - Long!
|
The version of the lemmy entry. |
mcs - Mcs!
|
The MCS this lemma applies to. |
searchTerms - [String!]!
|
The search terms of the lemma entry. |
wordStem - String!
|
The stem of the lemma entry. |
isInherited - Boolean!
|
Flag that indiciates whether this lemma entry was inherited from a higher MCS. |
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"searchTerms": ["abc123"],
"wordStem": "xyz789",
"isInherited": true
}
LemmaCreatePayload
Description
Payload wrapper object for creating lemmata
Fields
| Field Name | Description |
|---|---|
entries - [Lemma!]!
|
The list of created lemmata |
Example
{"entries": [Lemma]}
LemmaDeletePayload
Description
Payload wrapper object for deleting lemmata
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Flag for success |
Example
{"successful": true}
LemmaFilter
Description
The filter information about lemma entries. These filters are cummulative (AND) (if they are not empty or null).
Fields
| Input Field | Description |
|---|---|
searchTerms - [String!]
|
A list of search terms to filter for. Results in all lemma entries with partial matches. Default: Empty. Default = [] |
wordStems - [String!]
|
The stems that are used to find corresponding lemma entries. Results in all lemma entries with partial matches. Default: Empty. Default = [] |
globalSearch - String
|
A string that should appear anywhere in the lemma entry. Searches the given input in all terms and stems, finds partial matches. |
Example
{
"searchTerms": ["xyz789"],
"wordStems": ["xyz789"],
"globalSearch": "abc123"
}
LemmaFindInput
Description
Paging and filter information for finding lemma entries.
Fields
| Input Field | Description |
|---|---|
paging - LemmaPagingInput!
|
Paging information. Default = {sortType: INFO, sortOrder: DESC, offset: 0, limit: 100} |
filter - LemmaFilter!
|
Filter information. Default = {searchTerms: [], wordStems: []} |
mcsInput - McsInput!
|
The mcs for the lemma entry/entries. |
Example
{
"paging": LemmaPagingInput,
"filter": LemmaFilter,
"mcsInput": McsInput
}
LemmaPagingInput
Description
Paging and sorting information.
Fields
| Input Field | Description |
|---|---|
sortType - LemmaSorting!
|
The sort type for sorting the returned lemma entries. Default: Info. Default = INFO |
sortOrder - SortOrder!
|
" The sort order for the returned lemma entries. Default: Descending. Default = DESC |
offset - Int!
|
Offset of results that should be skipped. Default: 0. Default = 0 |
limit - Int!
|
Limit of results per page. Default: 100. Default = 100 |
Example
{
"sortType": "SEARCH_TERM_LEXICOGRAPHICAL",
"sortOrder": "ASC",
"offset": 123,
"limit": 123
}
LemmaSorting
Description
An enum representation of the sort type possibilities of the returned lemma entries.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Sorts by inherited mcs, with entries of the current mcs always at the bottom. Sorting within the mcs entries is by name lexicographical ascending. |
Example
"SEARCH_TERM_LEXICOGRAPHICAL"
LemmaUpdatePayload
Description
Payload wrapper object for updating lemmata
Fields
| Field Name | Description |
|---|---|
entries - [Lemma!]!
|
The list of updated lemmata |
Example
{"entries": [Lemma]}
LinkAttributeType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
key - String!
|
|
displayName - String!
|
|
group - AttributeDefinitionGroup!
|
|
abTestable - Boolean!
|
|
customerSegmentsAllowed - Boolean!
|
|
exportable - Boolean!
|
|
linkable - Boolean!
|
indicate whether an attribute can be linked to other object. Linking attribute is used for category and page parameters. |
standard - Boolean!
|
true for standard ishop core attribute and false for shop specific ones |
mandatory - Boolean!
|
indicates whether the value must be present for this type. |
helpText - String
|
|
hasHelpText - Boolean!
|
|
mutationCommandType - String!
|
|
allowedValues - [AllowedValue!]!
|
|
allowedTypes - [LinkType!]!
|
When not empty, imposes restrictions on allowed link types in the related values. |
searchable - Boolean!
|
indicates whether the value for this attribute description could be indexed by the content search. |
valueType - AttributeValueType!
|
Example
{
"id": 4,
"version": {},
"key": "xyz789",
"displayName": "abc123",
"group": AttributeDefinitionGroup,
"abTestable": false,
"customerSegmentsAllowed": false,
"exportable": true,
"linkable": false,
"standard": false,
"mandatory": true,
"helpText": "xyz789",
"hasHelpText": false,
"mutationCommandType": "xyz789",
"allowedValues": [AllowedValue],
"allowedTypes": ["ArticleLink"],
"searchable": true,
"valueType": "Text"
}
LinkToCategoryTreeEntry
Fields
| Field Name | Description |
|---|---|
target - CategoryTreeEntry!
|
|
includeSubTree - Boolean!
|
Example
{"target": CategoryTreeEntry, "includeSubTree": true}
LinkToContentTreeEntry
Fields
| Field Name | Description |
|---|---|
target - ContentTreeEntry!
|
|
includeSubTree - Boolean!
|
Example
{"target": ContentTreeEntry, "includeSubTree": false}
LinkToLandingTreeEntry
Fields
| Field Name | Description |
|---|---|
target - LandingTreeEntry!
|
|
includeSubTree - Boolean!
|
Example
{"target": LandingTreeEntry, "includeSubTree": false}
LinkToMaintainTreeEntry
Fields
| Field Name | Description |
|---|---|
target - MaintainTreeEntry
|
|
includeSubTree - Boolean!
|
Example
{"target": MaintainTreeEntry, "includeSubTree": true}
LinkToProductPageTreeEntry
Fields
| Field Name | Description |
|---|---|
target - ProductPageEntry!
|
|
includeSubTree - Boolean!
|
Example
{"target": ProductPageEntry, "includeSubTree": false}
LinkToSearchTermGroupTreeEntry
Fields
| Field Name | Description |
|---|---|
target - SearchTermGroupEntry!
|
|
includeSubTree - Boolean!
|
Example
{"target": SearchTermGroupEntry, "includeSubTree": false}
LinkType
Description
An enum of the type of a link.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ArticleLink"
LinkedBrand
Fields
| Field Name | Description |
|---|---|
brand - BrandEntity!
|
|
linkData - AttributeLink
|
|
trackingInfo - String
|
Example
{
"brand": BrandEntity,
"linkData": ArticleLink,
"trackingInfo": "xyz789"
}
LinkedBrandListValue
Fields
| Field Name | Description |
|---|---|
linkedBrands - [LinkedBrand!]!
|
Example
{"linkedBrands": [LinkedBrand]}
Long
Description
A scalar representing Java's java.lang.Long
Example
{}
MainCategorySmartAssistantNode
Fields
| Field Name | Description |
|---|---|
name - String
|
Node Name |
isCompleted - Boolean!
|
is Completed |
score - Int!
|
Score, represents number of completed items |
type - SmartAssistantNodeType
|
Node Type |
category - BackofficeCategory!
|
Category use CategoryTreeEntry |
categoryTreeEntry - NavigationTreeEntry!
|
Example
{
"name": "abc123",
"isCompleted": true,
"score": 123,
"type": "DefaultArticleScoringForCategories",
"category": BackofficeCategory,
"categoryTreeEntry": NavigationTreeEntry
}
MaintainTreeEntry
Description
Defines the types that can be part of the maintained page tree.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
|
deleteDate - DateTime
|
The date when the entry will be deleted or null if it won't be deleted |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
ancestors - [NavigationTreeEntry!]!
|
|
parent - NavigationTreeEntry
|
|
children - NavigationTreeEntryChildrenPayload!
|
|
Arguments
|
|
valid - Boolean!
|
|
referenceType - PageReferenceType!
|
|
Possible Types
| MaintainTreeEntry Types |
|---|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"name": "xyz789",
"deleteDate": "2007-12-03T10:15:30Z",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"ancestors": [NavigationTreeEntry],
"parent": NavigationTreeEntry,
"children": NavigationTreeEntryChildrenPayload,
"valid": true,
"referenceType": "NONE"
}
MaintainedPageSmartAssistantNode
Fields
| Field Name | Description |
|---|---|
name - String
|
Node Name |
isCompleted - Boolean!
|
is Completed |
score - Int!
|
Score, represents number of completed items |
type - SmartAssistantNodeType
|
Node Type |
page - CuratedPage!
|
Node with Page |
Example
{
"name": "xyz789",
"isCompleted": false,
"score": 987,
"type": "DefaultArticleScoringForCategories",
"page": CuratedPage
}
MaintainedTreeFilterInput
Description
INPUT
Fields
| Input Field | Description |
|---|---|
ids - [ID!]!
|
|
names - [String!]!
|
|
hasContent - Boolean
|
|
hidden - Boolean
|
Example
{
"ids": ["4"],
"names": ["abc123"],
"hasContent": false,
"hidden": false
}
MaintainedTreeFindPayload
Description
TYPES
Fields
| Field Name | Description |
|---|---|
entries - [CuratedPage!]!
|
|
totalCount - Int!
|
Example
{"entries": [CuratedPage], "totalCount": 987}
MaintainedTreePagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging
|
|
sorting - MaintainedTreeSortInput
|
Example
{
"paging": Paging,
"sorting": MaintainedTreeSortInput
}
MaintainedTreeSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder
|
|
sortColumn - MaintainedTreeSortType
|
Example
{"sortOrder": "ASC", "sortColumn": "INFO"}
MaintainedTreeSortType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INFO"
MapType
Mark
Description
Enum representation detailing the different kinds of special articles that can be found in a search.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Used if the result article is not special. |
Example
"HERO_ARTICLE"
Mcs
Description
A full description of a Multichannelselector.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this MCS. |
version - Long!
|
The version of this MCS. |
mcsString - String!
|
An exact string representation of this MCS. |
displayString - String!
|
A readable full representation string of this mcs. |
deleted - Boolean!
|
A flag telling if this MCS is deleted. |
parent - Boolean!
|
A flag telling if this MCS is a parent MCS. |
parentMcs - Mcs
|
The parent MCS of this MCS. |
internalName - String!
|
The internal String representation of this MCS. |
ishopBackoffice - Boolean!
|
A flag telling if this is the backoffice-MCS. |
mcs - BackofficeMultiChannelSelector!
|
A split description of this MCS. |
Example
{
"id": "4",
"version": {},
"mcsString": "xyz789",
"displayString": "xyz789",
"deleted": false,
"parent": true,
"parentMcs": Mcs,
"internalName": "abc123",
"ishopBackoffice": false,
"mcs": BackofficeMultiChannelSelector
}
McsInput
Description
Information describing a MCS.
Fields
| Input Field | Description |
|---|---|
id - ID
|
An ID of a MCS. |
version - Long
|
A version of a MCS. |
mcs - MultiChannelSelector
|
A MCS displaystring. |
Example
{"id": 4, "version": {}, "mcs": MultiChannelSelector}
MenuEntry
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"Marketing"
MenuRightEntity
Description
User right for rights with navigation entry equivalent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Id of entity |
version - Long!
|
Version of entity |
name - String!
|
Name of right |
privileges - [Privilege!]!
|
List of allowed privileges for this right |
rightType - RightType!
|
Type of right (MENU or TRANSLATION) |
parentId - ID
|
Id of parent entity |
rightGroup - RightGroupEntity
|
Right group entity |
parent - Boolean!
|
Flag to indicate whether this right is shown on parent mcss or not |
childrenRights - [MenuRightEntity!]!
|
Children of user right |
Example
{
"id": 4,
"version": {},
"name": "xyz789",
"privileges": ["GRANTED"],
"rightType": "MENU",
"parentId": "4",
"rightGroup": RightGroupEntity,
"parent": true,
"childrenRights": [MenuRightEntity]
}
MessageMcs
Description
Message MultiChannelSelector including translation privileges
Fields
| Field Name | Description |
|---|---|
mcs - BoMcs!
|
MultiChannelSelector of translation |
privileges - [Privilege!]!
|
Translation privileges of the current user for this MultiChannelSelector |
Example
{"mcs": BoMcs, "privileges": ["GRANTED"]}
MessageMcsFilterInput
Description
Ids and names to filter message MultiChannelSelectors
Fields
| Input Field | Description |
|---|---|
mcsIds - [ID!]
|
List of MultiChannelSelector ids |
parentMcsIds - [ID!]
|
List of ids of parent MultiChannelSelectors |
mcsNames - [String!]
|
Name of MultiChannelSelector or the name of one of its descendants |
hierarchies - [MessageMcsHierarchy!]
|
Hierarchy levels |
privileges - [Privilege!]
|
The current user must have at least one of these translation privileges for the MultiChannelSelectors |
Example
{
"mcsIds": ["4"],
"parentMcsIds": ["4"],
"mcsNames": ["abc123"],
"hierarchies": ["ROOT"],
"privileges": ["GRANTED"]
}
MessageMcsFindPayload
Description
Message MultiChannelSelectors including total count
Fields
| Field Name | Description |
|---|---|
entries - [MessageMcs!]!
|
List of MultiChannelSelectors |
totalCount - Int!
|
Number of found MultiChannelSelectors |
Example
{"entries": [MessageMcs], "totalCount": 987}
MessageMcsHierarchy
Description
Filter for hierarchy level
Values
| Enum Value | Description |
|---|---|
|
|
Only root MultiChannelSelector |
|
|
Only top level MultiChannelSelectors |
|
|
Only complete MultiChannelSelectors |
Example
"ROOT"
MessageMcsPagingInput
Description
Sort order/type, limit and offset of results
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
Limit and offset Default: 100 (limit) and 0 (offset). Default = {limit: 100, offset: 0} |
sortOn - MessageMcsSortInput!
|
Sort order Default: ascending by hierarchy. Default = {sortOrder: ASC, sort: MCS_HIERARCHY} |
Example
{
"paging": Paging,
"sortOn": MessageMcsSortInput
}
MessageMcsSort
Description
Sorting types for message MultiChannelSelectors
Values
| Enum Value | Description |
|---|---|
|
|
Sorting by hierarchy (root first, then descendants) |
|
|
Sorting based on the mcs hierarchy and the current mcs: 1st criteria: ancestors of the current MultiChannelSelector and current MultiChannelSelect itself first 2nd criteria: more specific MultiChannelSelector first 3rd criteria: sorting by name |
|
|
Sorting by number of used dimensions |
|
|
Sorting by name |
Example
"HIERARCHY"
MessageMcsSortInput
Description
Sort order and type
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
Sort order Default: ascending. Default = ASC |
sort - MessageMcsSort!
|
Sort type Default: by hierarchy based on current MultiChannelSelector. Default = MCS_HIERARCHY |
Example
{"sortOrder": "ASC", "sort": "HIERARCHY"}
MessageType
Description
Location of translation (shop or backoffice)
Values
| Enum Value | Description |
|---|---|
|
|
Translation is used in shop |
|
|
Translation is used in backoffice |
Example
"SHOP"
MonetaryAmountComparisonConditionValue
Fields
| Field Name | Description |
|---|---|
value - Float!
|
|
operator - ComparisonOperator!
|
|
currency - String!
|
Example
{
"value": 123.45,
"operator": "GREATER_THAN_EQ",
"currency": "abc123"
}
MonetaryAmountConditionValue
Money
Description
A monetary amount like '19.99 €'
Fields
| Field Name | Description |
|---|---|
currencyCode - String!
|
The currency code compliant to ISO 4217 |
currencySymbol - String!
|
The currency symbol like '€' |
amount - BigDecimal!
|
The amount as BigDecimal |
intAmount - Int!
|
The amount as Int (e.g. 995 instead of 9.95) |
precision - Int
|
The precision of the amount |
stringValue - String!
|
The amount value as String |
Example
{
"currencyCode": "xyz789",
"currencySymbol": "abc123",
"amount": BigDecimal,
"intAmount": 123,
"precision": 123,
"stringValue": "xyz789"
}
MoveGridElementsInArea
MultiChannelSelector
Description
The string representation of the iSHOP MultiChannelSelector, for example: [brand=novosales channel=web country=de language=de currency=EUR store='']`
Example
MultiChannelSelector
MultiStringSelector
Fields
| Field Name | Description |
|---|---|
options - [AttributeOption!]!
|
Example
{"options": [AttributeOption]}
NamedBrandCategory
Fields
| Field Name | Description |
|---|---|
name - String
|
|
category - NavigationTreeEntry!
|
Example
{
"name": "xyz789",
"category": NavigationTreeEntry
}
NamedCategory
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
category - GraphQlCategory!
|
use CategoryTreeEntry |
categoryTreeEntry - CategoryTreeEntry!
|
Example
{
"name": "abc123",
"category": GraphQlCategory,
"categoryTreeEntry": CategoryTreeEntry
}
NamedCategoryListValue
Fields
| Field Name | Description |
|---|---|
namedCategories - [NamedCategory!]!
|
Example
{"namedCategories": [NamedCategory]}
NamedImage
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
image - ImageEntity!
|
Example
{
"name": "xyz789",
"image": ImageEntity
}
NamedImageListValue
Fields
| Field Name | Description |
|---|---|
namedImages - [NamedImage!]!
|
Example
{"namedImages": [NamedImage]}
NamedLinkListValue
Fields
| Field Name | Description |
|---|---|
namedLinks - [NamedLinkValue!]!
|
Example
{"namedLinks": [NamedLinkValue]}
NamedLinkValue
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
link - AttributeLink!
|
|
title - String
|
|
trackingInfo - String
|
Example
{
"name": "xyz789",
"link": ArticleLink,
"title": "xyz789",
"trackingInfo": "xyz789"
}
NextTimelineEvent
Description
Timestamp for next event outside of filter range direction forward (next event) the field is called 'start' for compatibility, but it could also be a end of any event
Fields
| Field Name | Description |
|---|---|
start - DateTime
|
Example
{"start": "2007-12-03T10:15:30Z"}
NonExistingCategory
Description
deprecated not used anymore
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique ID of this category |
version - Long!
|
A version of the category entity |
simpleId - String!
|
The simple ID of this category |
mcs - Mcs!
|
The MCS containing this category |
status - CategoryStatus
|
A flag describing if this category is online. |
valid - Boolean!
|
A flag describing if this category is valid |
Example
{
"id": "4",
"version": {},
"simpleId": "abc123",
"mcs": Mcs,
"status": "INVALID",
"valid": true
}
NonSegmentedValue
Fields
| Field Name | Description |
|---|---|
value - DynamicValue!
|
Example
{"value": StringValue}
Now
Fields
| Field Name | Description |
|---|---|
currentTime - DateTime!
|
Example
{"currentTime": "2007-12-03T10:15:30Z"}
Object
Description
An object scalar allows you to have a multi level data value without defining it in the graphql schema
It might be useful when you have opaque data coming from a backend system that you want to pass on but cant provide the actual graphql schema definition for. Use this with caution since is breaks one of the key benefits of graphql, which is that a schema describes the shape of the data that can be queried.
Example
Object
ObjectIdConditionValue
Fields
| Field Name | Description |
|---|---|
value - Long!
|
The id of the object |
Example
{"value": {}}
Order
Description
Sort orders
Values
| Enum Value | Description |
|---|---|
|
|
Ascending order |
|
|
Descending order |
Example
"ASC"
OsbAttribute
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
value - Object!
|
|
mcs - MultiChannelSelector!
|
Example
{
"name": "abc123",
"value": Object,
"mcs": MultiChannelSelector
}
OsbAttributeFilterInput
Fields
| Input Field | Description |
|---|---|
name - [String!]!
|
|
mcs - [McsInput!]!
|
Example
{
"name": ["xyz789"],
"mcs": [McsInput]
}
OsbAttributeFilterOperationUnion
Description
Only one of the operation should be set.
Fields
| Input Field | Description |
|---|---|
equal - OsbEqualOperation
|
|
exist - OsbExistOperation
|
|
regex - OsbRegexOperation
|
Example
{
"equal": OsbEqualOperation,
"exist": OsbExistOperation,
"regex": OsbRegexOperation
}
OsbCategory
Fields
| Field Name | Description |
|---|---|
simpleId - String!
|
|
fullyQualifiedId - String!
|
|
attributes - [OsbAttribute!]!
|
|
Arguments
|
|
ancestorCategories - [OsbCategory!]!
|
|
childCategories - [OsbCategory!]!
|
|
products - OsbProductOfCategoryPayload!
|
|
Arguments
|
|
Example
{
"simpleId": "abc123",
"fullyQualifiedId": "abc123",
"attributes": [OsbAttribute],
"ancestorCategories": [OsbCategory],
"childCategories": [OsbCategory],
"products": OsbProductOfCategoryPayload
}
OsbCategoryProductFilterInput
Fields
| Input Field | Description |
|---|---|
mcs - [McsInput!]!
|
Example
{"mcs": [McsInput]}
OsbEqualOperation
OsbExistOperation
Fields
| Input Field | Description |
|---|---|
negated - Boolean!
|
Example
{"negated": true}
OsbIShopObject
Types
| Union Types |
|---|
Example
OsbCategory
OsbIShopObjectInterface
Fields
| Field Name | Description |
|---|---|
simpleId - String!
|
|
fullyQualifiedId - String!
|
|
attributes - [OsbAttribute!]!
|
|
Arguments
|
|
Possible Types
| OsbIShopObjectInterface Types |
|---|
Example
{
"simpleId": "xyz789",
"fullyQualifiedId": "abc123",
"attributes": [OsbAttribute]
}
OsbItem
Fields
| Field Name | Description |
|---|---|
simpleId - String!
|
|
fullyQualifiedId - String!
|
|
attributes - [OsbAttribute!]!
|
|
Arguments
|
|
product - OsbProduct
|
|
Example
{
"simpleId": "abc123",
"fullyQualifiedId": "abc123",
"attributes": [OsbAttribute],
"product": OsbProduct
}
OsbProduct
Fields
| Field Name | Description |
|---|---|
simpleId - String!
|
|
fullyQualifiedId - String!
|
|
attributes - [OsbAttribute!]!
|
|
Arguments
|
|
items - [OsbItem!]!
|
|
Example
{
"simpleId": "xyz789",
"fullyQualifiedId": "xyz789",
"attributes": [OsbAttribute],
"items": [OsbItem]
}
OsbProductOfCategoryPayload
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
products - [OsbProduct!]!
|
Example
{"totalCount": 123, "products": [OsbProduct]}
OsbRegexOperation
OsbSearchResult
Fields
| Field Name | Description |
|---|---|
product - OsbProduct!
|
|
items - [OsbItem!]!
|
Example
{
"product": OsbProduct,
"items": [OsbItem]
}
OsbType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ITEM"
Page
Description
TYPES TODO ISBO-12643 Remove this type
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
name - String!
|
|
valid - Boolean!
|
|
referenceType - PageReferenceType!
|
Possible Types
| Page Types |
|---|
Example
{
"id": 4,
"version": {},
"name": "xyz789",
"valid": false,
"referenceType": "NONE"
}
PageFilterInput
PageLink
Description
The representation of a page link.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this link. |
version - Long!
|
The version of this link. |
openLinkInNewWindow - Boolean!
|
Should the link be opened in a new window? |
urlParameters - String
|
The URL parameters of this link. |
anchorLink - String
|
The Anchor link of this link |
page - Page!
|
The page entity. |
Example
{
"id": 4,
"version": {},
"openLinkInNewWindow": false,
"urlParameters": "xyz789",
"anchorLink": "abc123",
"page": Page
}
PageLinkInput
Description
Additional information to describe a page link.
Fields
| Input Field | Description |
|---|---|
pageId - ID!
|
The ID of the page. |
Example
{"pageId": 4}
PagePagingInput
Description
INPUT
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
|
sortInput - PageSortingInput!
|
Example
{
"paging": Paging,
"sortInput": PageSortingInput
}
PageParameter
Description
TYPES
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
page - Page!
|
TODO ISBO-12643 Replace this type |
mcs - Mcs!
|
|
inherited - Boolean!
|
|
overwrites - PageParameter
|
|
parameterType - AttributeDescriptionType!
|
|
attributeValue - DynamicAttributeValue!
|
|
linkTo - PageParameterLinkTargets!
|
|
description - String
|
|
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
pageType - PageReferenceType!
|
Example
{
"id": 4,
"version": {},
"page": Page,
"mcs": Mcs,
"inherited": true,
"overwrites": PageParameter,
"parameterType": AttributeDescriptionType,
"attributeValue": DynamicAttributeValue,
"linkTo": PageParameterLinkTargets,
"description": "abc123",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"pageType": "NONE"
}
PageParameterAttributeCopyPayload
Fields
| Field Name | Description |
|---|---|
entries - [PageParameter!]!
|
Example
{"entries": [PageParameter]}
PageParameterAttributeCreatePayload
Description
PAYLOADS
Fields
| Field Name | Description |
|---|---|
entries - [PageParameter!]!
|
Example
{"entries": [PageParameter]}
PageParameterAttributeDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": true}
PageParameterAttributeUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [PageParameter!]!
|
Example
{"entries": [PageParameter]}
PageParameterFilterInput
Description
QUERY INPUT
Fields
| Input Field | Description |
|---|---|
parameterIds - [ID!]
|
|
pageIds - [ID!]
|
|
showLinkedParameter - Boolean!
|
|
parameterTypeById - [ID!]
|
|
parameterTypeByKey - [String!]
|
|
searchValue - String
|
|
status - [TimeValidityStatus!]
|
|
campaignId - ID
|
When filter for campaign, filter for start or end will be ignored |
startDate - DateTime
|
|
endDate - DateTime
|
Example
{
"parameterIds": ["4"],
"pageIds": ["4"],
"showLinkedParameter": false,
"parameterTypeById": [4],
"parameterTypeByKey": ["xyz789"],
"searchValue": "xyz789",
"status": ["ACTIVE"],
"campaignId": 4,
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z"
}
PageParameterFindPayload
Description
PAYLOADS
Fields
| Field Name | Description |
|---|---|
entries - [PageParameter!]!
|
|
totalCount - Int
|
Example
{"entries": [PageParameter], "totalCount": 987}
PageParameterLinkTargets
Fields
| Field Name | Description |
|---|---|
linkToLandingTreeEntry - [LinkToLandingTreeEntry!]!
|
|
Arguments
|
|
linkToContentTreeEntry - [LinkToContentTreeEntry!]!
|
|
Arguments
|
|
linkToMaintainTreeEntry - [LinkToMaintainTreeEntry!]!
|
|
Arguments
|
|
linkToProductPageTreeEntry - [LinkToProductPageTreeEntry!]!
|
|
Arguments
|
|
linkToSearchTermGroupTreeEntry - [LinkToSearchTermGroupTreeEntry!]!
|
|
Arguments
|
|
overwriteExistingValue - Boolean!
|
|
Example
{
"linkToLandingTreeEntry": [LinkToLandingTreeEntry],
"linkToContentTreeEntry": [LinkToContentTreeEntry],
"linkToMaintainTreeEntry": [LinkToMaintainTreeEntry],
"linkToProductPageTreeEntry": [
LinkToProductPageTreeEntry
],
"linkToSearchTermGroupTreeEntry": [
LinkToSearchTermGroupTreeEntry
],
"overwriteExistingValue": false
}
PageReferenceType
Description
Enum for page reference type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NONE"
PageSearchPayload
PageSortType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NAME"
PageSortingInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder
|
|
sortType - PageSortType
|
Example
{"sortOrder": "ASC", "sortType": "NAME"}
Paging
Description
The paging information
Example
{"limit": 987, "offset": 987}
PagingByRow
ParameterFilterInput
Description
Defines the input to parameters attribute in CategoryTreeEntry
Fields
| Input Field | Description |
|---|---|
showLinkedParameter - Boolean!
|
|
parameterTypeById - [ID!]
|
|
parameterTypeByKey - [String!]
|
|
status - [TimeValidityStatus!]
|
|
showFallbacks - Boolean!
|
Example
{
"showLinkedParameter": true,
"parameterTypeById": [4],
"parameterTypeByKey": ["abc123"],
"status": ["ACTIVE"],
"showFallbacks": false
}
ParameterPagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging
|
|
sorting - ParameterSortInput
|
Example
{
"paging": Paging,
"sorting": ParameterSortInput
}
ParameterSortInput
Description
INPUT TYPES
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder
|
|
sortColumn - ParameterSortType
|
Example
{"sortOrder": "ASC", "sortColumn": "STATUS"}
ParameterSortType
Values
| Enum Value | Description |
|---|---|
|
|
Sort by the status of the parameters |
|
|
Sort by attribute |
|
|
Sort by start date |
|
|
Sort by end date |
|
|
Sorts by inherited mcs, with entries of the current mcs always at the bottom. Sorting within the mcs entries is not defined. |
|
|
Sort by creation date |
|
|
Sort by last updated date |
Example
"STATUS"
ParentInput
Description
A Filter to describe categories
Fields
| Input Field | Description |
|---|---|
parentIds - [String!]!
|
All parent categories IDs |
mcsInput - McsInput!
|
Mcs selected |
Example
{
"parentIds": ["xyz789"],
"mcsInput": McsInput
}
PercentBenefitEntity
Description
Representation of a percentage benefit
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the benefit. |
version - Long!
|
The version of the benefit. |
title - String
|
The maintained title of the benefit |
image - ImageEntity
|
The maintained image for the benefit |
benefitTarget - BenefitTarget!
|
Benefit target type |
discount - Float!
|
The discount percentage, range value from 0-100 |
priceType - PriceType!
|
The percent price type |
capAmount - Float
|
Cap amount value |
capCurrency - String
|
Currency type value |
Example
{
"id": "4",
"version": {},
"title": "xyz789",
"image": ImageEntity,
"benefitTarget": "ITEM",
"discount": 987.65,
"priceType": "CURRENT_PRICE",
"capAmount": 987.65,
"capCurrency": "abc123"
}
PercentOnCheapestItemBenefitEntity
Description
Representation of a cheapest item percentage benefit
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the benefit. |
version - Long!
|
The version of the benefit. |
title - String
|
The maintained title of the benefit |
image - ImageEntity
|
The maintained image for the benefit |
discount - Float!
|
The discount percentage applied on the cheapest item, range value from 0-100 |
priceType - PriceType!
|
The percent price type |
capAmount - Float
|
Cap amount value |
capCurrency - String
|
Currency type value |
Example
{
"id": "4",
"version": {},
"title": "xyz789",
"image": ImageEntity,
"discount": 123.45,
"priceType": "CURRENT_PRICE",
"capAmount": 123.45,
"capCurrency": "abc123"
}
PercentOnMostExpensiveItemBenefitEntity
Description
Representation of a most expensive item percentage benefit
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the benefit. |
version - Long!
|
The version of the benefit. |
title - String
|
The maintained title of the benefit |
image - ImageEntity
|
The maintained image for the benefit |
discount - Float!
|
The discount percentage applied on the most expensive item, range value from 0-100 |
priceType - PriceType!
|
The percent price type |
capAmount - Float
|
Cap amount value |
capCurrency - String
|
Currency type value |
Example
{
"id": 4,
"version": {},
"title": "abc123",
"image": ImageEntity,
"discount": 987.65,
"priceType": "CURRENT_PRICE",
"capAmount": 987.65,
"capCurrency": "abc123"
}
PersonalVoucherImportModel
PimCategory
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
|
deleteDate - DateTime
|
The date when the entry will be deleted or null if it won't be deleted |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
ancestors - [NavigationTreeEntry!]!
|
|
parent - NavigationTreeEntry
|
|
children - NavigationTreeEntryChildrenPayload!
|
|
Arguments
|
|
valid - Boolean!
|
|
status - CategoryStatus!
|
|
url - String
|
|
previewUrl - String!
|
|
Arguments
|
|
invalidReason - String
|
|
originalTreeType - TreeType
|
|
paths - [String!]!
|
|
referenceType - PageReferenceType!
|
|
localizedName - String!
|
|
categoryParameters - CategoryParameterFindPayload!
|
|
Arguments
|
|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"name": "xyz789",
"deleteDate": "2007-12-03T10:15:30Z",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"ancestors": [NavigationTreeEntry],
"parent": NavigationTreeEntry,
"children": NavigationTreeEntryChildrenPayload,
"valid": true,
"status": "INVALID",
"url": "xyz789",
"previewUrl": "xyz789",
"invalidReason": "xyz789",
"originalTreeType": "ArchiveTree",
"paths": ["xyz789"],
"referenceType": "NONE",
"localizedName": "abc123",
"categoryParameters": CategoryParameterFindPayload
}
PreviewCategory
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
ancestors - [PreviewCategory!]!
|
|
parent - PreviewCategory
|
|
children - PreviewCategoryChildrenPayload!
|
|
Arguments
|
|
previewEntries - PreviewCategoryEntriesPayload!
|
|
Arguments
|
|
Example
{
"id": "4",
"name": "abc123",
"ancestors": [PreviewCategory],
"parent": PreviewCategory,
"children": PreviewCategoryChildrenPayload,
"previewEntries": PreviewCategoryEntriesPayload
}
PreviewCategoryChildrenPayload
Fields
| Field Name | Description |
|---|---|
entries - [PreviewCategory!]!
|
|
totalCount - Int!
|
Example
{"entries": [PreviewCategory], "totalCount": 987}
PreviewCategoryEntriesPayload
Fields
| Field Name | Description |
|---|---|
entries - [PreviewEntry!]!
|
|
totalCount - Int!
|
Example
{"entries": [PreviewEntry], "totalCount": 123}
PreviewCodesFilterInput
PreviewCodesFindPayload
Fields
| Field Name | Description |
|---|---|
entries - [String!]!
|
The list of voucher groups after applying paging, sorting and filtering. |
Example
{"entries": ["xyz789"]}
PreviewCodesPagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
Paging information.{Default return 100 entries from start}. Default = {limit: 100, offset: 0} |
Example
{"paging": Paging}
PreviewEntry
Fields
| Field Name | Description |
|---|---|
product - Product!
|
|
items - [Item_2]!
|
|
searchInfos - SearchInfo!
|
Example
{
"product": Product,
"items": [Item_2],
"searchInfos": SearchInfo
}
PreviewEntryTransformer
Fields
| Input Field | Description |
|---|---|
transformToHero - TransformToHero
|
|
transformToAntiHero - TransformToAntiHero
|
Example
{
"transformToHero": TransformToHero,
"transformToAntiHero": TransformToAntiHero
}
PreviewParameterInput
Example
{
"preview": "2007-12-03T10:15:30Z",
"customerSegment": "xyz789",
"scenarioIds": ["abc123"],
"previewKey": "abc123",
"rasterElementId": "abc123",
"showAllRasterElements": true,
"keepPreview": true,
"stopPreview": false
}
PreviousTimelineEvent
Description
Timestamp for next event outside of filter range direction backward (previous event) the field is called 'end' for compatibility, but it could also be a start of any event
Fields
| Field Name | Description |
|---|---|
end - DateTime
|
Example
{"end": "2007-12-03T10:15:30Z"}
PriceType
Description
Enum for promotion price types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CURRENT_PRICE"
Privilege
Description
Permitted privileges of a user right
Values
| Enum Value | Description |
|---|---|
|
|
Right is granted (e.g. for special rights) |
|
|
Read permission |
|
|
Write permission |
|
|
Delete permission |
|
|
Permission to import |
|
|
Permission to export |
Example
"GRANTED"
Product
Description
Representation of a shop product.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The simple ID of this product. |
fullyQualifiedId - ID!
|
The full ID of this product. |
valid - Boolean!
|
The validity state of this product. |
items - [Item_2!]!
|
The items/variations of this product. |
url - String
|
The url to this product. |
imageUrl - String
|
The url to an image of this product. |
name - String
|
The name of this product. |
brand - String
|
The brand of this product. |
Example
{
"id": 4,
"fullyQualifiedId": 4,
"valid": true,
"items": [Item_2],
"url": "abc123",
"imageUrl": "abc123",
"name": "abc123",
"brand": "abc123"
}
ProductList
Description
Represents a list of articles.
Fields
| Field Name | Description |
|---|---|
articles - [Article!]!
|
A list of articles. |
Example
{"articles": [Article]}
ProductPage
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
valid - Boolean!
|
|
name - String!
|
|
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
product - Product
|
|
productId - ID!
|
|
referenceType - PageReferenceType!
|
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"valid": true,
"name": "xyz789",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"product": Product,
"productId": 4,
"referenceType": "NONE"
}
ProductPageCreatePayload
Description
TYPES
Fields
| Field Name | Description |
|---|---|
entries - [ProductPage!]!
|
Example
{"entries": [ProductPage]}
ProductPageDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": true}
ProductPageEntry
Description
Defines the types that can be part of the product page tree.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
|
deleteDate - DateTime
|
The date when the entry will be deleted or null if it won't be deleted |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
ancestors - [NavigationTreeEntry!]!
|
|
parent - NavigationTreeEntry
|
|
children - NavigationTreeEntryChildrenPayload!
|
|
Arguments
|
|
valid - Boolean!
|
|
referenceType - PageReferenceType!
|
|
Possible Types
| ProductPageEntry Types |
|---|
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"name": "xyz789",
"deleteDate": "2007-12-03T10:15:30Z",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"ancestors": [NavigationTreeEntry],
"parent": NavigationTreeEntry,
"children": NavigationTreeEntryChildrenPayload,
"valid": true,
"referenceType": "NONE"
}
ProductPageFilterInput
ProductPageFindPayload
Description
TYPES
Fields
| Field Name | Description |
|---|---|
entries - [ProductPage!]!
|
|
totalCount - Int!
|
Example
{"entries": [ProductPage], "totalCount": 123}
ProductPagePagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging
|
|
sorting - ProductPageSortInput
|
Example
{
"paging": Paging,
"sorting": ProductPageSortInput
}
ProductPageSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder
|
|
sortColumn - ProductPageSortType
|
Example
{"sortOrder": "ASC", "sortColumn": "NAME"}
ProductPageSortType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NAME"
PromotionActiveStatus
Description
Enum representation the active status of promotions.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTIVE"
PromotionEntity
Description
Representation of a single Promotion. This is only a start and should be extended with values you need.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the promotion. |
version - Long!
|
The version of the promotion. |
name - String!
|
The name of the promotion. |
mcs - Mcs!
|
The MCS of the promotion. |
description - String
|
An optional textual description of the promotion. |
status - TimeValidityStatus!
|
Calculated time status for promotion. |
type - PromotionType!
|
The type of this promotion. |
brokenInheritanceFrom - Long
|
Reference to original row, which was broken from |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
Promotion audit createdAt, updatedAt, createdBy, and updatedBy. |
timeValidity - TimeValidity!
|
startDate, endDate & Campaign life-cycle values |
activeStatus - PromotionActiveStatus!
|
The active status of the promotion |
activeForMCS - [Mcs!]!
|
Promotion active Mcs list |
conditions - ComplexCondition!
|
Promotions conditions |
benefits - [BenefitEntity!]!
|
Promotions benefits |
benefitsSummaries - [String!]
|
List of benefits summaries |
metaData - String
|
Meta data for promotion |
Example
{
"id": "4",
"version": {},
"name": "abc123",
"mcs": Mcs,
"description": "xyz789",
"status": "ACTIVE",
"type": "IMPORTED",
"brokenInheritanceFrom": {},
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"timeValidity": Campaign,
"activeStatus": "ACTIVE",
"activeForMCS": [Mcs],
"conditions": ComplexCondition,
"benefits": [BenefitEntity],
"benefitsSummaries": ["abc123"],
"metaData": "xyz789"
}
PromotionFindPayload
Description
A list of promotions
Fields
| Field Name | Description |
|---|---|
entries - [PromotionEntity!]!
|
The list of promotions after applying paging information. |
totalCount - Int!
|
The complete count of promotions |
Example
{"entries": [PromotionEntity], "totalCount": 987}
PromotionSortColumn
Description
Representation in which will the result be sorted
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"INFO"
PromotionSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
list order value (default order is DESC). Default = DESC |
sortColumn - PromotionSortColumn!
|
Column names which are allowed to sort with. Default = INFO |
Example
{"sortOrder": "ASC", "sortColumn": "INFO"}
PromotionStatusFilter
Description
Enum representation the status filter of promotions.
Values
| Enum Value | Description |
|---|---|
|
|
All promotions which are active in the current mcs now |
|
|
All promotions which are not active in the current mcs now and not scheduled and not expired |
|
|
All promotions which are scheduled and active + scheduled and inactive |
|
|
All expired promotions in the current mcs now |
|
|
All valid promotions in the current datetime |
Example
"ACTIVE"
PromotionType
Description
Enum representation of the types of promotions.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"IMPORTED"
PromotionsCreatePayload
Fields
| Field Name | Description |
|---|---|
entries - [PromotionEntity!]!
|
List of created promotions |
Example
{"entries": [PromotionEntity]}
PromotionsDeletePayload
Description
Payload wrapper object for deleting promotion
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Flag for success. |
Example
{"successful": true}
PromotionsFilterInput
Fields
| Input Field | Description |
|---|---|
searchTerm - String
|
String keyword to search with |
types - [PromotionType!]
|
filtering the promotions according given type |
promotionsStatus - [PromotionStatusFilter!]
|
filtering the promotions according given status |
promotionsIds - [ID!]
|
selected promotion ID |
currentUserOnly - Boolean!
|
A flag to filter by the current logged in user. Default = false |
startDate - DateTime
|
filtering the promotions according to start date |
endDate - DateTime
|
filtering the promotions according to end date |
Example
{
"searchTerm": "abc123",
"types": ["IMPORTED"],
"promotionsStatus": ["ACTIVE"],
"promotionsIds": ["4"],
"currentUserOnly": true,
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z"
}
PromotionsPagingInput
Fields
| Input Field | Description |
|---|---|
pagingInput - Paging!
|
Paging information.{Default return 100 entries from start}. Default = {limit: 100, offset: 0} |
sortInput - PromotionSortInput!
|
Sorting information.{Default Descending on Id field}. Default = {sortOrder: DESC, sortColumn: INFO} |
Example
{
"pagingInput": Paging,
"sortInput": PromotionSortInput
}
PromotionsUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [PromotionEntity!]!
|
List of created promotions |
Example
{"entries": [PromotionEntity]}
PublishStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PUBLISHED"
QueryLemmaPayload
QueryUserInformationPayload
Description
Query response for user information
Fields
| Field Name | Description |
|---|---|
information - UserInformation!
|
Example
{"information": UserInformation}
QueryUserRightsPayload
Description
Query response for user rights
Fields
| Field Name | Description |
|---|---|
allowedMenuEntries - [MenuEntry!]!
|
All menu entries the current user is allowed to see |
allowedMcss - [Mcs!]!
|
All MCS the current user is allowed to see |
allowedMcsUserRights - [RightEntity!]!
|
All user rights on selected MCS |
Example
{
"allowedMenuEntries": ["Marketing"],
"allowedMcss": [Mcs],
"allowedMcsUserRights": [RightEntity]
}
RangeFilterConditionValue
RangePriceFilterConditionValue
RasterPage
ReactivateVoucherCodeCommonVoucher
ReactivateVoucherCodePersonalVoucher
ReferenceAttributeType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
key - String!
|
|
displayName - String!
|
|
group - AttributeDefinitionGroup!
|
|
abTestable - Boolean!
|
|
customerSegmentsAllowed - Boolean!
|
|
exportable - Boolean!
|
|
linkable - Boolean!
|
indicate whether an attribute can be linked to other object. Linking attribute is used for category and page parameters. |
standard - Boolean!
|
true for standard ishop core attribute and false for shop specific ones |
mandatory - Boolean!
|
indicates whether the value must be present for this type. |
helpText - String
|
|
hasHelpText - Boolean!
|
|
mutationCommandType - String!
|
|
allowedValues - [AllowedValue!]!
|
|
referencedAttributeType - AttributeDescriptionType!
|
|
searchable - Boolean!
|
indicates whether the value for this attribute description could be indexed by the content search. |
valueType - AttributeValueType!
|
Example
{
"id": "4",
"version": {},
"key": "abc123",
"displayName": "abc123",
"group": AttributeDefinitionGroup,
"abTestable": true,
"customerSegmentsAllowed": false,
"exportable": true,
"linkable": false,
"standard": true,
"mandatory": true,
"helpText": "xyz789",
"hasHelpText": true,
"mutationCommandType": "xyz789",
"allowedValues": [AllowedValue],
"referencedAttributeType": AttributeDescriptionType,
"searchable": false,
"valueType": "Text"
}
Relevance
Description
Information about the relevance of the containing search result article.
Fields
| Field Name | Description |
|---|---|
total - Float
|
The total relevance of this result article. |
inBandwidth - Boolean
|
A Flag telling if the article is inside the minimum requirements for showing it. |
details - [RelevanceDetail]
|
A List of details on how the total relevance was constructed. |
Example
{
"total": 987.65,
"inBandwidth": true,
"details": [RelevanceDetail]
}
RelevanceDetail
Description
A single detail in a relevance. The total relevance is the sum of all details.
Fields
| Field Name | Description |
|---|---|
value - Float
|
The relevance value of this detail. |
foundWord - String
|
The word matching the search term. |
foundLocation - String
|
A description of the location of the word matching the search term. |
transformations - [Transformation]
|
A List of transformations that were done before search term and found word matched. |
Example
{
"value": 123.45,
"foundWord": "abc123",
"foundLocation": "abc123",
"transformations": [Transformation]
}
RelevanceMetric
RemoveAbTestScenarioInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveAbTestValue
Description
Removes a value if a value exists for this scenario. Otherwise the command is ignored. When the value is the last value a parameter has, then calling this mutaiton would result an error. Deleting the last segmented value should be done by sending a delete mutation not an updateo one.
Fields
| Input Field | Description |
|---|---|
scenarioId - ID!
|
Example
{"scenarioId": 4}
RemoveArticleIgnoreList
Description
Input parameters to remove an article from an ignore list
Fields
| Input Field | Description |
|---|---|
value - Article_ID!
|
Article number that will be removed |
Example
{"value": Article_ID}
RemoveArticleListScoreCard
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveArticlesIgnoreList
Description
Ignored Articles list input that will be removed
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveAssetValue
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveBenefit
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Benefit ID |
Example
{"id": "4"}
RemoveBenefitImage
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Image ID |
Example
{"id": 4}
RemoveBlocklistedBrand
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
RemoveBrandImage
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The image ID |
Example
{"id": 4}
RemoveBrandLink
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveCampaign
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveCategoriesIgnoreList
Description
Ignored Categories list input that will be removed
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveCategoryRelation
Description
A category relation to remove.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the category to add. |
Example
{"id": "4"}
RemoveCondition
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Condition ID |
Example
{"id": 4}
RemoveContainer
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Example
{"id": EntityId}
RemoveCustomerSegment
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveCustomerSegmentedValue
Description
Removes a value if a value exists for this customer segment. Otherwise the command is ignored. When the value is the last value a parameter has, then calling this mutaiton would result an error. Deleting the last segmented value should be done by sending a delete mutation not an updateo one.
Fields
| Input Field | Description |
|---|---|
customerSegmentId - ID!
|
Example
{"customerSegmentId": 4}
RemoveFilterCategoryBlocklistedCategory
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
RemoveFilterCategorySource
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveGridContainerAttribute
Fields
| Input Field | Description |
|---|---|
attributeId - ID!
|
Id of attribute id to be removed |
Example
{"attributeId": "4"}
RemoveGridElement
RemoveHotSpotRelation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the Hotspot |
Example
{"id": 4}
RemoveIgnoredCategory
Description
Input parameters to remove a category from a list of ignored categories
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
RemoveLinkToCategoryTreeEntry
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveLinkToContentTreeEntry
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveLinkToLandingTreeEntry
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
RemoveLinkToMaintainTreeEntry
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveLinkToProductPageTreeEntry
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveLinkToSearchTermGroupTreeEntry
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveLinkValue
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveLinkedBrandRelation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of the brand |
Example
{"id": "4"}
RemoveMcs
Description
Operation to remove MultiChannelSelector from user/role relation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Id of MultiChannelSelector entity |
Example
{"id": 4}
RemoveNamedBrandCategorySources
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveNamedCategoryRelation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
RemoveNamedImageRelation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
RemoveNamedLinkRelation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemovePrivilege
Description
Operation to remove privilege from role/right relation
Fields
| Input Field | Description |
|---|---|
value - Privilege!
|
Privilege to remove |
Example
{"value": "GRANTED"}
RemoveRange
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveRelation
Values
| Enum Value | Description |
|---|---|
|
|
Example
"REMOVE"
RemoveReplacement
Description
Input parameters to remove a specific replacement from a replacement list
Fields
| Input Field | Description |
|---|---|
fromValue - String!
|
The identification key of the map entry that will be removed |
Example
{"fromValue": "abc123"}
RemoveReplacementList
Description
Replacement list input that will be removed
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RemoveRoleRight
Description
Operation to remove role/right relation
Fields
| Input Field | Description |
|---|---|
ids - [EntityId!]!
|
Id of role/right relation to remove |
Example
{"ids": [EntityId]}
RemoveSearchIndexAttribute
Description
Removes an existing search index attribute that is identified by the indexable attribute name.
Fields
| Input Field | Description |
|---|---|
indexableAttributeName - String!
|
The indexable attribute to remove. |
Example
{"indexableAttributeName": "xyz789"}
RemoveTabValue
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
RemoveTabValueByIndex
Fields
| Input Field | Description |
|---|---|
index - Int!
|
Example
{"index": 987}
RemoveTagCloudRelation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
RemoveTimeValidity
Fields
| Input Field | Description |
|---|---|
removeCampaign - RemoveCampaign!
|
Example
{"removeCampaign": RemoveCampaign}
RemoveUserRole
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Id of userRole |
Example
{"id": "4"}
ReplacementListCreatePayload
Description
Payload wrapper object for creating replacement list
Fields
| Field Name | Description |
|---|---|
entries - [DataExportReplacementList!]!
|
List of created replacement list |
Example
{"entries": [DataExportReplacementList]}
ReplacementListDeletePayload
Description
Payload wrapper object for deleting replacement list
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Flag for success. |
Example
{"successful": false}
ReplacementListFilterInput
Fields
| Input Field | Description |
|---|---|
searchTerm - String
|
String keyword to search within replacement list name |
Example
{"searchTerm": "abc123"}
ReplacementListFindPayload
Description
A list of replacement list records
Fields
| Field Name | Description |
|---|---|
entries - [DataExportReplacementList!]!
|
The list of replacement lists |
totalCount - Int!
|
The complete count of replacement list records |
Example
{
"entries": [DataExportReplacementList],
"totalCount": 123
}
ReplacementListPagingInput
Fields
| Input Field | Description |
|---|---|
pagingInput - Paging!
|
Paging information. Default = {limit: 100, offset: 0} |
sortInput - ReplacementListSortInput!
|
Sorting information. {Default asc by name}. Default = {sortOrder: ASC, sortColumn: NAME} |
Example
{
"pagingInput": Paging,
"sortInput": ReplacementListSortInput
}
ReplacementListSortColumn
Description
Representation in which will the result be sorted
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NAME"
ReplacementListSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
list order value (default order is ASC). Default = ASC |
sortColumn - ReplacementListSortColumn!
|
Column names which are allowed to sort with. Default = NAME |
Example
{"sortOrder": "ASC", "sortColumn": "NAME"}
ReplacementListUpdatePayload
Description
Payload wrapper object for updating replacement list
Fields
| Field Name | Description |
|---|---|
entries - [DataExportReplacementList!]!
|
Updated replacement list |
Example
{"entries": [DataExportReplacementList]}
ReportPaging
ReportSorting
Description
Sorting information.
Fields
| Input Field | Description |
|---|---|
sortOption - SortOption!
|
The column by which the Search Logs should be sorted. Default: Search count. Default = SEARCH_COUNT |
sortType - SortType!
|
The sort direction. Default: Descending. Default = DESC |
Example
{"sortOption": "SEARCH_TERM", "sortType": "ASC"}
RightEntity
Description
Abstract user right
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Id of entity |
version - Long!
|
Version of entity |
name - String!
|
Name of right |
privileges - [Privilege!]!
|
List of permitted privileges for this right (empty for a group of rights) |
rightType - RightType!
|
Type of right |
parentId - ID
|
Id of parent entity |
rightGroup - RightGroupEntity
|
Right group entity |
parent - Boolean!
|
Flag to indicate whether this right is shown on parent mcss or not |
Possible Types
| RightEntity Types |
|---|
Example
{
"id": 4,
"version": {},
"name": "abc123",
"privileges": ["GRANTED"],
"rightType": "MENU",
"parentId": 4,
"rightGroup": RightGroupEntity,
"parent": true
}
RightFilterInput
Description
Ids and types to filter user rights
Fields
| Input Field | Description |
|---|---|
rightIds - [ID!]
|
List of right ids |
rightNames - [String!]
|
List of right names |
privileges - [Privilege!]
|
List of allowed privileges for this right |
rightTypes - [RightType!]
|
Types of right Default: MENU and GROUP |
Example
{
"rightIds": [4],
"rightNames": ["xyz789"],
"privileges": ["GRANTED"],
"rightTypes": ["MENU"]
}
RightFindPayload
Description
User rights including total count
Fields
| Field Name | Description |
|---|---|
entries - [RightEntity!]!
|
List of rights |
totalCount - Int!
|
Number of found rights |
Example
{"entries": [RightEntity], "totalCount": 123}
RightGroupEntity
RightPagingInput
Description
Sort order/type, limit and offset of results
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
Limit and offset Default: 100 (limit) and 0 (offset). Default = {limit: 100, offset: 0} |
sortOn - RightSortInput!
|
Sort order Default: ascending by hierarchy. Default = {sortOrder: ASC, sortType: HIERARCHY} |
Example
{
"paging": Paging,
"sortOn": RightSortInput
}
RightSortInput
Description
Sort order and type
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
Sort order Default: ascending. Default = ASC |
sortType - RightSortTypeInput!
|
Sort type Default: by hierarchy. Default = HIERARCHY |
Example
{"sortOrder": "ASC", "sortType": "HIERARCHY"}
RightSortTypeInput
Description
Sorting types for user rights
Values
| Enum Value | Description |
|---|---|
|
|
Sorting by right type (first: from MENU, GROUP, TRANSLATION to SPECIAL, second: by order of corresponding MenuEntry (first Marketing, last help)) |
|
|
Sorting by right name |
Example
"HIERARCHY"
RightType
Description
User right types
Values
| Enum Value | Description |
|---|---|
|
|
Type for rights with navigation entry equivalent |
|
|
Type for rights for parameter groups |
|
|
Type for right for special permissions |
Example
"MENU"
RoleCreatePayload
Description
Result of creation of role with user rights
Fields
| Field Name | Description |
|---|---|
entries - [RoleEntity!]!
|
List of created roles |
Example
{"entries": [RoleEntity]}
RoleDeletePayload
Description
Result of deletion of roles
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Always true |
Example
{"successful": false}
RoleEntity
Description
Role with user rights
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Id of entity |
version - Long!
|
Version of entity |
name - String!
|
Name of role |
roleRights - [RoleRightEntity!]!
|
User right of this role |
numberOfUsers - Int!
|
Number of users using these roles (only roles that are not used can be deleted) |
hasSpecialRightsOnly - Boolean!
|
Role has special rights only |
description - String
|
Description |
isAdmin - Boolean!
|
Role is Admin Role |
Example
{
"id": 4,
"version": {},
"name": "xyz789",
"roleRights": [RoleRightEntity],
"numberOfUsers": 123,
"hasSpecialRightsOnly": true,
"description": "xyz789",
"isAdmin": true
}
RoleFilterInput
Description
Ids, names, right ids and right types to filter roles with user rights
Fields
| Input Field | Description |
|---|---|
searchTerm - String
|
search term Parts of role name and role description |
Example
{"searchTerm": "xyz789"}
RoleFindPayload
Description
Roles with user rights including total count
Fields
| Field Name | Description |
|---|---|
entries - [RoleEntity!]!
|
List of roles |
totalCount - Int!
|
Number of found roles |
Example
{"entries": [RoleEntity], "totalCount": 987}
RoleMcs
Description
MultiChannelSelector for user/role relation
Fields
| Field Name | Description |
|---|---|
mcs - BoMcs!
|
MultiChannelSelector for role |
privileges - [Privilege!]!
|
Roles privileges of the current user for this MultiChannelSelector |
Example
{"mcs": BoMcs, "privileges": ["GRANTED"]}
RoleMcsFilterInput
Description
Ids, names and type to filter MultiChannelSelectors
Fields
| Input Field | Description |
|---|---|
mcsIds - [ID!]
|
List of MultiChannelSelector ids |
mcsNames - [String!]
|
Parts of MultiChannelSelector name |
parentMcsIds - [ID!]
|
List of ids of parent MultiChannelSelectors |
hierarchies - [RoleMcsHierarchy!]
|
Hierarchy levels |
privileges - [Privilege!]
|
List of allowed privileges for this MultiChannelSelector |
rightType - RightType
|
Type of right to which a list of MultiChannelSelectors is assigned (MENU and GROUP are equivalent here) Default: MENU |
Example
{
"mcsIds": [4],
"mcsNames": ["xyz789"],
"parentMcsIds": [4],
"hierarchies": ["ROOT"],
"privileges": ["GRANTED"],
"rightType": "MENU"
}
RoleMcsFindPayload
Description
MultiChannelSelectors for user/role relation including total count
Fields
| Field Name | Description |
|---|---|
entries - [RoleMcs!]!
|
List of MultiChannelSelectors |
totalCount - Int!
|
Number of found MultiChannelSelectors |
Example
{"entries": [RoleMcs], "totalCount": 987}
RoleMcsHierarchy
Description
Filter for hierarchy level
Values
| Enum Value | Description |
|---|---|
|
|
Only root MultiChannelSelector |
|
|
Only top level MultiChannelSelectors |
|
|
Only complete MultiChannelSelectors |
Example
"ROOT"
RoleMcsPagingInput
Description
Sort order/type, limit and offset of results
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
Limit and offset Default: 100 (limit) and 0 (offset). Default = {limit: 100, offset: 0} |
sortOn - RoleMcsSortInput!
|
Sort order Default: ascending by hierarchy. Default = {sortOrder: ASC, sortType: HIERARCHY} |
Example
{
"paging": Paging,
"sortOn": RoleMcsSortInput
}
RoleMcsSortInput
Description
Sort order and type
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
Sort order Default: ascending. Default = ASC |
sortType - RoleMcsSortTypeInput!
|
Sort type Default: by hierarchy. Default = HIERARCHY |
Example
{"sortOrder": "ASC", "sortType": "HIERARCHY"}
RoleMcsSortTypeInput
Description
Sorting types for MultiChannelSelectors
Values
| Enum Value | Description |
|---|---|
|
|
Sorting by hierarchy (root first, then descendants) |
|
|
Sorting based on the hierarchy and the current MultiChannelSelector: 1st criteria: ancestors of the current MultiChannelSelector and current MultiChannelSelect itself first 2nd criteria: more specific MultiChannelSelector first 3rd criteria: sorting by name |
|
|
Sorting by number of used dimensions |
|
|
Sorting by name |
Example
"HIERARCHY"
RolePagingInput
Description
Sort order/type, limit and offset of results
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
Limit and offset Default: 100 (limit) and 0 (offset). Default = {limit: 100, offset: 0} |
sortInput - RoleSortInput!
|
Sort order Default: ascending by name. Default = {sortOrder: ASC, sortColumn: NAME} |
Example
{
"paging": Paging,
"sortInput": RoleSortInput
}
RoleRightEntity
Description
User right of a role
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Id of entity |
version - Long!
|
Version of entity |
right - RightEntity!
|
User right |
privileges - [Privilege!]!
|
Assigned privileges of user right in this role |
Example
{
"id": "4",
"version": {},
"right": RightEntity,
"privileges": ["GRANTED"]
}
RoleSortColumn
Description
Sorting types for roles with user rights
Values
| Enum Value | Description |
|---|---|
|
|
Sorting by role name |
Example
"NAME"
RoleSortInput
Description
Sort order and type
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
Sort order Default: ascending. Default = ASC |
sortColumn - RoleSortColumn!
|
Sort type Default: by name. Default = NAME |
Example
{"sortOrder": "ASC", "sortColumn": "NAME"}
RoleUpdatePayload
Description
Result of update of roles
Fields
| Field Name | Description |
|---|---|
entries - [RoleEntity!]!
|
List of updated roles |
Example
{"entries": [RoleEntity]}
SEOTermLink
Description
The representation of a SEO term link.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this link. |
version - Long!
|
The version of this link. |
openLinkInNewWindow - Boolean!
|
Should the link be opened in a new window? |
urlParameters - String
|
The URL parameters of this link. |
anchorLink - String
|
The Anchor link of this link |
seoTerm - SeoTerm!
|
The SEO term entity. |
Example
{
"id": 4,
"version": {},
"openLinkInNewWindow": false,
"urlParameters": "abc123",
"anchorLink": "xyz789",
"seoTerm": SeoTerm
}
SEOTermLinkInput
Description
Additional information to describe a SEO term link.
Fields
| Input Field | Description |
|---|---|
seoTermId - ID!
|
The ID of the SEO Term. |
Example
{"seoTermId": "4"}
ScenarioAttributeInput
Description
Representation of a new search index attribute.
Fields
| Input Field | Description |
|---|---|
mcsInput - McsInput!
|
The mcs for the scenario attribute |
scenarioId - Long!
|
The ID of a search scenario. |
attribute - String!
|
The name of the attribute to index. |
level - AttributeLevel!
|
The level at which the attribute exists. Is this attribute from a product or an item? |
weight - Float!
|
The weight with which to adjust the relevance of results found through this attribute. |
Example
{
"mcsInput": McsInput,
"scenarioId": {},
"attribute": "abc123",
"level": "Product",
"weight": 987.65
}
ScenarioAttributePaging
ScenarioAttributeSortColumn
Description
Enum representation of the columns of a search index attribute.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Sorts bei inherited mcs, with entries of the current mcs always at the bottom. Sorting within the mcs entries is by name lexicographical ascending. |
Example
"NAME"
ScenarioAttributesUpdateInput
Description
Representation of an existing search index attribute.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the indexed attribute. |
version - Long!
|
The version of the indexed attribute. |
attribute - String!
|
The name of the attribute to index. |
level - AttributeLevel!
|
The level at which the attribute exists. Is this attribute from a product or an item? |
weight - Float!
|
The weight with which to adjust the relevance of results found through this attribute. |
Example
{
"id": "4",
"version": {},
"attribute": "abc123",
"level": "Product",
"weight": 123.45
}
ScoredPreviewEntry
SearchArticleFilterInput
SearchDiagnosisArticle
Description
Representation of a single result article.
Fields
| Field Name | Description |
|---|---|
markedAs - Mark!
|
A Mark for special articles in the search. |
relevance - Relevance
|
The relevance of this article to the given searchterm. Also contains a detailled explanation. |
online - Boolean
|
A flag telling if this article is online. |
articleNumber - String!
|
The article number of this article. |
image - String
|
An optional image link for this article. |
name - String!
|
The name of this article. |
brand - String
|
A brand this article belongs to. |
price - Money
|
The current price of this article. |
shopUrl - String
|
The URL where to find this article. |
Example
{
"markedAs": "HERO_ARTICLE",
"relevance": Relevance,
"online": false,
"articleNumber": "xyz789",
"image": "xyz789",
"name": "xyz789",
"brand": "abc123",
"price": Money,
"shopUrl": "abc123"
}
SearchDiagnosisFilterValues
Description
Sorting options for search diagnosis results.
Example
{
"showHeroArticleSorting": true,
"showAntiHeroArticleSorting": false,
"showArticleScoreSorting": false
}
SearchDiagnosisPaging
Description
Paging information, also contains Sorting information.
Fields
| Input Field | Description |
|---|---|
searchDiagnosisFilterValues - SearchDiagnosisFilterValues
|
Sorting options for search diagnosis results. |
offset - Int
|
Offset of results that should be skipped. Default: 0. Default = 0 |
limit - Int
|
Limit of results per page. Default: 100. Default = 100 |
Example
{
"searchDiagnosisFilterValues": SearchDiagnosisFilterValues,
"offset": 987,
"limit": 987
}
SearchDiagnosisResult
Description
Representation of a complete search result with explanation.
Fields
| Field Name | Description |
|---|---|
total - Int!
|
The total amount of Items found. |
totalShop - Int!
|
The total amount of Items shown in the shop. |
speed - Long!
|
The time it took to get this result. |
relevanceMetric - RelevanceMetric
|
The min/avg/max relevance values. |
heroCount - Int!
|
The amount of hero articles found. |
antiHeroCount - Int!
|
The amount of antihero articles found. |
exclusionCount - Int!
|
The amount of articles excluded. |
redirectUrl - String
|
An optional URL that will be filled if the given search term would be redirected to a special static page or article. |
isCustomerSegmented - Boolean!
|
A Flag telling if the search term has a customer segmented page parameter. |
isABTested - Boolean!
|
A Flag telling if the search term has a AB tested page parameter. |
items - [SearchDiagnosisResultItem]!
|
A List of found products with added relevance information. |
Example
{
"total": 123,
"totalShop": 987,
"speed": {},
"relevanceMetric": RelevanceMetric,
"heroCount": 123,
"antiHeroCount": 123,
"exclusionCount": 123,
"redirectUrl": "xyz789",
"isCustomerSegmented": true,
"isABTested": true,
"items": [SearchDiagnosisResultItem]
}
SearchDiagnosisResultItem
Description
Representation of a full result product.
Fields
| Field Name | Description |
|---|---|
productId - String!
|
The ID of this product |
articles - [SearchDiagnosisArticle]!
|
A List of Result articles belonging to this product. |
Example
{
"productId": "xyz789",
"articles": [SearchDiagnosisArticle]
}
SearchExclusion
Description
A single search exclusion.
Fields
| Field Name | Description |
|---|---|
id - Long!
|
The ID of this search exclusion |
version - Long!
|
The database version of the search exclusion entity. |
mcs - Mcs!
|
The mcs the entity has been created with. |
type - SearchExclusionType!
|
The type of this search exclusion. |
name - String
|
A name given by a shopmanager, has no impact on the search exclusion functionality. |
searchTerms - [String!]
|
A list of search terms this search exclusion applies to. |
countArticles - Int!
|
The number of articles this search exclusion excludes. |
articles - [Article]
|
Returns a list of articles this search exclusion excludes. |
categories - [CategoryTree!]!
|
Returns a list of categories this search exclusion applies to. use LinkToCategoryEntry |
categoryTreeEntries - [LinkToCategoryTreeEntry!]!
|
|
inheritanceEnabled - Boolean!
|
indication if this entry is overwriting values from higher MCS |
inheritedValue - SearchExclusion
|
contains values from higher MCS or null |
Example
{
"id": {},
"version": {},
"mcs": Mcs,
"type": "FOR_ALL_SEARCH_TERMS",
"name": "xyz789",
"searchTerms": ["xyz789"],
"countArticles": 123,
"articles": [Article],
"categories": [CategoryTree],
"categoryTreeEntries": [LinkToCategoryTreeEntry],
"inheritanceEnabled": true,
"inheritedValue": SearchExclusion
}
SearchExclusionCreatePayload
Description
Payload wrapper object for creating search exclusions.
Fields
| Field Name | Description |
|---|---|
entries - [SearchExclusion!]!
|
The list of created search exclusions. |
Example
{"entries": [SearchExclusion]}
SearchExclusionDeletePayload
Description
Payload wrapper object for deleting search exclusions.
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Flag for success. |
Example
{"successful": false}
SearchExclusionFilter
Description
A filter describing search exclusion attributes. These filters are cummulative (if they ar not empty or null).
Fields
| Input Field | Description |
|---|---|
onlyExact - Boolean
|
if set to true, only exact matches are returned. Default: False. Default = false |
searchTerms - [String!]
|
A list of search terms to filter for. Finds only exact matches in SearchTerms. Default: Empty. Default = [] |
name - String
|
The name of the searched search exclusions. Only names matching part of the input are returned. |
globalSearch - String
|
A string that should appear anywhere in the search exclusion. Searches the given input in all names and searchterms, finds partial matches. |
withParentMcs - Boolean
|
if set to false, only entries for current mcs will be returned Default: True. Default = true |
Example
{
"onlyExact": false,
"searchTerms": ["xyz789"],
"name": "xyz789",
"globalSearch": "xyz789",
"withParentMcs": true
}
SearchExclusionPagingInput
Description
Paging and sorting information for search exclusions.
Fields
| Input Field | Description |
|---|---|
sortType - SearchExclusionSorting!
|
Sorting of the returned search exclusions. Regardless of given sort type, global exclusions are always first. Default: Info. Default = INFO |
sortOrder - SortOrder!
|
Ordering of the returned search exclusions. Default: Descending. Default = DESC |
offset - Int!
|
Offset of results that should be skipped. Default: 0. Default = 0 |
limit - Int!
|
Limit of results per page. Default: 100. Default = 100 |
Example
{
"sortType": "SEARCH_TERM_LEXICOGRAPHICAL",
"sortOrder": "ASC",
"offset": 987,
"limit": 987
}
SearchExclusionSorting
Description
An enum of possible search exclusion sortings
Values
| Enum Value | Description |
|---|---|
|
|
uses the first term in search terms list |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Sorts by inherited mcs, with entries of the current mcs always at the bottom. Sorting within the mcs entries is by name lexicographical ascending. Global results are still always at the top. |
Example
"SEARCH_TERM_LEXICOGRAPHICAL"
SearchExclusionType
Description
An enum of the search exclusion types
Values
| Enum Value | Description |
|---|---|
|
|
global search terms |
|
|
search terms with the exact flag |
|
|
search terms without the exact flag |
Example
"FOR_ALL_SEARCH_TERMS"
SearchExclusionUpdateOperation
Description
Allowed operations to change a search execlusion. Only allows one element is allowed here. Input with more than one field set will be reject as bad parameter.
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
Changes the name to the given name. |
setExactFlag - SetExactFlag
|
Changes the exact flag to the given value. |
setSearchTerms - SetSearchTerms
|
Sets the search terms to the given search terms. |
setExcludedArticles - SetExcludedArticles
|
Sets the excluded articles to the given articles. |
addExcludedCategory - AddCategoryRelation
|
Adds a new excluded category. |
removeExcludedCategory - RemoveCategoryRelation
|
Removes an excluded category. |
setInheritanceEnabled - SetInheritanceEnabled
|
Changes the inheritanceEnabled flag to the given value. |
Example
{
"setName": SetName,
"setExactFlag": SetExactFlag,
"setSearchTerms": SetSearchTerms,
"setExcludedArticles": SetExcludedArticles,
"addExcludedCategory": AddCategoryRelation,
"removeExcludedCategory": RemoveCategoryRelation,
"setInheritanceEnabled": SetInheritanceEnabled
}
SearchExclusionUpdatePayload
Description
Payload wrapper object for updating search exclusions.
Fields
| Field Name | Description |
|---|---|
entries - [SearchExclusion!]!
|
The list of updated search exclusions. |
Example
{"entries": [SearchExclusion]}
SearchExclusions
Description
A list of search exclusions
Fields
| Field Name | Description |
|---|---|
entries - [SearchExclusion!]!
|
The list of search exclusions after applying paging information. |
totalCount - Int!
|
The complete count of exclusions, disregarding any paging information. count is calculated for given filter and mcs |
Example
{"entries": [SearchExclusion], "totalCount": 123}
SearchIndexAttributeSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
|
sortType - SearchIndexAttributeSortType!
|
Example
{"sortOrder": "ASC", "sortType": "DATE"}
SearchIndexAttributeSortType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DATE"
SearchIndexScenarioAttribute
Description
Representation of a search index scenario attribute.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the indexed attribute. |
version - Long!
|
The version of the indexed attribute. |
weight - Float!
|
The weight with which to adjust the relevance of results found through this attribute. |
name - String!
|
The name of the attribute to index. |
level - AttributeLevel!
|
The level at which the attribute exists. Is this attribute from a product or an item? |
mcs - Mcs!
|
The mcs the entity has been created with |
isInherited - Boolean!
|
Checks if the attribute was inherited from a given MCS. |
updated - DateTime!
|
When was this search index scenario attribute last updated? |
created - DateTime!
|
When was this search index scenario attribute created? |
Example
{
"id": "4",
"version": {},
"weight": 987.65,
"name": "xyz789",
"level": "Product",
"mcs": Mcs,
"isInherited": false,
"updated": "2007-12-03T10:15:30Z",
"created": "2007-12-03T10:15:30Z"
}
SearchIndexScenarioAttributeFilterInput
SearchIndexScenarioAttributePagingInput
Description
Paging information.
Fields
| Input Field | Description |
|---|---|
sortColumn - ScenarioAttributeSortColumn!
|
The column of the search index attributes to sort by. Default: Info. Default = INFO |
sortOrder - SortOrder!
|
Ordering of the returned search exclusions. Default: Ascending. Default = ASC |
offset - Int!
|
Offset of results that should be skipped. Default: 0. Default = 0 |
limit - Int!
|
Limit of results per page. Default: 100. Default = 100 |
Example
{"sortColumn": "NAME", "sortOrder": "ASC", "offset": 987, "limit": 987}
SearchIndexScenarioAttribute_2
SearchIndexScenarioAttributes
Description
A list of search index scenario attributes.
Fields
| Field Name | Description |
|---|---|
entries - [SearchIndexScenarioAttribute!]!
|
The list of search index scenario attributes after applying paging information. |
totalCount - Int!
|
The complete count of search index scenario attributes, disregarding any paging information. count is calculated for given filter and mcs. |
Example
{
"entries": [SearchIndexScenarioAttribute],
"totalCount": 123
}
SearchIndexScenarioCopyPayload
Fields
| Field Name | Description |
|---|---|
entries - [SearchIndexScenario_2!]!
|
Example
{"entries": [SearchIndexScenario_2]}
SearchIndexScenarioCreatePayload
Fields
| Field Name | Description |
|---|---|
entries - [SearchIndexScenario_2!]!
|
Example
{"entries": [SearchIndexScenario_2]}
SearchIndexScenarioDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": false}
SearchIndexScenarioUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [SearchIndexScenario_2!]!
|
Example
{"entries": [SearchIndexScenario_2]}
SearchIndexScenario_2
Example
{
"id": "4",
"version": {},
"audit": Audit,
"mcs": Mcs,
"name": "abc123",
"factor": 123,
"trackingCode": "abc123",
"attributeCount": 123,
"attributes": [SearchIndexScenarioAttribute_2]
}
SearchIndexableAttribute
Description
A single attribute which is search indexed.
Fields
| Field Name | Description |
|---|---|
attribute - String!
|
The unique name of this attribute. |
level - AttributeLevel!
|
On which object type the attribute is defined. |
selected - Boolean!
|
Flag describing if this attribute is currently indexed. |
Example
{
"attribute": "xyz789",
"level": "Product",
"selected": true
}
SearchIndexableAttributeFindPayload
Fields
| Field Name | Description |
|---|---|
entries - [IndexableAttribute!]!
|
|
totalCount - Int!
|
Example
{"entries": [IndexableAttribute], "totalCount": 987}
SearchIndexableAttributes
Description
A list of search index attributes.
Fields
| Field Name | Description |
|---|---|
entries - [SearchIndexableAttribute!]!
|
The list of search exclusions after applying paging information. |
totalCount - Int!
|
The complete count of search index attributes, disregarding any paging information. count is calculated for given filter and mcs |
Example
{"entries": [SearchIndexableAttribute], "totalCount": 987}
SearchIndexingScenario
Description
A representation of a single search index scenario.
Fields
| Field Name | Description |
|---|---|
id - Long!
|
The ID of a search index scenario. |
version - Long!
|
The version of the search index scenario. |
mcs - Mcs!
|
The mcs the entity has been created with |
name - String!
|
A descriptive name. |
isInherited - Boolean
|
Checks if this search index scenario was inherited from a given MCS. |
factor - Int!
|
The factor with which this search indexing scenario is applied. |
trackingCode - String
|
An optional tracking code to identify this indexing scenario with. |
Example
{
"id": {},
"version": {},
"mcs": Mcs,
"name": "xyz789",
"isInherited": false,
"factor": 987,
"trackingCode": "abc123"
}
SearchIndexingScenarioFilterInput
Description
Filter and Information needed to filter for specific search index scenarios.
Fields
| Input Field | Description |
|---|---|
mcsInput - McsInput!
|
The mcs for the filter. |
Example
{"mcsInput": McsInput}
SearchIndexingScenarioInput
Description
Description of a single, possibly new search indexing scenario.
Fields
| Input Field | Description |
|---|---|
id - Long
|
The ID of a search index scenario. Not mandatory, because it can be used in creation. |
version - Long!
|
The version of the search index scenario. Default: 0. Default = 0 |
mcsInput - McsInput!
|
The mcs for the search index. |
name - String!
|
A descriptive name. |
factor - Int!
|
The factor with which this search indexing scenario is applied. |
trackingCode - String
|
An optional tracking code to identify this indexing scenario with. |
Example
{
"id": {},
"version": {},
"mcsInput": McsInput,
"name": "xyz789",
"factor": 123,
"trackingCode": "abc123"
}
SearchIndexingScenarioPagingInput
Description
Options for different sortings of returned search index scenarios.
Fields
| Input Field | Description |
|---|---|
sortColumn - IndexingScenarioSortColumn!
|
By which column should the results be sorted. Default: Info. Default = INFO |
sortOrder - SortOrder!
|
In which direction should the results be sorted. Default: Descending. Default = DESC |
Example
{"sortColumn": "NAME", "sortOrder": "ASC"}
SearchInfo
Fields
| Field Name | Description |
|---|---|
markedAs - Mark!
|
Example
{"markedAs": "HERO_ARTICLE"}
SearchLog
Description
A single search log for one search term.
Fields
| Field Name | Description |
|---|---|
searchTerm - String!
|
The searchterm for which this search log is. |
totalSearchQueries - Int!
|
The total count of queries on this search term. |
averageHitRate - Int!
|
The average amount of search hits. |
averageClickRate - Float
|
The average click rate generated by this search term. |
averageConversionRate - Float
|
The average conversion rate of this search term. |
searchIndexed - Boolean!
|
A flag indicating if this search is indexed. |
Example
{
"searchTerm": "xyz789",
"totalSearchQueries": 123,
"averageHitRate": 987,
"averageClickRate": 123.45,
"averageConversionRate": 987.65,
"searchIndexed": true
}
SearchLogs
Description
A list of search logs.
Fields
| Field Name | Description |
|---|---|
searchLogs - [SearchLog]!
|
The list of search logs. Affected by paging. |
totalCount - Int!
|
The total amount of search logs found. Unaffected by paging. |
Example
{"searchLogs": [SearchLog], "totalCount": 987}
SearchResultEntry
SearchSuggestAttributeInput
Description
Information about a search suggest parameter attribute.
Fields
| Input Field | Description |
|---|---|
mcsInput - McsInput!
|
The mcs for the search suggest. |
attributeName - String!
|
The name of the attribute. |
attributeLevel - AttributeLevel!
|
On which objecttype the attribute is defined. |
Example
{
"mcsInput": McsInput,
"attributeName": "xyz789",
"attributeLevel": "Product"
}
SearchSuggestPagingInput
SearchSuggestResult
Fields
| Field Name | Description |
|---|---|
elements - [String!]!
|
Search suggest elements |
totalCount - Int!
|
Total number of all elements |
Example
{"elements": ["xyz789"], "totalCount": 123}
SearchTermFilterInput
Description
Information needed to find search logs.
Fields
| Input Field | Description |
|---|---|
searchTerm - String
|
Searching for the matching string in searchTerms only. |
globalTextSearch - String
|
Searches for the matching string in all SearchLog fields' values. |
startDate - DateTime
|
The start date of logging. |
endDate - DateTime
|
The end date of logging. |
sorting - ReportSorting!
|
Sorting information. |
paging - ReportPaging!
|
Paging information. |
Example
{
"searchTerm": "abc123",
"globalTextSearch": "abc123",
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"sorting": ReportSorting,
"paging": ReportPaging
}
SearchTermGroup
Description
A single search term group.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this search term group. |
version - Long!
|
The database version of the search term group entity. |
name - String!
|
A descriptive name. |
valid - Boolean!
|
Is valid in current mcs |
isExact - Boolean!
|
Flag representing if the result only applies to exact matches. |
mcs - Mcs!
|
The MCS this search term group applies to. |
searchTerms - [String!]!
|
A list of search terms this search term group represents. |
isInherited - Boolean!
|
Checks if this search term group is inherited from the given MCS. |
referenceType - PageReferenceType!
|
This is the referenceType for this instance. It returns SEARCH_TERM_GROUP |
Example
{
"id": "4",
"version": {},
"name": "xyz789",
"valid": true,
"isExact": false,
"mcs": Mcs,
"searchTerms": ["xyz789"],
"isInherited": true,
"referenceType": "NONE"
}
SearchTermGroupCreatePayload
Fields
| Field Name | Description |
|---|---|
entries - [SearchTermGroup!]!
|
Example
{"entries": [SearchTermGroup]}
SearchTermGroupDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": false}
SearchTermGroupEntry
Description
Defines the types that can be part of the search term group tree.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
|
deleteDate - DateTime
|
The date when the entry will be deleted or null if it won't be deleted |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
ancestors - [NavigationTreeEntry!]!
|
|
parent - NavigationTreeEntry
|
|
children - NavigationTreeEntryChildrenPayload!
|
|
Arguments
|
|
valid - Boolean!
|
|
referenceType - PageReferenceType!
|
|
Possible Types
| SearchTermGroupEntry Types |
|---|
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"name": "xyz789",
"deleteDate": "2007-12-03T10:15:30Z",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"ancestors": [NavigationTreeEntry],
"parent": NavigationTreeEntry,
"children": NavigationTreeEntryChildrenPayload,
"valid": true,
"referenceType": "NONE"
}
SearchTermGroupFilterInput
Description
Filters for a search for search term groups. These filters are cummulative (if they ar not empty or null).
Fields
| Input Field | Description |
|---|---|
onlyExact - Boolean
|
If set to true, only exact matches are returned. Default: False. Default = false |
searchTerms - [String!]
|
A List of searchterms. finds only exact matches in SearchTerms. Default = [] |
name - String
|
A descriptive name. Only names matching part of the input are returned. |
globalSearch - String
|
Searches the given input in all names and searchterms, finds partial matches. |
ids - [String!]
|
will find SearchTermGroups By Id. Default = [] |
Example
{
"onlyExact": false,
"searchTerms": ["abc123"],
"name": "xyz789",
"globalSearch": "abc123",
"ids": ["xyz789"]
}
SearchTermGroupInput
Description
A single search term group.
Fields
| Input Field | Description |
|---|---|
id - Long
|
ID used for update. |
name - String!
|
A descriptive name. |
isExact - Boolean!
|
Flag representing if the result only applies to exact matches. |
mcsInput - McsInput!
|
The MCS this search term group applies to. |
searchTerms - [String!]!
|
A list of search terms this search term group represents. |
Example
{
"id": {},
"name": "xyz789",
"isExact": false,
"mcsInput": McsInput,
"searchTerms": ["xyz789"]
}
SearchTermGroupPagingInput
Description
Paging information. Also contains information about the sorting order.
Fields
| Input Field | Description |
|---|---|
sorting - SearchTermGroupSortColumn!
|
Field after which the results should be sorted. Default: Info. Default = INFO |
sortOrder - SortOrder!
|
Direction of sorting. Default: Descending. Default = DESC |
offset - Int!
|
Offset of results that should be skipped. Default: 0. Default = 0 |
limit - Int!
|
Limit of results per page. Default: 100. Default = 100 |
Example
{"sorting": "NAME", "sortOrder": "ASC", "offset": 123, "limit": 123}
SearchTermGroupSortColumn
Description
Enum description of the search term group columns.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Sorts by inherited mcs, with entries of the current mcs always at the bottom. Sorting within the mcs entries is by name lexicographical ascending. |
Example
"NAME"
SearchTermGroupUpdateOperation
Description
Allowed operations to change a search term group. Only allows one element is allowed here. Input with more than one field set will be reject as bad parameter.
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
A name for the search term group. |
setExactFlag - SetExactFlag
|
A flag deciding if this search term group affects only exact matches or all containing matches. Default: True, hits only exact matches. |
setSearchTerms - SetSearchTerms
|
The search terms inside this group |
Example
{
"setName": SetName,
"setExactFlag": SetExactFlag,
"setSearchTerms": SetSearchTerms
}
SearchTermGroupUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [SearchTermGroup!]!
|
Example
{"entries": [SearchTermGroup]}
SearchTermGroups
Description
A list of search term groups.
Fields
| Field Name | Description |
|---|---|
entries - [SearchTermGroup!]!
|
The list of search term groups, affected by paging. |
totalCount - Int!
|
A complete count of search term groups, unaffected by paging. count is calculated for given filter and mcs. |
Example
{"entries": [SearchTermGroup], "totalCount": 987}
SearchTermInput
Description
A search term
Fields
| Input Field | Description |
|---|---|
searchTerm - String!
|
A searchterm. |
Example
{"searchTerm": "xyz789"}
SearchTermLink
Description
The representation of a search term link.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this link. |
version - Long!
|
The version of this link. |
openLinkInNewWindow - Boolean!
|
Should the link be opened in a new window? |
urlParameters - String
|
The URL parameters of this link. |
anchorLink - String
|
The Anchor link of this link |
searchTerm - String!
|
The search term. |
Example
{
"id": "4",
"version": {},
"openLinkInNewWindow": false,
"urlParameters": "abc123",
"anchorLink": "xyz789",
"searchTerm": "xyz789"
}
SearchTermLinkInput
Description
Additional information to describe a search term link.
Fields
| Input Field | Description |
|---|---|
searchTerm - String!
|
The search term. |
Example
{"searchTerm": "xyz789"}
SelectableValueAttributeType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
key - String!
|
|
displayName - String!
|
|
group - AttributeDefinitionGroup!
|
|
abTestable - Boolean!
|
|
customerSegmentsAllowed - Boolean!
|
|
exportable - Boolean!
|
|
linkable - Boolean!
|
indicate whether an attribute can be linked to other object. Linking attribute is used for category and page parameters. |
standard - Boolean!
|
true for standard ishop core attribute and false for shop specific ones |
mandatory - Boolean!
|
indicates whether the value must be present for this type. |
helpText - String
|
|
hasHelpText - Boolean!
|
|
mutationCommandType - String!
|
|
allowedValues - [AllowedValue!]!
|
|
multipleChoicesAllowed - Boolean!
|
indicates whether one or multiple values can be chosen |
valueOption - [AttributeOption!]!
|
When not empty, imposes restrictions about the allowed values that might be maintained for this type |
attributeOptions - [MapType!]!
|
When not empty, imposes restrictions about the allowed parameter name in case of global parameters. |
searchable - Boolean!
|
indicates whether the value for this attribute description could be indexed by the content search. |
valueType - AttributeValueType!
|
Example
{
"id": "4",
"version": {},
"key": "abc123",
"displayName": "xyz789",
"group": AttributeDefinitionGroup,
"abTestable": true,
"customerSegmentsAllowed": true,
"exportable": false,
"linkable": false,
"standard": false,
"mandatory": true,
"helpText": "abc123",
"hasHelpText": false,
"mutationCommandType": "xyz789",
"allowedValues": [AllowedValue],
"multipleChoicesAllowed": true,
"valueOption": [AttributeOption],
"attributeOptions": [MapType],
"searchable": false,
"valueType": "Text"
}
SeoTerm
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this SEO Term. |
version - Long!
|
The version of this SEO Term. |
term - String!
|
The Term of this SEO Term. |
url - String!
|
The url of this SEO Term. |
mainTerm - Boolean!
|
The mainTerm of this SEO Term. |
mcs - Mcs!
|
The mcs of this SEO Term. |
categoryTreeEntry - CategoryTreeEntry!
|
The categoryTreeEntry of this SEO Term. |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
The backofficeUserInfoAudit of this SEO Term. |
Example
{
"id": 4,
"version": {},
"term": "abc123",
"url": "abc123",
"mainTerm": true,
"mcs": Mcs,
"categoryTreeEntry": CategoryTreeEntry,
"backofficeUserInfoAudit": BackofficeUserInfoAudit
}
SeoTermCategoryFilterInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Representation of category id |
Example
{"id": "4"}
SeoTermCreatePayload
Fields
| Field Name | Description |
|---|---|
entries - [SeoTerm!]!
|
Example
{"entries": [SeoTerm]}
SeoTermDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": false}
SeoTermFilterInput
Fields
| Input Field | Description |
|---|---|
ids - [ID!]!
|
The ids of SEO Term. Default = [] |
categoryStatus - [CategoryStatus!]!
|
The filter by categoryStatus of this categories. Default = [] |
searchTerm - String
|
The searchTerm search in term, url, categoryName and categoryPatch of SEO Term. |
Example
{
"ids": [4],
"categoryStatus": ["INVALID"],
"searchTerm": "xyz789"
}
SeoTermFindPayload
Description
A list of SEOTerms
Fields
| Field Name | Description |
|---|---|
entries - [SeoTerm!]!
|
The list of SEOTerms after applying paging information. |
totalCount - Int!
|
The complete count of SEOTerms |
Example
{"entries": [SeoTerm], "totalCount": 987}
SeoTermPagingInput
Description
Representation of paging input
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
|
sortInput - SeoTermSortingInput!
|
Example
{
"paging": Paging,
"sortInput": SeoTermSortingInput
}
SeoTermSortTypeInput
Description
Representation in which will the SEO Terms result be sorted
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TERM"
SeoTermSortingInput
Description
Representation of sortInput and default type is term
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
|
sortType - SeoTermSortTypeInput!
|
Example
{"sortOrder": "ASC", "sortType": "TERM"}
SeoTermUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [SeoTerm!]!
|
Example
{"entries": [SeoTerm]}
SetABTestValidityPeriod
SetAbScenario
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
SetAbTestTrackingCode
Description
An optional tracking code for this scenario.
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetAbTestValue
Fields
| Input Field | Description |
|---|---|
scenarioId - ID!
|
|
setValue - SetGenericValueOperation!
|
Example
{
"scenarioId": "4",
"setValue": SetGenericValueOperation
}
SetAbTestValueOperation
Description
It is possible to assign two different values for an AB test. The first one is to assign a specific value for a scenario and the other one to set no value for the scenario.
Fields
| Input Field | Description |
|---|---|
setAbTestValue - SetAbTestValue
|
|
setNoAbTestValue - SetNoAbTestValue
|
Example
{
"setAbTestValue": SetAbTestValue,
"setNoAbTestValue": SetNoAbTestValue
}
SetActive
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
true if the mcs will be activated, or false |
Example
{"value": false}
SetAlt
Description
Set a alt tag for the asset.
Fields
| Input Field | Description |
|---|---|
value - String
|
The title tag. |
Example
{"value": "abc123"}
SetAlwaysAt
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SetAnchorLink
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetArticleLink
Fields
| Input Field | Description |
|---|---|
id - String!
|
Example
{"id": "abc123"}
SetArticleListScoreCardBooleanValue
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": true}
SetArticleListScoreType
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
SetArticleScoreValue
Fields
| Input Field | Description |
|---|---|
id - ID
|
Example
{"id": 4}
SetArticlesIgnoreList
Description
Input parameters for Article Ignore List
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
SetAssetLink
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
SetAssetTagsDefaultLanguage
Fields
| Input Field | Description |
|---|---|
value - Boolean
|
Indicates if this is the default value. |
Example
{"value": true}
SetAssetTagsLanguage
Fields
| Input Field | Description |
|---|---|
value - String
|
The input language. |
Example
{"value": "xyz789"}
SetAssetValue
Fields
| Input Field | Description |
|---|---|
id - ID
|
Example
{"id": 4}
SetAttribute
Fields
| Input Field | Description |
|---|---|
setType - SetParameterType!
|
|
setTimeValidity - SetTimeValidity
|
|
setParameterDescription - SetParameterDescription
|
Example
{
"setType": SetParameterType,
"setTimeValidity": SetTimeValidity,
"setParameterDescription": SetParameterDescription
}
SetAttributeName
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SetAttributeTypeId
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
SetBasicNodeExtendedSettings
Fields
| Input Field | Description |
|---|---|
setNodePositionOperation - SetNodePositionOperation
|
|
setNodeName - SetNodeName
|
Example
{
"setNodePositionOperation": SetNodePositionOperation,
"setNodeName": SetNodeName
}
SetBasicNodeSettings
Fields
| Input Field | Description |
|---|---|
setNodePositionOperation - SetNodePositionOperation
|
Example
{"setNodePositionOperation": SetNodePositionOperation}
SetBasicSettings
Fields
| Input Field | Description |
|---|---|
setPageTimeValidity - SetPageTimeValidity!
|
|
setBasicSettingsUrl - SetBasicSettingsUrl
|
|
setBasicSettingsDescription - SetBasicSettingsDescription
|
Example
{
"setPageTimeValidity": SetPageTimeValidity,
"setBasicSettingsUrl": SetBasicSettingsUrl,
"setBasicSettingsDescription": SetBasicSettingsDescription
}
SetBasicSettingsDescription
Fields
| Input Field | Description |
|---|---|
value - String
|
Example
{"value": "xyz789"}
SetBasicSettingsName
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetBasicSettingsUrl
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetBenefitCurrency
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetBenefitDiscount
Fields
| Input Field | Description |
|---|---|
value - Float!
|
Example
{"value": 987.65}
SetBenefitImage
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
SetBenefitItems
Fields
| Input Field | Description |
|---|---|
value - [String!]!
|
Example
{"value": ["abc123"]}
SetBenefitTarget
Fields
| Input Field | Description |
|---|---|
value - BenefitTarget!
|
Example
{"value": "ITEM"}
SetBenefitTitle
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SetBooleanConditionValue
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Boolean value |
Example
{"value": true}
SetBooleanValue
Fields
| Input Field | Description |
|---|---|
value - Boolean
|
Example
{"value": true}
SetBooleanValueCondition
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": true}
SetBrandCategory
Fields
| Input Field | Description |
|---|---|
setBasicSettings - SetBasicSettings!
|
|
setBrandCategorySettings - SetBrandCategorySettings!
|
Example
{
"setBasicSettings": SetBasicSettings,
"setBrandCategorySettings": SetBrandCategorySettings
}
SetBrandCategoryDepthValue
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 123}
SetBrandCategoryLimitValue
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 987}
SetBrandCategoryName
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SetBrandCategoryNode
Fields
| Input Field | Description |
|---|---|
setBasicNodeSettings - SetBasicNodeExtendedSettings!
|
|
setNodeInformation - SetBrandCategory!
|
Example
{
"setBasicNodeSettings": SetBasicNodeExtendedSettings,
"setNodeInformation": SetBrandCategory
}
SetBrandCategorySettings
Fields
| Input Field | Description |
|---|---|
addNamedBrandCategorySources - [AddNamedBrandCategorySource!]!
|
|
addBlocklistedBrands - [AddBlocklistedBrand!]
|
|
setLimitValue - SetBrandCategoryLimitValue
|
|
setDepthValue - SetBrandCategoryDepthValue
|
Example
{
"addNamedBrandCategorySources": [
AddNamedBrandCategorySource
],
"addBlocklistedBrands": [AddBlocklistedBrand],
"setLimitValue": SetBrandCategoryLimitValue,
"setDepthValue": SetBrandCategoryDepthValue
}
SetBrandDynamicConditionRelation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Brand id |
Example
{"id": 4}
SetBrandId
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The Brand ID |
Example
{"id": "4"}
SetBrandImage
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The image ID |
Example
{"id": "4"}
SetBrandLink
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
SetBrandLinkTargetOperation
Fields
| Input Field | Description |
|---|---|
setArticleLink - SetArticleLink
|
Link to an article |
setAssetLink - SetAssetLink
|
Link to an asset |
setLayerLink - SetLayerLink
|
Link to a layer |
setExternalLink - SetExternalLink
|
Link to an external page |
setPageLink - SetPageLink
|
link to a page |
setCategoryLink - SetCategoryLink
|
Link to a category |
setContentTreeLink - SetContentTreeLink
|
Link to a content tree page |
setSeoTermLink - SetSeoTermLink
|
Link to a SEO term |
setSearchTermLink - SetSearchTermLink
|
Link to a SearchTerm |
Example
{
"setArticleLink": SetArticleLink,
"setAssetLink": SetAssetLink,
"setLayerLink": SetLayerLink,
"setExternalLink": SetExternalLink,
"setPageLink": SetPageLink,
"setCategoryLink": SetCategoryLink,
"setContentTreeLink": SetContentTreeLink,
"setSeoTermLink": SetSeoTermLink,
"setSearchTermLink": SetSearchTermLink
}
SetBrandLinkValue
Fields
| Input Field | Description |
|---|---|
openInNewTab - Boolean
|
|
setTarget - SetBrandLinkTargetOperation!
|
|
setUrlParameters - SetUrlParameters
|
|
setAnchorLink - SetAnchorLink
|
Example
{
"openInNewTab": false,
"setTarget": SetBrandLinkTargetOperation,
"setUrlParameters": SetUrlParameters,
"setAnchorLink": SetAnchorLink
}
SetBrandListValue
Fields
| Input Field | Description |
|---|---|
values - [ID!]
|
Example
{"values": [4]}
SetBrokenInheritanceFrom
Description
Representation for referenced link when applying break inheritance
Fields
| Input Field | Description |
|---|---|
value - ID
|
value for broken_inheritance_from field |
Example
{"value": 4}
SetCampaign
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
SetCapAmount
Fields
| Input Field | Description |
|---|---|
value - Float
|
Example
{"value": 123.45}
SetCapCurrency
Fields
| Input Field | Description |
|---|---|
value - String
|
Example
{"value": "abc123"}
SetCategoriesIgnoreList
Description
Input parameters for Category Ignore List
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
SetCategory
Fields
| Input Field | Description |
|---|---|
id - ID
|
Example
{"id": "4"}
SetCategoryConditionOperator
Fields
| Input Field | Description |
|---|---|
value - CategoryConditionOperator!
|
Operator Within/NotWithin |
Example
{"value": "Within"}
SetCategoryDynamicConditionRelation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Category id |
Example
{"id": 4}
SetCategoryHiddenListValue
Fields
| Input Field | Description |
|---|---|
value - [HideCategory!]
|
Example
{"value": ["URL"]}
SetCategoryId
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
SetCategoryLink
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
SetCategoryListValue
Fields
| Input Field | Description |
|---|---|
categoryIds - [ID!]
|
Example
{"categoryIds": ["4"]}
SetCategoryTreeRelation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Category entity ID |
setIncludeSubTree - SetIncludeSubTree!
|
Command used to set field includeSubTree |
Example
{
"id": "4",
"setIncludeSubTree": SetIncludeSubTree
}
SetComboboxConditionValue
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetCommonVoucher
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Common voucher id |
Example
{"id": 4}
SetCompressionType
Description
Input parameter for Compression type
Fields
| Input Field | Description |
|---|---|
value - ExportCompressionType!
|
Example
{"value": "NONE"}
SetConnectedIProductProductId
Fields
| Input Field | Description |
|---|---|
value - Int!
|
The connected iProduct product id |
Example
{"value": 987}
SetConnectedIProductStatus
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
The connected iProduct status |
Example
{"value": true}
SetConnectedIProductUseCaseId
Fields
| Input Field | Description |
|---|---|
value - Int!
|
The connected iProduct use case id |
Example
{"value": 123}
SetContentNodePositionOperation
Fields
| Input Field | Description |
|---|---|
setParentNode - SetParentContentNodeId
|
|
setPreviousNode - SetPreviousContentNodeId
|
|
setNextNode - SetNextContentNodeId
|
|
setFirstNode - SetFirstContentNodeId
|
Example
{
"setParentNode": SetParentContentNodeId,
"setPreviousNode": SetPreviousContentNodeId,
"setNextNode": SetNextContentNodeId,
"setFirstNode": SetFirstContentNodeId
}
SetContentTreeId
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
SetContentTreeLink
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
SetContentTypeId
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
SetCronExpression
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SetCuratedPage
Description
CREATE
Fields
| Input Field | Description |
|---|---|
setBasicSettings - SetBasicSettings!
|
|
setBasicSettingsName - SetBasicSettingsName!
|
Example
{
"setBasicSettings": SetBasicSettings,
"setBasicSettingsName": SetBasicSettingsName
}
SetCuratedPageNode
Fields
| Input Field | Description |
|---|---|
setBasicNodeSettings - SetBasicNodeExtendedSettings!
|
|
setNodeInformation - SetCuratedPage!
|
Example
{
"setBasicNodeSettings": SetBasicNodeExtendedSettings,
"setNodeInformation": SetCuratedPage
}
SetCustomerIdentifier
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SetCustomerSegmentDynamicConditionRelation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Customer segment id |
Example
{"id": "4"}
SetCustomerSegmentName
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetCustomerSegmentedValue
Fields
| Input Field | Description |
|---|---|
customerSegmentIds - [ID!]!
|
|
setValue - SetGenericValueOperation!
|
Example
{
"customerSegmentIds": ["4"],
"setValue": SetGenericValueOperation
}
SetDateConditionValue
Fields
| Input Field | Description |
|---|---|
value - DateTime!
|
Date value |
Example
{"value": "2007-12-03T10:15:30Z"}
SetDateFormat
Description
Input for updating date format setting of the current user
Fields
| Input Field | Description |
|---|---|
value - String
|
New date format |
Example
{"value": "abc123"}
SetDateTimeFormat
Description
Input for updating date time format setting of the current user
Fields
| Input Field | Description |
|---|---|
value - String
|
New date time format |
Example
{"value": "xyz789"}
SetDateValue
Fields
| Input Field | Description |
|---|---|
value - DateTime
|
Example
{"value": "2007-12-03T10:15:30Z"}
SetDefault
Description
An flag that indicates if this scenario is th default.
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": false}
SetDescription
Fields
| Input Field | Description |
|---|---|
value - String
|
The description |
Example
{"value": "abc123"}
SetDoubleConditionValue
Fields
| Input Field | Description |
|---|---|
value - Float!
|
Double value |
Example
{"value": 987.65}
SetDoubleStringValue
SetDynamicConditionDescription
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Dynamic condition description id |
Example
{"id": "4"}
SetDynamicValueOperation
Fields
| Input Field | Description |
|---|---|
setNonSegmentedValue - SetGenericValueOperation
|
|
setAbTestValues - [SetAbTestValueOperation!]
|
|
setCustomerSegmentedValues - [SetCustomerSegmentedValue!]
|
Example
{
"setNonSegmentedValue": SetGenericValueOperation,
"setAbTestValues": [SetAbTestValueOperation],
"setCustomerSegmentedValues": [
SetCustomerSegmentedValue
]
}
SetEmail
Description
Input parameter for email
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetEveryHours
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 987}
SetEveryMinutes
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 987}
SetExactFlag
Description
A new value for the Exact-Flag, describing if a search exclusion affects only exact matches or all containing matches.
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
The value. Default = true |
Example
{"value": false}
SetExcludedArticles
Description
A list of excluded articles.
Fields
| Input Field | Description |
|---|---|
value - [String!]!
|
The list of excluded articles. |
Example
{"value": ["xyz789"]}
SetExportFormat
Description
Input parameters for Export format
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
SetExportType
Description
Export type (one from these commands should be set)
Fields
| Input Field | Description |
|---|---|
setHttpType - SetHttpType
|
|
setFtpType - SetFtpType
|
Example
{
"setHttpType": SetHttpType,
"setFtpType": SetFtpType
}
SetExportedFileName
Description
Input parameter for Exported file name
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SetExternalLink
SetFilterCategory
Fields
| Input Field | Description |
|---|---|
setBasicSettings - SetBasicSettings!
|
|
setFilterCategorySettings - SetFilterCategorySettings!
|
Example
{
"setBasicSettings": SetBasicSettings,
"setFilterCategorySettings": SetFilterCategorySettings
}
SetFilterCategoryLimitType
Fields
| Input Field | Description |
|---|---|
value - FilterLimitType!
|
Example
{"value": "None"}
SetFilterCategoryLimitValue
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 123}
SetFilterCategoryNode
Fields
| Input Field | Description |
|---|---|
setBasicNodeSettings - SetBasicNodeExtendedSettings!
|
|
setNodeInformation - SetFilterCategory!
|
Example
{
"setBasicNodeSettings": SetBasicNodeExtendedSettings,
"setNodeInformation": SetFilterCategory
}
SetFilterCategorySettings
Fields
| Input Field | Description |
|---|---|
addFilterCategorySources - [AddFilterCategorySource!]!
|
|
addFilterCategoryCondition - AddOrFilterCategoryCondition!
|
|
addBlocklistedCategories - [AddFilterCategoryBlocklistedCategory!]
|
|
setLimitType - SetFilterCategoryLimitType
|
|
setLimitValue - SetFilterCategoryLimitValue
|
|
setSkuSort - SetBooleanValueCondition
|
Example
{
"addFilterCategorySources": [AddFilterCategorySource],
"addFilterCategoryCondition": AddOrFilterCategoryCondition,
"addBlocklistedCategories": [
AddFilterCategoryBlocklistedCategory
],
"setLimitType": SetFilterCategoryLimitType,
"setLimitValue": SetFilterCategoryLimitValue,
"setSkuSort": SetBooleanValueCondition
}
SetFilterLevel
Fields
| Input Field | Description |
|---|---|
setFilterLevelCondition - SetFilterLevelCondition!
|
|
setDescription - SetFilterLevelDescription
|
Example
{
"setFilterLevelCondition": SetFilterLevelCondition,
"setDescription": SetFilterLevelDescription
}
SetFilterLevelCondition
Fields
| Input Field | Description |
|---|---|
addOrFilterLevelCondition - AddOrFilterLevelCondition!
|
Example
{"addOrFilterLevelCondition": AddOrFilterLevelCondition}
SetFilterLevelDescription
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SetFilterLevelNode
Fields
| Input Field | Description |
|---|---|
setBasicNodeSettings - SetBasicNodeExtendedSettings!
|
|
setNodeInformation - SetFilterLevel!
|
Example
{
"setBasicNodeSettings": SetBasicNodeExtendedSettings,
"setNodeInformation": SetFilterLevel
}
SetFilterListValue
Fields
| Input Field | Description |
|---|---|
value - [String!]
|
Example
{"value": ["abc123"]}
SetFirstContentNodeId
Fields
| Input Field | Description |
|---|---|
value - ID!
|
Example
{"value": 4}
SetFirstDayOfWeek
Description
Input for updating first day of week setting of the current user
Fields
| Input Field | Description |
|---|---|
value - Weekday
|
New first day of week |
Example
{"value": "SUNDAY"}
SetFirstNodeId
Fields
| Input Field | Description |
|---|---|
value - ID!
|
Example
{"value": 4}
SetFromDoubleValue
Fields
| Input Field | Description |
|---|---|
value - Float!
|
Example
{"value": 987.65}
SetFromIntValue
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 123}
SetFtpType
Description
Input parameters for FTP type
Fields
| Input Field | Description |
|---|---|
setFileName - SetExportedFileName!
|
|
setUrl - SetUrl!
|
|
setSchedule - SetSchedule!
|
Example
{
"setFileName": SetExportedFileName,
"setUrl": SetUrl,
"setSchedule": SetSchedule
}
SetGenerator
Fields
| Input Field | Description |
|---|---|
setSingleCode - SetSingleCode
|
Single code |
setPrefixCode - SetPrefixCode
|
Prefix generator with code length and count |
setRegExp - SetRegExp
|
Regular expression |
setImportedCodes - SetImportedCodes
|
Imported key for uploaded file |
Example
{
"setSingleCode": SetSingleCode,
"setPrefixCode": SetPrefixCode,
"setRegExp": SetRegExp,
"setImportedCodes": SetImportedCodes
}
SetGenericValueOperation
Fields
Example
{
"setString": SetStringValue,
"setStringList": SetStringListValue,
"setDoubleString": SetDoubleStringValue,
"setInt": SetIntValue,
"setBoolean": SetBooleanValue,
"setFilterList": SetFilterListValue,
"setOption": SetOptionValue,
"setOptions": SetOptionsValue,
"setLink": SetLinkValue,
"removeLinkValue": RemoveLinkValue,
"setArticleScoreValue": SetArticleScoreValue,
"addLinkedBrands": [AddLinkedBrandRelation],
"removeLinkedBrands": [RemoveLinkedBrandRelation],
"addNamedCategories": [AddNamedCategoryRelation],
"removeNamedCategories": [RemoveNamedCategoryRelation],
"addNamedImages": [AddNamedImageRelation],
"removeNamedImages": [RemoveNamedImageRelation],
"addNamedLinks": [AddNamedLinkRelation],
"updateNamedLinks": [UpdateNamedLinkRelationInput],
"removeNamedLinks": [RemoveNamedLinkRelation],
"setBrandList": SetBrandListValue,
"setAsset": SetAssetValue,
"removeAsset": RemoveAssetValue,
"setTeaser": SetTeaserValue,
"updateTeaser": UpdateTeaserOperation,
"removeTeaserValue": RemoveTeaserValue,
"addTabValues": [AddTabValue],
"updateTab": UpdateTabOperationInput,
"updateTabIndex": UpdateTabIndex,
"updateTabIndexByIndex": UpdateTabIndexByIndex,
"removeTabValue": RemoveTabValue,
"removeTabValueByIndex": RemoveTabValueByIndex,
"setCategoryList": SetCategoryListValue,
"setCategoryHiddenListValue": SetCategoryHiddenListValue,
"setCategory": SetCategory,
"setGoogleCategoryValue": SetGoogleCategoryValue,
"addSmartProductCinema": AddSmartProductCinema,
"updateSmartProductCinema": UpdateSmartProductCinema,
"setDate": SetDateValue,
"addHotSpotRelation": [AddHotSpotRelation],
"updateHotSpotRelation": [UpdateHotSpotRelationInput],
"removeHotSpotRelation": [RemoveHotSpotRelation],
"addTagCloud": [AddTagCloudRelation],
"updateTagCloud": [UpdateTagCloudRelationInput],
"removeTagCloud": [RemoveTagCloudRelation],
"removeRelation": "REMOVE"
}
SetGlobalParameterAttribute
Fields
| Input Field | Description |
|---|---|
setType - SetParameterType!
|
|
setName - SetAttributeName!
|
|
setTimeValidity - SetTimeValidity!
|
|
setParameterDescription - SetParameterDescription
|
Example
{
"setType": SetParameterType,
"setName": SetAttributeName,
"setTimeValidity": SetTimeValidity,
"setParameterDescription": SetParameterDescription
}
SetGoogleCategoryValue
Fields
| Input Field | Description |
|---|---|
id - ID
|
Example
{"id": "4"}
SetGranularity
Description
Input parameter for Granularity
Fields
| Input Field | Description |
|---|---|
value - ExportGranularity!
|
Example
{"value": "PRODUCT"}
SetGridContainerHeight
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 123}
SetGridContainerParameter
Fields
| Input Field | Description |
|---|---|
addGridContainerAttribute - [AddGridContainerAttribute!]!
|
Example
{"addGridContainerAttribute": [AddGridContainerAttribute]}
SetGridContainerTrackingCode
Fields
| Input Field | Description |
|---|---|
value - String
|
Tracking value, allows null to handle removing tracking code |
Example
{"value": "abc123"}
SetGridContainerType
Fields
| Input Field | Description |
|---|---|
value - GridContainerType!
|
Example
{"value": "Normal"}
SetGridContainerWidth
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 123}
SetGridContainers
Fields
| Input Field | Description |
|---|---|
value - [CreateGridContainer!]!
|
A List of containers, which should be created |
Example
{"value": [CreateGridContainer]}
SetGridTemplate
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
SetGroup
Fields
| Input Field | Description |
|---|---|
value - GroupModel!
|
The customer segment group data |
Example
{"value": GroupModel}
SetHeight
Description
A height for the asset format
Fields
| Input Field | Description |
|---|---|
value - Int!
|
The height |
Example
{"value": 987}
SetHelpText
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetHotSpotCoordinates
Fields
| Input Field | Description |
|---|---|
values - [CoordinatesInput!]!
|
Example
{"values": [CoordinatesInput]}
SetHotSpotText
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SetHotSpotTrackingCode
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetHourFormat
Description
Input for updating hour format setting of the current user
Fields
| Input Field | Description |
|---|---|
value - HourFormat
|
New hour format |
Example
{"value": "AMPM"}
SetHttpType
Description
Input parameters for HTTP type
Fields
| Input Field | Description |
|---|---|
setFileName - SetExportedFileName!
|
Example
{"setFileName": SetExportedFileName}
SetHypothesis
Fields
| Input Field | Description |
|---|---|
value - String
|
Example
{"value": "abc123"}
SetIdentifier
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetImported
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": false}
SetImportedCodes
Fields
| Input Field | Description |
|---|---|
value - String!
|
Imported key for uploaded file with codes |
Example
{"value": "abc123"}
SetImportedCodesAndClients
Description
Set an importedCodesAndClients
Fields
| Input Field | Description |
|---|---|
value - PersonalVoucherImportModel!
|
The personal voucher imported key and regex |
Example
{"value": PersonalVoucherImportModel}
SetImportedId
Description
Set a imported id for cached bytes
Fields
| Input Field | Description |
|---|---|
value - ID!
|
The imported id for cached bytes |
Example
{"value": "4"}
SetIncludeSubTree
Description
If all subcategories of this category should be included or only this specific category.
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": false}
SetIndexHtmlContent
Description
Set content for index html file
Fields
| Input Field | Description |
|---|---|
indexHtmlContent - String!
|
Example
{"indexHtmlContent": "abc123"}
SetIndexableAttributeName
Description
Sets the search indexed attribute name.
Fields
| Input Field | Description |
|---|---|
value - String!
|
The name of the search indexed attribute. |
Example
{"value": "abc123"}
SetInformativeType
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetInheritanceEnabled
Description
A new value for the inheritanceEnabled flag, describing if a global search exclusion is overwriting entries from parent mcs
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
The value. |
Example
{"value": true}
SetIntValue
Fields
| Input Field | Description |
|---|---|
value - Int
|
Example
{"value": 123}
SetIntWeight
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 987}
SetIntegerConditionValue
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Integer value |
Example
{"value": 987}
SetInternalName
Fields
| Input Field | Description |
|---|---|
value - String
|
Example
{"value": "abc123"}
SetItemsYouPay
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 987}
SetItemsYouTake
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 987}
SetKeywords
Description
Set keyword tags for the asset.
Fields
| Input Field | Description |
|---|---|
value - [String]
|
The keywords. |
Example
{"value": ["abc123"]}
SetLanguage
Description
Input for updating language setting of the current user
Fields
| Input Field | Description |
|---|---|
value - String
|
New language |
Example
{"value": "xyz789"}
SetLayerLink
Fields
| Input Field | Description |
|---|---|
layerInfo - String!
|
The information about the layer. |
Example
{"layerInfo": "abc123"}
SetLinkTargetOperation
Fields
| Input Field | Description |
|---|---|
setArticleLink - SetArticleLink
|
|
setAssetLink - SetAssetLink
|
|
setLayerLink - SetLayerLink
|
|
setExternalLink - SetExternalLink
|
|
setBrandLink - SetBrandLink
|
|
setPageLink - SetPageLink
|
|
setCategoryLink - SetCategoryLink
|
|
setContentTreeLink - SetContentTreeLink
|
|
setSeoTermLink - SetSeoTermLink
|
|
setSearchTermLink - SetSearchTermLink
|
Example
{
"setArticleLink": SetArticleLink,
"setAssetLink": SetAssetLink,
"setLayerLink": SetLayerLink,
"setExternalLink": SetExternalLink,
"setBrandLink": SetBrandLink,
"setPageLink": SetPageLink,
"setCategoryLink": SetCategoryLink,
"setContentTreeLink": SetContentTreeLink,
"setSeoTermLink": SetSeoTermLink,
"setSearchTermLink": SetSearchTermLink
}
SetLinkTrackingInfo
Fields
| Input Field | Description |
|---|---|
value - String!
|
Linked Tracking Info |
Example
{"value": "xyz789"}
SetLinkValue
Fields
| Input Field | Description |
|---|---|
openInNewTab - Boolean
|
|
setTarget - SetLinkTargetOperation!
|
|
setUrlParameters - SetUrlParameters
|
|
setLinkTrackingInfo - SetLinkTrackingInfo
|
|
setAnchorLink - SetAnchorLink
|
Example
{
"openInNewTab": true,
"setTarget": SetLinkTargetOperation,
"setUrlParameters": SetUrlParameters,
"setLinkTrackingInfo": SetLinkTrackingInfo,
"setAnchorLink": SetAnchorLink
}
SetLinkedBrandTrackingCode
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SetMaxConditionValue
Fields
| Input Field | Description |
|---|---|
value - Float!
|
Double value |
Example
{"value": 987.65}
SetMaxPerCodeRedeemCount
Description
Set a maxPerCodeRedeemCount
Fields
| Input Field | Description |
|---|---|
value - Int!
|
The maxPerCodeRedeemCount |
Example
{"value": 123}
SetMaxPerUserRedeemCount
Description
Set a maxPerUserRedeemCount
Fields
| Input Field | Description |
|---|---|
value - Int!
|
The maxPerUserRedeemCount |
Example
{"value": 123}
SetMaxSelectableItems
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 123}
SetMcs
Description
A Multichannelselector.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the MCS. |
Example
{"id": 4}
SetMessageKey
Description
Operation to set message key
Fields
| Input Field | Description |
|---|---|
value - String!
|
Message key (an empty key is not allowed) |
Example
{"value": "abc123"}
SetMessageMcs
Description
Operation to set message MultiChannelSelector
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Id of MultiChannelSelector |
Example
{"id": 4}
SetMessageValue
Description
Operation to set translation
Fields
| Input Field | Description |
|---|---|
value - String!
|
Translation |
Example
{"value": "xyz789"}
SetMinConditionValue
Fields
| Input Field | Description |
|---|---|
value - Float!
|
Example
{"value": 123.45}
SetMonetaryAmountConditionValue
Fields
| Input Field | Description |
|---|---|
value - Float!
|
Double amount value |
Example
{"value": 123.45}
SetMonetaryComparisonOperator
Fields
| Input Field | Description |
|---|---|
value - ComparisonOperator!
|
Operators >= or <= |
Example
{"value": "GREATER_THAN_EQ"}
SetMyProfileUserName
Fields
| Input Field | Description |
|---|---|
value - String!
|
New username |
Example
{"value": "xyz789"}
SetName
Fields
| Input Field | Description |
|---|---|
value - String!
|
The name to set |
Example
{"value": "xyz789"}
SetNamedCategoryName
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetNamedImageName
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SetNamedLinkName
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetNamedLinkTitle
Fields
| Input Field | Description |
|---|---|
value - String
|
Example
{"value": "xyz789"}
SetNamedLinkTrackingCode
Fields
| Input Field | Description |
|---|---|
value - String
|
Example
{"value": "xyz789"}
SetNegated
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": true}
SetNextContentNodeId
Fields
| Input Field | Description |
|---|---|
value - ID!
|
Example
{"value": 4}
SetNextNodeId
Fields
| Input Field | Description |
|---|---|
value - ID!
|
Example
{"value": 4}
SetNoAbTestValue
Description
The scenario for which no value should be set.
Fields
| Input Field | Description |
|---|---|
scenarioId - ID!
|
Example
{"scenarioId": "4"}
SetNodeName
Fields
| Input Field | Description |
|---|---|
value - String
|
Example
{"value": "abc123"}
SetNodePositionOperation
Description
Only one both attribute can be used at time.
If you want to add a node between two or above one other node, use the setPreviousNode command. Example:
- NODE1
- NODE-TO-ADD
- NODE2 NODE-TO-ADD should use setPreviousNode(NODE1)
If you want to add as a new child, use the setParentNode command. The child is always ranked at top. Example:
- NODE1
- NODE-TO-ADD NODE-TO-ADD should use setParentNode(NODE1)
If you want to create a category at same level at the first position, use setNextNode command.
- NODE-TO-ADD
- NODE1 NODE-TO-ADD should use setNextNode(NODE1)
If you want to create a category at top level at the first position, use setFirstNode command.
Fields
| Input Field | Description |
|---|---|
setParentNode - SetParentNodeId
|
|
setPreviousNode - SetPreviousNodeId
|
|
setNextNode - SetNextNodeId
|
|
setFirstNode - SetFirstNodeId
|
Example
{
"setParentNode": SetParentNodeId,
"setPreviousNode": SetPreviousNodeId,
"setNextNode": SetNextNodeId,
"setFirstNode": SetFirstNodeId
}
SetNow
Fields
| Input Field | Description |
|---|---|
value - DateTime!
|
Example
{"value": "2007-12-03T10:15:30Z"}
SetNumberOfGeneratedCodes
Description
Set a numberOfGeneratedCodes
Fields
| Input Field | Description |
|---|---|
value - Int!
|
The numberOfGeneratedCodes |
Example
{"value": 123}
SetOnlyOncePerOrder
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": false}
SetOptimized
Description
Optimize the image before saving it
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
The optimized value. Default = false |
Example
{"value": false}
SetOptionValue
Fields
| Input Field | Description |
|---|---|
id - ID
|
Example
{"id": "4"}
SetOptionsValue
Fields
| Input Field | Description |
|---|---|
ids - [ID!]
|
Example
{"ids": ["4"]}
SetOtherRange
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight!
|
Example
{"setWeight": SetIntWeight}
SetOverwriteExistingValue
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": false}
SetPageId
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
SetPageLink
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
SetPageTimeValidity
Description
A page must have a start date or a campaign. If no campaign is set a start date is mandatory.
Fields
| Input Field | Description |
|---|---|
setCampaign - SetCampaign
|
|
setValidityPeriod - SetValidityPeriod
|
Example
{
"setCampaign": SetCampaign,
"setValidityPeriod": SetValidityPeriod
}
SetParameterDescription
Fields
| Input Field | Description |
|---|---|
value - String
|
Example
{"value": "abc123"}
SetParameterType
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
SetParentContentNodeId
Fields
| Input Field | Description |
|---|---|
value - ID!
|
Example
{"value": 4}
SetParentNodeId
Fields
| Input Field | Description |
|---|---|
value - ID!
|
Example
{"value": "4"}
SetPercentageValue
Fields
| Input Field | Description |
|---|---|
value - Float!
|
Example
{"value": 987.65}
SetPersisted
Description
Set Persisted for the touchpoint
Fields
| Input Field | Description |
|---|---|
value - Boolean
|
Persisted. Default = false |
Example
{"value": true}
SetPersonalVoucher
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Personal voucher id |
Example
{"id": "4"}
SetPrefixCode
SetPreviewExportFormat
Description
Input parameters for preview export format
Fields
| Input Field | Description |
|---|---|
setTemplateFormat - SetTemplateFormat!
|
Export preview template format |
Example
{"setTemplateFormat": SetTemplateFormat}
SetPreviousContentNodeId
Fields
| Input Field | Description |
|---|---|
value - ID!
|
Example
{"value": "4"}
SetPreviousNodeId
Fields
| Input Field | Description |
|---|---|
value - ID!
|
Example
{"value": 4}
SetPriceType
Fields
| Input Field | Description |
|---|---|
value - PriceType!
|
Example
{"value": "CURRENT_PRICE"}
SetPriority
Fields
| Input Field | Description |
|---|---|
value - Int!
|
The priority |
Example
{"value": 987}
SetPrivileges
Description
Operation to replace all current privileges of a role/right relation with a set of new privileges
Fields
| Input Field | Description |
|---|---|
values - [Privilege!]!
|
List of privileges to set |
Example
{"values": ["GRANTED"]}
SetProductId
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SetPromotionTimeValidity
Description
Sets the time validity, it can only be a campaign OR a validity range.
Fields
| Input Field | Description |
|---|---|
setCampaign - SetCampaign
|
|
setValidityRange - SetPromotionValidityRange
|
Example
{
"setCampaign": SetCampaign,
"setValidityRange": SetPromotionValidityRange
}
SetPromotionValidityRange
SetReadOnly
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": true}
SetReduced
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": true}
SetRegExp
Fields
| Input Field | Description |
|---|---|
value - String!
|
Regular expression value |
Example
{"value": "xyz789"}
SetRenderingTemplateId
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
SetReplacementList
Description
Input parameters for Replacement list
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
SetRight
Description
Operation to set right of role/right relation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Id of right entity |
Example
{"id": "4"}
SetRole
Description
Operation to set role of user/role relation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Id of role entity |
Example
{"id": 4}
SetRoleRight
Description
Operation to update role/right relation
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Id of role/right relation to update |
ops - [UpdateRoleRightOperation!]!
|
Operations to update role/right relation |
Example
{
"id": EntityId,
"ops": [UpdateRoleRightOperation]
}
SetScenarioFactor
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 123}
SetSchedule
Description
Schedule (one from these commands should be set)
Fields
| Input Field | Description |
|---|---|
setNow - SetNow
|
|
setEveryMinutes - SetEveryMinutes
|
|
setEveryHours - SetEveryHours
|
|
setAlwaysAt - SetAlwaysAt
|
|
setCronExpression - SetCronExpression
|
Example
{
"setNow": SetNow,
"setEveryMinutes": SetEveryMinutes,
"setEveryHours": SetEveryHours,
"setAlwaysAt": SetAlwaysAt,
"setCronExpression": SetCronExpression
}
SetSearchIndexScenarioTrackingCode
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetSearchTermLink
Fields
| Input Field | Description |
|---|---|
term - String!
|
Example
{"term": "xyz789"}
SetSearchTerms
Description
A list of search terms.
Fields
| Input Field | Description |
|---|---|
value - [String!]!
|
The list of search terms. |
Example
{"value": ["xyz789"]}
SetSearchable
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": false}
SetSecondTextConditionValue
Fields
| Input Field | Description |
|---|---|
value - String!
|
Text value for second column |
Example
{"value": "abc123"}
SetSeoCategory
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
SetSeoMainTerm
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": true}
SetSeoTerm
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SetSeoTermLink
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
SetSeoUrl
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetSingleCode
Fields
| Input Field | Description |
|---|---|
value - String!
|
Single voucher code value |
Example
{"value": "abc123"}
SetSmartCategory
Fields
| Input Field | Description |
|---|---|
setBasicSettings - SetBasicSettings!
|
|
setSmartCategorySettings - SetSmartCategorySettings!
|
Example
{
"setBasicSettings": SetBasicSettings,
"setSmartCategorySettings": SetSmartCategorySettings
}
SetSmartCategoryNode
Fields
| Input Field | Description |
|---|---|
setBasicNodeSettings - SetBasicNodeExtendedSettings!
|
|
setNodeInformation - SetSmartCategory!
|
Example
{
"setBasicNodeSettings": SetBasicNodeExtendedSettings,
"setNodeInformation": SetSmartCategory
}
SetSmartCategoryResultLimit
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 987}
SetSmartCategorySettings
Fields
| Input Field | Description |
|---|---|
addSmartCategoryCondition - AddOrSmartCategoryCondition!
|
|
setSkuSort - SetBooleanValueCondition
|
|
setResultLimit - SetSmartCategoryResultLimit
|
Example
{
"addSmartCategoryCondition": AddOrSmartCategoryCondition,
"setSkuSort": SetBooleanValueCondition,
"setResultLimit": SetSmartCategoryResultLimit
}
SetStringListConditionValue
Fields
| Input Field | Description |
|---|---|
value - [String!]!
|
String list |
Example
{"value": ["abc123"]}
SetStringListValue
Fields
| Input Field | Description |
|---|---|
value - [String!]
|
Example
{"value": ["xyz789"]}
SetStringRangeValue
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetStringValue
Fields
| Input Field | Description |
|---|---|
value - String
|
Example
{"value": "abc123"}
SetTab
Fields
| Input Field | Description |
|---|---|
setAttributeTypeId - SetAttributeTypeId!
|
|
setTabValues - [SetTabValue!]
|
Example
{
"setAttributeTypeId": SetAttributeTypeId,
"setTabValues": [SetTabValue]
}
SetTabName
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetTabSearchable
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": false}
SetTabTrackingCode
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SetTabValue
Fields
| Input Field | Description |
|---|---|
setName - SetTabName
|
|
setTrackingCode - SetTabTrackingCode
|
|
setSearchable - SetTabSearchable
|
|
setTimeValidity - SetTimeValidity
|
|
setTeaserAttributes - [SetTeaserAttributes!]
|
Example
{
"setName": SetTabName,
"setTrackingCode": SetTabTrackingCode,
"setSearchable": SetTabSearchable,
"setTimeValidity": SetTimeValidity,
"setTeaserAttributes": [SetTeaserAttributes]
}
SetTemplateFormat
Description
Input parameter for Template format
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetTemplateId
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
SetTextConditionValue
Fields
| Input Field | Description |
|---|---|
value - String!
|
Text value |
Example
{"value": "xyz789"}
SetTimeFormat
Description
Input for updating time format setting of the current user
Fields
| Input Field | Description |
|---|---|
value - String
|
New time format |
Example
{"value": "xyz789"}
SetTimeValidity
Description
Sets the time validity, it can only be a campaign OR a validity range. If the target had a campaign set, it is reset. If the target had start date and/or end date set, it is reset.
Fields
| Input Field | Description |
|---|---|
setCampaign - SetCampaign
|
|
setValidityRange - SetValidityRange
|
Example
{
"setCampaign": SetCampaign,
"setValidityRange": SetValidityRange
}
SetTitle
Description
Set a title tag for the asset.
Fields
| Input Field | Description |
|---|---|
value - String
|
The title tag. |
Example
{"value": "abc123"}
SetToDoubleValue
Fields
| Input Field | Description |
|---|---|
value - Float!
|
Example
{"value": 123.45}
SetToIntValue
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 123}
SetTouchpoint
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Touchpoint id |
Example
{"id": 4}
SetTrackingCode
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetType
Fields
| Input Field | Description |
|---|---|
value - CustomerSegmentType!
|
The customer segment type |
Example
{"value": "BuiltIn"}
SetUrl
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "xyz789"}
SetUrlParameters
Fields
| Input Field | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
SetUser
Description
Operation to set user of user/role relation
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Id of user entity |
Example
{"id": 4}
SetUserEmail
Description
Input for updating the email of the current user
Fields
| Input Field | Description |
|---|---|
value - String!
|
New email |
Example
{"value": "abc123"}
SetUserName
Description
Input for updating the name of the current user
Fields
| Input Field | Description |
|---|---|
value - String!
|
New name |
Example
{"value": "abc123"}
SetUserPassword
Description
Input for updating the password of the current user
Fields
| Input Field | Description |
|---|---|
value - String!
|
New encrypted password |
Example
{"value": "xyz789"}
SetUserTypeConditionValue
Fields
| Input Field | Description |
|---|---|
value - UserType!
|
User type values: UnknownGuest, RecurringGuest, RegisteredUser |
Example
{"value": "UnknownGuest"}
SetValidityPeriod
SetValidityRange
SetWeight
Description
The weight applied to this scenario.
Fields
| Input Field | Description |
|---|---|
value - Float!
|
Example
{"value": 987.65}
SetWidth
Description
A width for the asset format
Fields
| Input Field | Description |
|---|---|
value - Int!
|
The width |
Example
{"value": 987}
SetWinningScenario
Description
An flag that indicates if this scenario is the selected Winning scenario.
Fields
| Input Field | Description |
|---|---|
value - Boolean!
|
Example
{"value": false}
SetWordStem
Description
A word stem for a lemma.
Fields
| Input Field | Description |
|---|---|
value - String!
|
The word stem. |
Example
{"value": "abc123"}
SetXCoordinate
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 123}
SetYCoordinate
Fields
| Input Field | Description |
|---|---|
value - Int!
|
Example
{"value": 987}
SimpleAttributeType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
key - String!
|
|
displayName - String!
|
|
group - AttributeDefinitionGroup!
|
|
abTestable - Boolean!
|
|
customerSegmentsAllowed - Boolean!
|
|
exportable - Boolean!
|
|
linkable - Boolean!
|
indicate whether an attribute can be linked to other object. Linking attribute is used for category and page parameters. |
standard - Boolean!
|
true for standard ishop core attribute and false for shop specific ones |
mandatory - Boolean!
|
indicates whether the value must be present for this type. |
helpText - String
|
|
hasHelpText - Boolean!
|
|
mutationCommandType - String!
|
|
allowedValues - [AllowedValue!]!
|
|
searchable - Boolean!
|
indicates whether the value for this attribute description could be indexed by the content search. |
valueType - AttributeValueType!
|
Example
{
"id": 4,
"version": {},
"key": "abc123",
"displayName": "xyz789",
"group": AttributeDefinitionGroup,
"abTestable": false,
"customerSegmentsAllowed": false,
"exportable": true,
"linkable": true,
"standard": true,
"mandatory": true,
"helpText": "abc123",
"hasHelpText": true,
"mutationCommandType": "abc123",
"allowedValues": [AllowedValue],
"searchable": true,
"valueType": "Text"
}
SimpleCondition
Description
Simple condition object
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the condition. |
version - Long
|
The version of the condition. |
type - DynamicConditionType!
|
Enum represents the condition type |
typeId - ID!
|
Condition description id |
negated - Boolean
|
Boolean for negation |
value - ConditionValue
|
The condition value object |
Example
{
"id": "4",
"version": {},
"type": "Text",
"typeId": "4",
"negated": false,
"value": BooleanConditionValue
}
SimpleConditionType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
description - String
|
|
valueType - DynamicConditionType!
|
Example
{
"id": 4,
"displayName": "xyz789",
"description": "xyz789",
"valueType": "Text"
}
SmartAssistantNode
Types
| Union Types |
|---|
Example
MaintainedPageSmartAssistantNode
SmartAssistantNodeType
Description
Types for child nodes inside roots
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DefaultArticleScoringForCategories"
SmartAssistantRoot
Fields
| Field Name | Description |
|---|---|
name - String
|
Node Name |
isCompleted - Boolean!
|
is Completed |
score - Int!
|
Score, represents number of completed items |
type - SmartAssistantRootType!
|
Root type |
totalScore - Int!
|
Total score, represents number of all items |
children - [SmartAssistantNode!]!
|
Children nodes |
Example
{
"name": "xyz789",
"isCompleted": true,
"score": 123,
"type": "GlobalArticleScoring",
"totalScore": 987,
"children": [MaintainedPageSmartAssistantNode]
}
SmartAssistantRootType
Values
| Enum Value | Description |
|---|---|
|
|
Static root for global article |
|
|
Static root for Main Category Article |
|
|
Content pages |
|
|
Search static root |
Example
"GlobalArticleScoring"
SmartAssistantRoots
Fields
| Field Name | Description |
|---|---|
totalCompletion - Float!
|
Total score 0-100, 100 means complete |
entries - [SmartAssistantRoot!]!
|
Children nodes |
Example
{
"totalCompletion": 987.65,
"entries": [SmartAssistantRoot]
}
SmartCategory
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
mcs - Mcs!
|
|
name - String!
|
|
deleteDate - DateTime
|
The date when the entry will be deleted or null if it won't be deleted |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
|
ancestors - [NavigationTreeEntry!]!
|
|
parent - NavigationTreeEntry
|
|
children - NavigationTreeEntryChildrenPayload!
|
|
Arguments
|
|
valid - Boolean!
|
|
status - CategoryStatus!
|
|
publishStatus - PublishStatus!
|
|
url - String
|
|
previewUrl - String!
|
|
Arguments
|
|
description - String
|
|
invalidReason - String
|
|
timeValidity - TimeValidity!
|
|
timeStatus - TimeValidityStatus!
|
use status attribute instead of timeStatus See: ISBO-15517 |
criteria - SmartCategoryCondition
|
|
overwrittenValue - NavigationTreeEntry
|
|
originalTreeType - TreeType
|
|
paths - [String!]!
|
|
referenceType - PageReferenceType!
|
|
categoryParameters - CategoryParameterFindPayload!
|
|
Arguments
|
|
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"name": "abc123",
"deleteDate": "2007-12-03T10:15:30Z",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"ancestors": [NavigationTreeEntry],
"parent": NavigationTreeEntry,
"children": NavigationTreeEntryChildrenPayload,
"valid": true,
"status": "INVALID",
"publishStatus": "PUBLISHED",
"url": "abc123",
"previewUrl": "xyz789",
"description": "abc123",
"invalidReason": "abc123",
"timeValidity": Campaign,
"timeStatus": "ACTIVE",
"criteria": SmartCategoryCondition,
"overwrittenValue": NavigationTreeEntry,
"originalTreeType": "ArchiveTree",
"paths": ["abc123"],
"referenceType": "NONE",
"categoryParameters": CategoryParameterFindPayload
}
SmartCategoryCondition
SmartCommonFilter
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
values - [SmartCommonFilterValue]!
|
Example
{
"id": 4,
"displayName": "xyz789",
"values": [SmartCommonFilterValue]
}
SmartCommonFilterValue
SmartDoubleRangeFilter
SmartFilter
Possible Types
| SmartFilter Types |
|---|
Example
{
"id": "4",
"displayName": "xyz789"
}
SmartProductCinemaPreviewInput
Fields
| Input Field | Description |
|---|---|
ops - SmartProductCinemaPreviewOperation!
|
|
mcs - McsInput!
|
|
paging - Paging!
|
Example
{
"ops": SmartProductCinemaPreviewOperation,
"mcs": McsInput,
"paging": Paging
}
SmartProductCinemaPreviewOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
add - AddSmartProductCinema
|
|
update - SmartProductCinemaPreviewUpdate
|
Example
{
"add": AddSmartProductCinema,
"update": SmartProductCinemaPreviewUpdate
}
SmartProductCinemaPreviewPayload
Fields
| Field Name | Description |
|---|---|
entries - [SearchResultEntry!]!
|
|
totalCount - Int!
|
Example
{"entries": [SearchResultEntry], "totalCount": 987}
SmartProductCinemaPreviewUpdate
Description
ID OR BOTH
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateSmartProductCinema!]!
|
Example
{
"id": EntityId,
"ops": [UpdateSmartProductCinema]
}
SmartRangePriceFilter
SortOption
Description
Enum Representation of the columns available in search logs.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SEARCH_TERM"
SortOrder
Description
Sort orders
Values
| Enum Value | Description |
|---|---|
|
|
Ascending order |
|
|
Descending order |
Example
"ASC"
SortType
Description
The two ordering directions.
Values
| Enum Value | Description |
|---|---|
|
|
Ascending Sort. |
|
|
Descending Sort. |
Example
"ASC"
SpecialPriceBenefitEntity
Description
Representation of a special price benefit
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the benefit. |
version - Long!
|
The version of the benefit. |
title - String
|
The maintained title of the benefit |
image - ImageEntity
|
The maintained image for the benefit |
itemIds - [String!]!
|
The selectable items of the benefit |
max - Int!
|
The max selectable for this benefit |
Example
{
"id": "4",
"version": {},
"title": "xyz789",
"image": ImageEntity,
"itemIds": ["xyz789"],
"max": 987
}
SpecialRasterPage
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
name - String!
|
|
valid - Boolean!
|
|
mcs - Mcs!
|
|
isLandingPage - Boolean!
|
|
contentTreeNodeEntity - ContentTreeNode
|
The belonging content tree node. Only present if page is a content tree |
referenceType - PageReferenceType!
|
Example
{
"id": 4,
"version": {},
"name": "xyz789",
"valid": false,
"mcs": Mcs,
"isLandingPage": false,
"contentTreeNodeEntity": ContentTreeNode,
"referenceType": "NONE"
}
SpecialRightEntity
Description
User right for special permissions like read right for object storage browser
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Id of entity |
version - Long!
|
Version of entity |
name - String!
|
Name of right |
privileges - [Privilege!]!
|
List of allowed privileges for this right |
rightType - RightType!
|
Type of right (SPECIAL) |
parentId - ID
|
Id of parent entity |
rightGroup - RightGroupEntity
|
Right group entity |
parent - Boolean!
|
Flag to indicate whether this right is shown on parent mcss or not |
Example
{
"id": "4",
"version": {},
"name": "xyz789",
"privileges": ["GRANTED"],
"rightType": "MENU",
"parentId": 4,
"rightGroup": RightGroupEntity,
"parent": true
}
StaticContentAssetEntity
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the entity. |
version - Long!
|
The version of the entity. |
name - String!
|
File name |
mcs - Mcs!
|
Shop which this image was uploaded to |
contentType - String
|
File type (e.g. png/pdf/zip, ...etc) |
assetCategory - AssetCategory
|
Enum for Asset type to be used in icon rendering |
size - Long
|
File size in bytes (after optimization). in the first upload it will be equal to originalSize |
keywords - [String!]!
|
List of keywords |
url - String
|
URL for files |
uploadedDate - DateTime
|
The first time this file was uploaded |
lastModified - DateTime
|
The time this file was edited/updated |
uploadedUser - UserInformation
|
The user who uploaded this file |
editedUser - UserInformation
|
The last user who edited/updated this file |
assetType - AssetType
|
Enum represents the actual Asset types |
indexHtmlFileContent - String
|
The content of the index html file included in the zip file |
Example
{
"id": "4",
"version": {},
"name": "xyz789",
"mcs": Mcs,
"contentType": "xyz789",
"assetCategory": "IMAGE",
"size": {},
"keywords": ["abc123"],
"url": "xyz789",
"uploadedDate": "2007-12-03T10:15:30Z",
"lastModified": "2007-12-03T10:15:30Z",
"uploadedUser": UserInformation,
"editedUser": UserInformation,
"assetType": "BINARY_IMAGE",
"indexHtmlFileContent": "abc123"
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
StringLabelValue
StringListConditionValue
Fields
| Field Name | Description |
|---|---|
value - [String!]!
|
Example
{"value": ["xyz789"]}
StringListValue
Fields
| Field Name | Description |
|---|---|
stringList - [String!]!
|
Example
{"stringList": ["abc123"]}
StringValue
Fields
| Field Name | Description |
|---|---|
string - String!
|
Example
{"string": "abc123"}
Synonym
Description
A full synonym or antonym.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this synonym. |
version - Long!
|
The version of this synonym. |
inherited - Boolean
|
A flag if this synonym was inherited from a higher MCS. |
mcs - Mcs!
|
The MCS to this synonym. |
synonymGroups - [SynonymGroup]!
|
A list of synonym groups in this synonym. |
Example
{
"id": 4,
"version": {},
"inherited": true,
"mcs": Mcs,
"synonymGroups": [SynonymGroup]
}
SynonymDirection
Description
Enum representation of the direction of a synonym or antonym.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DIRECTED"
SynonymFilter
Description
Filter information about a synonym or antonym group.
Fields
| Input Field | Description |
|---|---|
direction - [SynonymDirection]
|
Is this a synonym, directed synonym or antonym? |
fromSynonyms - [String]
|
A list of words that in directed synonyms represent the source word. |
toSynonyms - [String]
|
A second list of words that in directed synonyms represent the target words. In undirected synonyms and antonyms this list is switchable with fromSynonyms. |
weight - Int
|
The weight downgrade in percent with which this synonym replacement is associated. Higher weights result in less probable synonyms. |
Example
{
"direction": ["DIRECTED"],
"fromSynonyms": ["xyz789"],
"toSynonyms": ["abc123"],
"weight": 123
}
SynonymGroup
Description
A single synonymgroup of synonyms or antonyms.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this synonym group. |
version - Long!
|
The version of this synonym group. |
mcs - Mcs!
|
The MCS to this synonym group. |
overridden - Boolean!
|
A flag telling if this synonymgroup is overridden by a different synonym group. |
direction - SynonymDirection!
|
Is this a synonym, directed synonym or antonym? |
weight - Int!
|
The weight downgrade in percent with which this synonym replacement is associated. |
fromSynonyms - [String!]!
|
A list of words that in directed synonyms represent the source word. |
toSynonyms - [String!]!
|
A second list of words that in directed synonyms represent the target words. In undirected synonyms and antonyms this list is switchable with fromSynonyms. |
Example
{
"id": 4,
"version": {},
"mcs": Mcs,
"overridden": false,
"direction": "DIRECTED",
"weight": 123,
"fromSynonyms": ["abc123"],
"toSynonyms": ["xyz789"]
}
SynonymGroupInput
Description
Description of a synonym or antonym.
Fields
| Input Field | Description |
|---|---|
id - ID
|
The ID of this synonym or antonym group. |
version - Long
|
The version of this synonym or antonym. |
synonymId - Long
|
The ID of this synonym or antonym. |
mcsInput - McsInput!
|
The mcs for the synonym group |
direction - SynonymDirection!
|
The choice if this is a synonym, directed synonym or an antonym. |
fromSynonyms - [String!]!
|
A list of words that in directed synonyms represent the source word. |
toSynonyms - [String!]!
|
A second list of words that in directed synonyms represent the target words. In undirected synonyms and antonyms this list is switchable with fromSynonyms. |
weight - Int!
|
The weight downgrade in percent with which this synonym replacement is associated. Higher weights result in less probable synonyms. If 0, it will be set to default defined in bo_configuration. Default = 0 |
Example
{
"id": "4",
"version": {},
"synonymId": {},
"mcsInput": McsInput,
"direction": "DIRECTED",
"fromSynonyms": ["abc123"],
"toSynonyms": ["abc123"],
"weight": 987
}
SynonymPaging
Description
Paging and sorting information.
Fields
| Input Field | Description |
|---|---|
sortOrder - SynonymSortOrder!
|
Decides by which column the synonyms or antonyms should be sorted. Default = DESC_INFO |
limit - Int
|
Limit of results per page. Default: 100. Default = 100 |
offset - Int
|
Offset of results that should be skipped. Default: 0. Default = 0 |
Example
{"sortOrder": "FROM_SYNONYMS", "limit": 123, "offset": 987}
SynonymSearchInput
Description
Paging and filter information for synonyms or antonyms.
Fields
| Input Field | Description |
|---|---|
paging - SynonymPaging!
|
Paging information. |
filter - SynonymFilter
|
Additional filters. |
searchTerm - String
|
The search term to find in the two sides of the possible synonyms or antonyms. |
mcsInput - McsInput!
|
The mcs for the search. |
Example
{
"paging": SynonymPaging,
"filter": SynonymFilter,
"searchTerm": "abc123",
"mcsInput": McsInput
}
SynonymSortOrder
Description
An enum representation of the sort order possibilities for synonyms.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Sorts by inherited mcs, with entries of the current mcs always at the bottom. Sorting within the mcs entries is by name lexicographical ascending. |
|
|
Example
"FROM_SYNONYMS"
Synonyms
Description
A list of synonyms or antonyms.
Fields
| Field Name | Description |
|---|---|
elements - [Synonym]!
|
The list of synonyms or antonyms. Affected by paging. |
totalCount - Int!
|
The total count of results, unaffected by paging. |
Example
{"elements": [Synonym], "totalCount": 987}
SynonymsForSearchTerm
Fields
| Field Name | Description |
|---|---|
searchTerm - String!
|
|
synonyms - [AiGeneratedSynonym!]!
|
Example
{
"searchTerm": "xyz789",
"synonyms": [AiGeneratedSynonym]
}
Tab
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
TabId |
name - String
|
|
trackingCode - String
|
|
searchable - Boolean!
|
|
values - [DynamicTeaserAttribute!]!
|
|
mcs - Mcs!
|
|
contentName - String!
|
|
pageType - PageReferenceType!
|
|
customerSegments - [CustomerSegment!]!
|
|
timeValidity - TimeValidity!
|
Example
{
"id": 4,
"version": {},
"name": "xyz789",
"trackingCode": "abc123",
"searchable": true,
"values": [DynamicTeaserAttribute],
"mcs": Mcs,
"contentName": "xyz789",
"pageType": "NONE",
"customerSegments": [CustomerSegment],
"timeValidity": Campaign
}
TabAttributeType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
version - Long!
|
|
key - String!
|
|
displayName - String!
|
|
group - AttributeDefinitionGroup!
|
|
abTestable - Boolean!
|
|
customerSegmentsAllowed - Boolean!
|
|
exportable - Boolean!
|
|
linkable - Boolean!
|
indicate whether an attribute can be linked to other object. Linking attribute is used for category and page parameters. |
standard - Boolean!
|
true for standard ishop core attribute and false for shop specific ones |
mandatory - Boolean!
|
indicates whether the value must be present for this type. |
helpText - String
|
|
hasHelpText - Boolean!
|
|
mutationCommandType - String!
|
|
allowedValues - [AllowedValue!]!
|
|
children - [AttributeDescriptionType!]!
|
|
searchable - Boolean!
|
indicates whether the value for this attribute description could be indexed by the content search. |
valueType - AttributeValueType!
|
Example
{
"id": 4,
"version": {},
"key": "abc123",
"displayName": "abc123",
"group": AttributeDefinitionGroup,
"abTestable": true,
"customerSegmentsAllowed": false,
"exportable": false,
"linkable": true,
"standard": false,
"mandatory": false,
"helpText": "abc123",
"hasHelpText": false,
"mutationCommandType": "abc123",
"allowedValues": [AllowedValue],
"children": [AttributeDescriptionType],
"searchable": false,
"valueType": "Text"
}
Tabs
Description
TYPES
Fields
| Field Name | Description |
|---|---|
tabs - [Tab!]!
|
Example
{"tabs": [Tab]}
TagCloudListValue
Fields
| Field Name | Description |
|---|---|
tagClouds - [TagCloudValue!]!
|
Example
{"tagClouds": [TagCloudValue]}
TagCloudValue
Fields
| Field Name | Description |
|---|---|
priority - Int!
|
|
name - String!
|
|
link - AttributeLink!
|
|
title - String
|
|
trackingInfo - String
|
Example
{
"priority": 123,
"name": "abc123",
"link": ArticleLink,
"title": "xyz789",
"trackingInfo": "abc123"
}
TakeAndPayBenefitEntity
Description
Representation of a Take & Pay benefit e.g. Take 3 and get 1 for free.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the benefit. |
version - Long!
|
The version of the benefit. |
title - String
|
The maintained title of the benefit |
image - ImageEntity
|
The maintained image for the benefit |
benefitTarget - BenefitTarget!
|
Benefit target type |
youTake - Int!
|
Amount of items you take |
youPay - Int!
|
Amount of items you must pay for |
oncePerOrder - Boolean!
|
Benefit is applicable once per order? |
Example
{
"id": 4,
"version": {},
"title": "xyz789",
"image": ImageEntity,
"benefitTarget": "ITEM",
"youTake": 123,
"youPay": 123,
"oncePerOrder": false
}
TemplateTypeFilterInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Example
{"name": "abc123"}
TemplateTypeFindPayload
Fields
| Field Name | Description |
|---|---|
entries - [TeaserTemplate!]!
|
|
totalCount - Int!
|
Example
{"entries": [TeaserTemplate], "totalCount": 987}
TemplateTypePagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
|
sortOn - TemplateTypeSortingInput!
|
Example
{
"paging": Paging,
"sortOn": TemplateTypeSortingInput
}
TemplateTypeSortColumn
Values
| Enum Value | Description |
|---|---|
|
|
Example
"NAME"
TemplateTypeSortingInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
|
sortType - TemplateTypeSortColumn!
|
Example
{"sortOrder": "ASC", "sortType": "NAME"}
TextConditionValue
Fields
| Field Name | Description |
|---|---|
value - String!
|
Example
{"value": "abc123"}
TimeSeriesValue
TimeSort
Fields
| Input Field | Description |
|---|---|
order - Order!
|
Example
{"order": "ASC"}
TimeValidity
TimeValidityFilter
Fields
| Input Field | Description |
|---|---|
value - [TimeValidityStatus!]!
|
Example
{"value": ["ACTIVE"]}
TimeValidityStatus
Description
Life cycle status
Values
| Enum Value | Description |
|---|---|
|
|
Currently active |
|
|
No longer active |
|
|
Not yet active |
Example
"ACTIVE"
TimelineEvent
Example
InheritedTimelineEvent
TouchPoint
Description
Representation of an existing TouchPoint.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of this TouchPoint. |
version - Long!
|
The version of the TouchPoint. |
name - String!
|
The description of this TouchPoint. |
mcs - Mcs!
|
Shop which this touchpoint was added to |
description - String
|
The description of this TouchPoint. |
persisted - Boolean!
|
Persisted means it will be saved to datastore |
conditions - ComplexCondition!
|
Touchpoint conditions |
deleted - Boolean!
|
A flag telling if this touchpoint is deleted. |
brokenInheritanceFrom - Long
|
Reference to original row, which was broken from |
Example
{
"id": "4",
"version": {},
"name": "xyz789",
"mcs": Mcs,
"description": "xyz789",
"persisted": false,
"conditions": ComplexCondition,
"deleted": false,
"brokenInheritanceFrom": {}
}
TouchPointFilter
TouchPointPagingInput
Description
All relevant information needed to conduct a search
Fields
| Input Field | Description |
|---|---|
pagingInput - Paging!
|
Paging information Default return 100 entries from start. Default = {limit: 100, offset: 0} |
sortInput - TouchPointSortingInput!
|
Sorting information Default Ascending on campaign name. Default = {sortOrder: DESC, sortColumn: INFO} |
Example
{
"pagingInput": Paging,
"sortInput": TouchPointSortingInput
}
TouchPointPayload
Fields
| Field Name | Description |
|---|---|
entries - [TouchPoint!]!
|
Result of touchPoints |
totalCount - Int!
|
Total number of all assets |
Example
{"entries": [TouchPoint], "totalCount": 987}
TouchPointSortColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"INFO"
TouchPointSortingInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
list order value (default order is DESC). Default = DESC |
sortColumn - TouchPointSortColumn!
|
Column names which are allowed to search for. Default = INFO |
Example
{"sortOrder": "ASC", "sortColumn": "INFO"}
TouchPointTestingInput
TransformToAntiHero
Fields
| Input Field | Description |
|---|---|
articleIdentifier - [Article_ID!]!
|
Example
{"articleIdentifier": [Article_ID]}
TransformToHero
Fields
| Input Field | Description |
|---|---|
articleIdentifier - [Article_ID!]!
|
Example
{"articleIdentifier": [Article_ID]}
Transformation
Description
A single transformation transforming a string.
Example
{
"detailType": "xyz789",
"detailValue": 123.45
}
Translation
Description
Translation for single MultiChannelSelector
Fields
| Field Name | Description |
|---|---|
id - ID
|
Id of entity |
version - Long
|
Version of entity |
messageKey - String!
|
Message key of translation |
messageValue - String
|
Translation |
mcs - BoMcs!
|
MultiChannelSelector of translation |
fallback - String
|
Fallback of translation |
source - TranslationSource
|
Source of translation (property file or database) |
resettable - Boolean!
|
True, if translation could be reset |
messageType - MessageType!
|
Type of translation (for shop or for backoffice) |
Example
{
"id": "4",
"version": {},
"messageKey": "abc123",
"messageValue": "xyz789",
"mcs": BoMcs,
"fallback": "xyz789",
"source": "PROPERTYFILE",
"resettable": false,
"messageType": "SHOP"
}
TranslationCreatePayload
Description
Result of creation of translations
Fields
| Field Name | Description |
|---|---|
entries - [Translations!]!
|
List of created translations with translations in covered mcss |
Example
{"entries": [Translations]}
TranslationDeletePayload
Description
Result of deletion of translations
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Always true |
entries - [Translations!]!
|
List of deleted translations with translations in covered mcss |
Example
{"successful": true, "entries": [Translations]}
TranslationDetailsInput
TranslationFilterInput
Description
MultiChannelSelector, message key and filter type to filter translations
Fields
| Input Field | Description |
|---|---|
mcsIds - [ID!]
|
List of MultiChannelSelector ids |
searchTerms - [String!]
|
Parts of message key or value that should be filtered |
filterTypes - [TranslationsFilterType!]
|
Type to filter duplicates or empty translations |
Example
{
"mcsIds": ["4"],
"searchTerms": ["abc123"],
"filterTypes": ["ONLY_EMPTY"]
}
TranslationFindPayload
Description
Shop translations including total count
Fields
| Field Name | Description |
|---|---|
entries - [Translations!]!
|
List of shop translations |
totalCount - Int!
|
Number of found translations (one per message key) |
Example
{"entries": [Translations], "totalCount": 123}
TranslationPagingInput
Description
Sort order/type, limit and offset of results
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
Limit and offset Default: 100 (limit) and 0 (offset). Default = {limit: 100, offset: 0} |
sortOn - TranslationSortInput!
|
Sort order Default: ascending by name. Default = {sortOrder: ASC, sort: NAME} |
Example
{
"paging": Paging,
"sortOn": TranslationSortInput
}
TranslationSort
Description
Sorting types for translations
Values
| Enum Value | Description |
|---|---|
|
|
Sorting by name |
Example
"NAME"
TranslationSortInput
Description
Sort order and type
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
Sort order Default: ascending. Default = ASC |
sort - TranslationSort!
|
Sort type Default: by name. Default = NAME |
Example
{"sortOrder": "ASC", "sort": "NAME"}
TranslationSource
Description
Source translation (property file or database)
Values
| Enum Value | Description |
|---|---|
|
|
Translation is maintained in property file |
|
|
Translation is maintained in database |
Example
"PROPERTYFILE"
TranslationUpdatePayload
Description
Result of update of translations
Fields
| Field Name | Description |
|---|---|
entries - [Translations!]!
|
List of updated translations with translations in covered mcss |
Example
{"entries": [Translations]}
Translations
Description
Shop translation for single message key
Fields
| Field Name | Description |
|---|---|
messageKey - String!
|
The message key of translation |
translations - [Translation!]!
|
Translation for all requested MultiChannelSelectors |
Example
{
"messageKey": "abc123",
"translations": [Translation]
}
TranslationsFilterType
Description
Types to filter for duplicates or empty translations
Values
| Enum Value | Description |
|---|---|
|
|
Filter for translations with at least one MultiChannelSelector without translation |
|
|
Filter for translations with same translation for at least two MultiChannelSelectors |
Example
"ONLY_EMPTY"
TranslationsForInput
Fields
| Field Name | Description |
|---|---|
identifier - String!
|
|
translations - [AiGeneratedTranslation!]!
|
Example
{
"identifier": "abc123",
"translations": [AiGeneratedTranslation]
}
TreeType
Description
represents the different Interfaces of Navigationentries
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ArchiveTree"
UnassignAbTestInput
Fields
| Input Field | Description |
|---|---|
navigationTreeEntry - ID!
|
"The id of the navigationTreeEntry where the A/B-Test should be unassigned. |
abTestId - ID!
|
"The id of the A/B-Test to be unassigned. |
keepControlGrid - Boolean!
|
"Flag for controlling if any grid assigned to the control group of the A/B-Test should be kept or not. Default = false |
Example
{
"navigationTreeEntry": "4",
"abTestId": 4,
"keepControlGrid": true
}
UnknownItem
Fields
| Field Name | Description |
|---|---|
articleNumber - String!
|
Example
{"articleNumber": "xyz789"}
UpdateAbTestInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
AbTest ID |
ops - [UpdateAbTestOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateAbTestOperation]
}
UpdateAbTestOperation
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
A name for the Abtest. |
setValidityPeriod - SetABTestValidityPeriod
|
Start and End date of this Abtest |
addScenarios - [CreateAbTestScenarioInput!]
|
A List of additional Scenarios to add to this Abtest |
updateScenarios - [UpdateAbTestScenarioInput!]
|
A List of additional Scenarios to be updated to this Abtest |
removeScenarios - [RemoveAbTestScenarioInput!]
|
A List of additional Scenarios to be removed to this Abtest |
setDescription - SetDescription
|
A description for the AbTest |
setHypothesis - SetHypothesis
|
A Hypothesis for the AbTest |
Example
{
"setName": SetName,
"setValidityPeriod": SetABTestValidityPeriod,
"addScenarios": [CreateAbTestScenarioInput],
"updateScenarios": [UpdateAbTestScenarioInput],
"removeScenarios": [RemoveAbTestScenarioInput],
"setDescription": SetDescription,
"setHypothesis": SetHypothesis
}
UpdateAbTestScenarioInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
AbTest ID |
ops - [UpdateAbTestScenarioOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateAbTestScenarioOperation]
}
UpdateAbTestScenarioOperation
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
The name of this scenario |
setWeight - SetWeight
|
The weight applied to this scenario. |
setAbTestTrackingCode - SetAbTestTrackingCode
|
An optional tracking code for this scenario. |
setDefault - SetDefault
|
A flag that indicates if this is the default scenario |
setWinningScenario - SetWinningScenario
|
Set The Winning Scenario |
Example
{
"setName": SetName,
"setWeight": SetWeight,
"setAbTestTrackingCode": SetAbTestTrackingCode,
"setDefault": SetDefault,
"setWinningScenario": SetWinningScenario
}
UpdateAndCondition
Description
Update AND condition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
AND Entity Id |
ops - [UpdateAndConditionOperation!]!
|
List of complex AND condition operations to be updated |
Example
{
"id": EntityId,
"ops": [UpdateAndConditionOperation]
}
UpdateAndConditionOperation
Description
Update AND condition operations. One of these operations will be used
Fields
| Input Field | Description |
|---|---|
addSimpleConditions - [AddSimpleCondition!]
|
Add simple condition to existing AND condition |
updateSimpleConditions - [UpdateSimpleCondition!]
|
Update simple Condition |
removeSimpleConditions - [RemoveCondition!]
|
Delete simple Condition |
Example
{
"addSimpleConditions": [AddSimpleCondition],
"updateSimpleConditions": [UpdateSimpleCondition],
"removeSimpleConditions": [RemoveCondition]
}
UpdateArchive
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DELETE"
UpdateArticleIgnoreListInput
Description
Input parameters for Updating Article Ignore List
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Article Ignore List ID |
ops - [UpdateArticleIgnoreListOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateArticleIgnoreListOperation]
}
UpdateArticleIgnoreListOperation
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
Rename list |
setGranularity - SetGranularity
|
Update Granularity |
addArticles - [AddArticleIgnoreElement!]
|
Add new article to ignored articles list |
removeArticles - [RemoveArticleIgnoreList!]
|
Ignored article that will be removed from the ignore list |
Example
{
"setName": SetName,
"setGranularity": SetGranularity,
"addArticles": [AddArticleIgnoreElement],
"removeArticles": [RemoveArticleIgnoreList]
}
UpdateArticleListScoreCard
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
updateDirectValueCard - UpdateArticleListScoreCardDirectValue
|
|
updateBooleanCard - UpdateArticleListScoreCardBoolean
|
|
updateCategoryCard - UpdateArticleListScoreCardCategory
|
|
updateBrandCard - UpdateArticleListScoreCardBrand
|
|
updateDoubleCard - UpdateArticleListScoreCardDouble
|
|
updateIntCard - UpdateArticleListScoreCardInt
|
|
updateStringCard - UpdateArticleListScoreCardString
|
Example
{
"updateDirectValueCard": UpdateArticleListScoreCardDirectValue,
"updateBooleanCard": UpdateArticleListScoreCardBoolean,
"updateCategoryCard": UpdateArticleListScoreCardCategory,
"updateBrandCard": UpdateArticleListScoreCardBrand,
"updateDoubleCard": UpdateArticleListScoreCardDouble,
"updateIntCard": UpdateArticleListScoreCardInt,
"updateStringCard": UpdateArticleListScoreCardString
}
UpdateArticleListScoreCardBoolean
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateArticleListScoreCardBooleanOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateArticleListScoreCardBooleanOperation]
}
UpdateArticleListScoreCardBooleanOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight
|
|
setBoolean - SetArticleListScoreCardBooleanValue
|
Example
{
"setWeight": SetIntWeight,
"setBoolean": SetArticleListScoreCardBooleanValue
}
UpdateArticleListScoreCardBrand
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateArticleListScoreCardBrandOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateArticleListScoreCardBrandOperation]
}
UpdateArticleListScoreCardBrandOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight
|
|
setOtherRange - SetOtherRange
|
|
addBrandRange - [AddBrandRange!]
|
|
updateBrandRange - [UpdateBrandeRange!]
|
|
removeBrandRange - [RemoveRange!]
|
Example
{
"setWeight": SetIntWeight,
"setOtherRange": SetOtherRange,
"addBrandRange": [AddBrandRange],
"updateBrandRange": [UpdateBrandeRange],
"removeBrandRange": [RemoveRange]
}
UpdateArticleListScoreCardCategory
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateArticleListScoreCardCategoryOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateArticleListScoreCardCategoryOperation]
}
UpdateArticleListScoreCardCategoryOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight
|
|
setOtherRange - SetOtherRange
|
|
addCategoryRange - [AddCategoryRange!]
|
|
updateCategoryRange - [UpdateCategoryRange!]
|
|
removeCategoryRange - [RemoveRange!]
|
Example
{
"setWeight": SetIntWeight,
"setOtherRange": SetOtherRange,
"addCategoryRange": [AddCategoryRange],
"updateCategoryRange": [UpdateCategoryRange],
"removeCategoryRange": [RemoveRange]
}
UpdateArticleListScoreCardDirectValue
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateArticleListScoreCardDirectValueOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateArticleListScoreCardDirectValueOperation]
}
UpdateArticleListScoreCardDirectValueOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight!
|
Example
{"setWeight": SetIntWeight}
UpdateArticleListScoreCardDouble
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateArticleListScoreCardDoubleOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateArticleListScoreCardDoubleOperation]
}
UpdateArticleListScoreCardDoubleOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight
|
|
setOtherRange - SetOtherRange
|
|
addDoubleRange - [AddDoubleRange!]
|
|
updateDoubleRange - [UpdateDoubleRange!]
|
|
removeDoubleRange - [RemoveRange!]
|
Example
{
"setWeight": SetIntWeight,
"setOtherRange": SetOtherRange,
"addDoubleRange": [AddDoubleRange],
"updateDoubleRange": [UpdateDoubleRange],
"removeDoubleRange": [RemoveRange]
}
UpdateArticleListScoreCardInt
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateArticleListScoreCardIntOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateArticleListScoreCardIntOperation]
}
UpdateArticleListScoreCardIntOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight
|
|
setOtherRange - SetOtherRange
|
|
addIntRange - [AddIntRange!]
|
|
updateIntRange - [UpdateIntRange!]
|
|
removeIntRange - [RemoveRange!]
|
Example
{
"setWeight": SetIntWeight,
"setOtherRange": SetOtherRange,
"addIntRange": [AddIntRange],
"updateIntRange": [UpdateIntRange],
"removeIntRange": [RemoveRange]
}
UpdateArticleListScoreCardString
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateArticleListScoreCardStringOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateArticleListScoreCardStringOperation]
}
UpdateArticleListScoreCardStringOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight
|
|
setOtherRange - SetOtherRange
|
|
addStringRange - [AddStringRange!]
|
|
updateStringRange - [UpdateStringRange!]
|
|
removeStringRange - [RemoveRange!]
|
Example
{
"setWeight": SetIntWeight,
"setOtherRange": SetOtherRange,
"addStringRange": [AddStringRange],
"updateStringRange": [UpdateStringRange],
"removeStringRange": [RemoveRange]
}
UpdateArticleListScoreInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateArticleListScoreOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateArticleListScoreOperation]
}
UpdateArticleListScoreOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
|
addCard - [AddArticleListScoreCard!]
|
|
updateCard - [UpdateArticleListScoreCard!]
|
|
removeCard - [RemoveArticleListScoreCard!]
|
Example
{
"setName": SetName,
"addCard": [AddArticleListScoreCard],
"updateCard": [UpdateArticleListScoreCard],
"removeCard": [RemoveArticleListScoreCard]
}
UpdateAssetFormatInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Asset id |
ops - [UpdateAssetFormatOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateAssetFormatOperation]
}
UpdateAssetFormatOperation
UpdateAssetInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Asset id |
ops - [UpdateAssetOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateAssetOperation]
}
UpdateAssetOperation
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
Asset name |
setMcs - SetMcs
|
Asset mcs |
setKeywords - SetKeywords
|
Asset Keywords |
setImportedId - SetImportedId
|
Asset imported id inside cached bytes |
Example
{
"setName": SetName,
"setMcs": SetMcs,
"setKeywords": SetKeywords,
"setImportedId": SetImportedId
}
UpdateAssetTags
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
ID of the AssetTagsEntity |
ops - [UpdateAssetTagsOperation!]
|
Update Operations |
Example
{
"id": EntityId,
"ops": [UpdateAssetTagsOperation]
}
UpdateAssetTagsOperation
Fields
| Input Field | Description |
|---|---|
setTitle - SetTitle
|
The title tag |
setAlt - SetAlt
|
The alt tag |
setAssetTagsDefaultLanguage - SetAssetTagsDefaultLanguage
|
Indicates if these are the default values |
Example
{
"setTitle": SetTitle,
"setAlt": SetAlt,
"setAssetTagsDefaultLanguage": SetAssetTagsDefaultLanguage
}
UpdateBasicSettingsOperation
Description
UDPATE
Fields
| Input Field | Description |
|---|---|
setBasicSettingsName - SetBasicSettingsName
|
|
setBasicSettingsUrl - SetBasicSettingsUrl
|
|
setBasicSettingsDescription - SetBasicSettingsDescription
|
|
setTimeValidity - SetPageTimeValidity
|
Example
{
"setBasicSettingsName": SetBasicSettingsName,
"setBasicSettingsUrl": SetBasicSettingsUrl,
"setBasicSettingsDescription": SetBasicSettingsDescription,
"setTimeValidity": SetPageTimeValidity
}
UpdateBenefit
Description
This command allows only one benefit to be added each time
Fields
| Input Field | Description |
|---|---|
updateDiscountAmountBenefit - UpdateDiscountAmountBenefit
|
|
updateDiscountPercentBenefit - UpdateDiscountPercentBenefit
|
|
updateDiscountPercentOnCheapestItemBenefit - UpdateDiscountPercentOnCheapestItemBenefit
|
|
updateDiscountPercentOnMostExpensiveItemBenefit - UpdateDiscountPercentOnMostExpensiveItemBenefit
|
|
updateTakeAndPayBenefit - UpdateTakeAndPayBenefit
|
|
updateFreeShippingBenefit - UpdateFreeShippingBenefit
|
|
updateInformativeBenefit - UpdateInformativeBenefit
|
|
updateFreeItemBenefit - UpdateFreeItemBenefit
|
|
updateSpecialPriceBenefit - UpdateSpecialPriceBenefit
|
Example
{
"updateDiscountAmountBenefit": UpdateDiscountAmountBenefit,
"updateDiscountPercentBenefit": UpdateDiscountPercentBenefit,
"updateDiscountPercentOnCheapestItemBenefit": UpdateDiscountPercentOnCheapestItemBenefit,
"updateDiscountPercentOnMostExpensiveItemBenefit": UpdateDiscountPercentOnMostExpensiveItemBenefit,
"updateTakeAndPayBenefit": UpdateTakeAndPayBenefit,
"updateFreeShippingBenefit": UpdateFreeShippingBenefit,
"updateInformativeBenefit": UpdateInformativeBenefit,
"updateFreeItemBenefit": UpdateFreeItemBenefit,
"updateSpecialPriceBenefit": UpdateSpecialPriceBenefit
}
UpdateBinaryImageInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Asset id |
ops - [UpdateBinaryImageOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateBinaryImageOperation]
}
UpdateBinaryImageOperation
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
Asset name |
setMcs - SetMcs
|
Asset mcs |
setAlt - SetAlt
|
Asset alt tag |
setTitle - SetTitle
|
Asset title tag |
createAssetTags - CreateAssetTags
|
Create new AssetTags for this image |
updateAssetTags - UpdateAssetTags
|
Update existing AssetTags for this image |
setKeywords - SetKeywords
|
Asset Keywords |
setImportedId - SetImportedId
|
Asset imported id inside cached bytes |
Example
{
"setName": SetName,
"setMcs": SetMcs,
"setAlt": SetAlt,
"setTitle": SetTitle,
"createAssetTags": CreateAssetTags,
"updateAssetTags": UpdateAssetTags,
"setKeywords": SetKeywords,
"setImportedId": SetImportedId
}
UpdateBooleanDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateBooleanDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateBooleanDynamicConditionOperation]
}
UpdateBooleanDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setBoolean - SetBooleanConditionValue
|
Boolean condition |
Example
{
"setNegated": SetNegated,
"setBoolean": SetBooleanConditionValue
}
UpdateBrandCategory
Fields
| Input Field | Description |
|---|---|
setBasicSettingsUrl - SetBasicSettingsUrl
|
|
setBasicSettingsDescription - SetBasicSettingsDescription
|
|
setTimeValidity - SetPageTimeValidity
|
|
setLimitValue - SetBrandCategoryLimitValue
|
|
setDepthValue - SetBrandCategoryDepthValue
|
|
addNamedBrandCategorySources - [AddNamedBrandCategorySource!]
|
|
updateNamedBrandCategorySource - [UpdateNamedBrandCategorySourceInput!]
|
|
removeNamedBrandCategorySources - [RemoveNamedBrandCategorySources!]
|
|
addBlocklistedBrands - [AddBlocklistedBrand!]
|
|
removeBlocklistedBrands - [RemoveBlocklistedBrand!]
|
Example
{
"setBasicSettingsUrl": SetBasicSettingsUrl,
"setBasicSettingsDescription": SetBasicSettingsDescription,
"setTimeValidity": SetPageTimeValidity,
"setLimitValue": SetBrandCategoryLimitValue,
"setDepthValue": SetBrandCategoryDepthValue,
"addNamedBrandCategorySources": [
AddNamedBrandCategorySource
],
"updateNamedBrandCategorySource": [
UpdateNamedBrandCategorySourceInput
],
"removeNamedBrandCategorySources": [
RemoveNamedBrandCategorySources
],
"addBlocklistedBrands": [AddBlocklistedBrand],
"removeBlocklistedBrands": [RemoveBlocklistedBrand]
}
UpdateBrandCategoryChildOperation
Fields
| Input Field | Description |
|---|---|
setBasicNodeSettings - SetBasicNodeSettings
|
Example
{"setBasicNodeSettings": SetBasicNodeSettings}
UpdateBrandCategoryOperation
Fields
| Input Field | Description |
|---|---|
setBasicNodeSettings - SetBasicNodeExtendedSettings
|
|
updateBrandCategory - UpdateBrandCategory
|
|
updateArchive - UpdateArchive
|
Example
{
"setBasicNodeSettings": SetBasicNodeExtendedSettings,
"updateBrandCategory": UpdateBrandCategory,
"updateArchive": "DELETE"
}
UpdateBrandDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateBrandDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateBrandDynamicConditionOperation]
}
UpdateBrandDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setBrand - SetBrandDynamicConditionRelation
|
Brand value |
Example
{
"setNegated": SetNegated,
"setBrand": SetBrandDynamicConditionRelation
}
UpdateBrandInput
Description
MUTATION INPUTS
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Brand id |
ops - [UpdateBrandOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateBrandOperation]
}
UpdateBrandListDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateBrandListDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateBrandListDynamicConditionOperation]
}
UpdateBrandListDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setStringList - SetStringListConditionValue
|
Brand list ids values |
Example
{
"setNegated": SetNegated,
"setStringList": SetStringListConditionValue
}
UpdateBrandOperation
Fields
| Input Field | Description |
|---|---|
setBrandLinkValue - SetBrandLinkValue
|
The set link operation |
removeBrandLink - RemoveBrandLink
|
The remove link operation |
setBrandImage - SetBrandImage
|
The set image operation |
removeBrandImage - RemoveBrandImage
|
The remove image operation |
Example
{
"setBrandLinkValue": SetBrandLinkValue,
"removeBrandLink": RemoveBrandLink,
"setBrandImage": SetBrandImage,
"removeBrandImage": RemoveBrandImage
}
UpdateBrandParameterInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Parameter attribute id |
ops - [UpdateParameterOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateParameterOperation]
}
UpdateBrandRangeOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight
|
|
setBrand - SetBrandId
|
Example
{
"setWeight": SetIntWeight,
"setBrand": SetBrandId
}
UpdateBrandeRange
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateBrandRangeOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateBrandRangeOperation]
}
UpdateCampaignInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Campaign ID |
ops - [UpdateCampaignOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateCampaignOperation]
}
UpdateCampaignOperation
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
Campaign name |
setValidityPeriod - SetValidityPeriod
|
Timeframe of campaign |
Example
{
"setName": SetName,
"setValidityPeriod": SetValidityPeriod
}
UpdateCategoryDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateCategoryDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateCategoryDynamicConditionOperation]
}
UpdateCategoryDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setOperator - SetCategoryConditionOperator
|
Operator Within/NotWithin |
setCategory - SetCategoryDynamicConditionRelation
|
Category entity id |
Example
{
"setNegated": SetNegated,
"setOperator": SetCategoryConditionOperator,
"setCategory": SetCategoryDynamicConditionRelation
}
UpdateCategoryIgnoreListInput
Description
Input parameters for Updating Category Ignore List
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Category Ignore List ID |
ops - [UpdateCategoryIgnoreListOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateCategoryIgnoreListOperation]
}
UpdateCategoryIgnoreListOperation
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
Rename list |
addCategories - [AddIgnoredCategory!]
|
Add new category to ignored categories list |
removeCategories - [RemoveIgnoredCategory!]
|
Category that will be removed from the ignore list |
Example
{
"setName": SetName,
"addCategories": [AddIgnoredCategory],
"removeCategories": [RemoveIgnoredCategory]
}
UpdateCategoryListDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateCategoryListDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateCategoryListDynamicConditionOperation]
}
UpdateCategoryListDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setOperator - SetCategoryConditionOperator
|
Operator Within/NotWithin |
setCategoryTreeRelations - [SetCategoryTreeRelation!]
|
Category list entities ids |
Example
{
"setNegated": SetNegated,
"setOperator": SetCategoryConditionOperator,
"setCategoryTreeRelations": [SetCategoryTreeRelation]
}
UpdateCategoryParameterAttributeInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateCategoryParameterOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateCategoryParameterOperation]
}
UpdateCategoryParameterOperation
Fields
| Input Field | Description |
|---|---|
setTimeValidity - SetTimeValidity
|
|
removeTimeValidity - RemoveTimeValidity
|
|
setParameterDescription - SetParameterDescription
|
|
updateValue - SetDynamicValueOperation
|
|
removeAbTestValues - [RemoveAbTestValue!]
|
|
convertToAbTest - ConvertToAbTest
|
|
removeCustomerSegmentedValues - [RemoveCustomerSegmentedValue!]
|
|
convertToCustomerSegment - ConvertToCustomerSegment
|
|
addLinkToCategoryTreeEntry - AddLinkToCategoryTreeEntry
|
|
removeLinkToCategoryTreeEntry - RemoveLinkToCategoryTreeEntry
|
|
setOverwriteExistingValue - SetOverwriteExistingValue
|
Example
{
"setTimeValidity": SetTimeValidity,
"removeTimeValidity": RemoveTimeValidity,
"setParameterDescription": SetParameterDescription,
"updateValue": SetDynamicValueOperation,
"removeAbTestValues": [RemoveAbTestValue],
"convertToAbTest": ConvertToAbTest,
"removeCustomerSegmentedValues": [
RemoveCustomerSegmentedValue
],
"convertToCustomerSegment": ConvertToCustomerSegment,
"addLinkToCategoryTreeEntry": AddLinkToCategoryTreeEntry,
"removeLinkToCategoryTreeEntry": RemoveLinkToCategoryTreeEntry,
"setOverwriteExistingValue": SetOverwriteExistingValue
}
UpdateCategoryRange
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateCategoryRangeOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateCategoryRangeOperation]
}
UpdateCategoryRangeOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight
|
|
setCategory - SetCategory
|
Example
{
"setWeight": SetIntWeight,
"setCategory": SetCategory
}
UpdateCategoryTreeNodeInput
Description
UPDATE
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateCategoryTreeNodeOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateCategoryTreeNodeOperation]
}
UpdateCategoryTreeNodeOperation
Fields
| Input Field | Description |
|---|---|
updatePimCategory - UpdatePimCategoryOperation
|
|
updateCuratedPage - UpdateCuratedPageOperation
|
|
updateSmartCategory - UpdateSmartCategoryOperation
|
|
updateFilterCategory - UpdateFilterCategoryOperation
|
|
updateBrandCategory - UpdateBrandCategoryOperation
|
|
updateFilterLevel - UpdateFilterLevelOperation
|
|
updateFilterCategoryChild - UpdateFilterCategoryChildOperation
|
|
updateBrandCategoryChild - UpdateBrandCategoryChildOperation
|
Example
{
"updatePimCategory": UpdatePimCategoryOperation,
"updateCuratedPage": UpdateCuratedPageOperation,
"updateSmartCategory": UpdateSmartCategoryOperation,
"updateFilterCategory": UpdateFilterCategoryOperation,
"updateBrandCategory": UpdateBrandCategoryOperation,
"updateFilterLevel": UpdateFilterLevelOperation,
"updateFilterCategoryChild": UpdateFilterCategoryChildOperation,
"updateBrandCategoryChild": UpdateBrandCategoryChildOperation
}
UpdateColorListDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateColorListDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateColorListDynamicConditionOperation]
}
UpdateColorListDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setStringList - SetStringListConditionValue
|
String lst color values |
Example
{
"setNegated": SetNegated,
"setStringList": SetStringListConditionValue
}
UpdateComboboxDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateComboboxDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateComboboxDynamicConditionOperation]
}
UpdateComboboxDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setKey - SetComboboxConditionValue
|
Selected value from combobox |
Example
{
"setNegated": SetNegated,
"setKey": SetComboboxConditionValue
}
UpdateCommonVoucherDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateCommonVoucherDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateCommonVoucherDynamicConditionOperation]
}
UpdateCommonVoucherDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setCommonVoucher - SetCommonVoucher
|
Common voucher id |
Example
{
"setNegated": SetNegated,
"setCommonVoucher": SetCommonVoucher
}
UpdateCommonVoucherInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateCommonVoucherOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateCommonVoucherOperation]
}
UpdateCommonVoucherOperation
Fields
| Input Field | Description |
|---|---|
generateVoucherCodeCommonVoucher - GenerateVoucherCodeCommonVoucher
|
|
reactivateVoucherCode - ReactivateVoucherCodeCommonVoucher
|
Example
{
"generateVoucherCodeCommonVoucher": "GENERATE",
"reactivateVoucherCode": ReactivateVoucherCodeCommonVoucher
}
UpdateContainer
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
If start date < NOW, copy on write. |
ops - [UpdateContainerOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateContainerOperation]
}
UpdateContainerOperation
Fields
| Input Field | Description |
|---|---|
setTimeValidity - SetTimeValidity
|
|
addCustomerSegment - AddCustomerSegment
|
|
removeCustomerSegment - RemoveCustomerSegment
|
|
updateTeaser - [UpdateTeaserOperation!]
|
Example
{
"setTimeValidity": SetTimeValidity,
"addCustomerSegment": AddCustomerSegment,
"removeCustomerSegment": RemoveCustomerSegment,
"updateTeaser": [UpdateTeaserOperation]
}
UpdateContentPageOperation
Fields
| Input Field | Description |
|---|---|
setContentNodePositionOperation - SetContentNodePositionOperation
|
|
updateBasicSettingsOperation - UpdateBasicSettingsOperation
|
|
updateArchive - UpdateArchive
|
Example
{
"setContentNodePositionOperation": SetContentNodePositionOperation,
"updateBasicSettingsOperation": UpdateBasicSettingsOperation,
"updateArchive": "DELETE"
}
UpdateContentPageParameterOperation
Fields
| Input Field | Description |
|---|---|
setTimeValidity - SetTimeValidity
|
|
removeTimeValidity - RemoveTimeValidity
|
|
setParameterDescription - SetParameterDescription
|
|
updateValue - SetDynamicValueOperation
|
|
removeAbTestValues - [RemoveAbTestValue!]
|
|
convertToAbTest - ConvertToAbTest
|
|
removeCustomerSegmentedValues - [RemoveCustomerSegmentedValue!]
|
|
convertToCustomerSegment - ConvertToCustomerSegment
|
|
addLinkToLandingTreeEntry - AddLinkToLandingTreeEntry
|
|
removeLinkToLandingTreeEntry - RemoveLinkToLandingTreeEntry
|
|
addLinkToContentTreeEntry - AddLinkToContentTreeEntry
|
|
removeLinkToContentTreeEntry - RemoveLinkToContentTreeEntry
|
|
addLinkToMaintainTreeEntry - AddLinkToMaintainTreeEntry
|
|
removeLinkToMaintainTreeEntry - RemoveLinkToMaintainTreeEntry
|
|
setOverwriteExistingValue - SetOverwriteExistingValue
|
|
addLinkToProductPageTreeEntry - AddLinkToProductPageTreeEntry
|
|
removeLinkToProductPageTreeEntry - RemoveLinkToProductPageTreeEntry
|
|
addLinkToSearchTermGroupTreeEntry - AddLinkToSearchTermGroupTreeEntry
|
|
removeLinkToSearchTermGroupTreeEntry - RemoveLinkToSearchTermGroupTreeEntry
|
Example
{
"setTimeValidity": SetTimeValidity,
"removeTimeValidity": RemoveTimeValidity,
"setParameterDescription": SetParameterDescription,
"updateValue": SetDynamicValueOperation,
"removeAbTestValues": [RemoveAbTestValue],
"convertToAbTest": ConvertToAbTest,
"removeCustomerSegmentedValues": [
RemoveCustomerSegmentedValue
],
"convertToCustomerSegment": ConvertToCustomerSegment,
"addLinkToLandingTreeEntry": AddLinkToLandingTreeEntry,
"removeLinkToLandingTreeEntry": RemoveLinkToLandingTreeEntry,
"addLinkToContentTreeEntry": AddLinkToContentTreeEntry,
"removeLinkToContentTreeEntry": RemoveLinkToContentTreeEntry,
"addLinkToMaintainTreeEntry": AddLinkToMaintainTreeEntry,
"removeLinkToMaintainTreeEntry": RemoveLinkToMaintainTreeEntry,
"setOverwriteExistingValue": SetOverwriteExistingValue,
"addLinkToProductPageTreeEntry": AddLinkToProductPageTreeEntry,
"removeLinkToProductPageTreeEntry": RemoveLinkToProductPageTreeEntry,
"addLinkToSearchTermGroupTreeEntry": AddLinkToSearchTermGroupTreeEntry,
"removeLinkToSearchTermGroupTreeEntry": RemoveLinkToSearchTermGroupTreeEntry
}
UpdateContentTreeNodeInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateContentPageOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateContentPageOperation]
}
UpdateContentTreeParameterAttributeInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateContentPageParameterOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateContentPageParameterOperation]
}
UpdateCuratedPage
Fields
| Input Field | Description |
|---|---|
setBasicSettingsName - SetBasicSettingsName
|
|
setBasicSettingsUrl - SetBasicSettingsUrl
|
|
setBasicSettingsDescription - SetBasicSettingsDescription
|
|
setTimeValidity - SetPageTimeValidity
|
Example
{
"setBasicSettingsName": SetBasicSettingsName,
"setBasicSettingsUrl": SetBasicSettingsUrl,
"setBasicSettingsDescription": SetBasicSettingsDescription,
"setTimeValidity": SetPageTimeValidity
}
UpdateCuratedPageOperation
Fields
| Input Field | Description |
|---|---|
setBasicNodeSettings - SetBasicNodeExtendedSettings
|
|
updateCuratedPage - UpdateCuratedPage
|
|
updateArchive - UpdateArchive
|
Example
{
"setBasicNodeSettings": SetBasicNodeExtendedSettings,
"updateCuratedPage": UpdateCuratedPage,
"updateArchive": "DELETE"
}
UpdateCustomerSegmentDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateCustomerSegmentDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateCustomerSegmentDynamicConditionOperation]
}
UpdateCustomerSegmentDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setCustomerSegment - SetCustomerSegmentDynamicConditionRelation
|
Customer segment id |
Example
{
"setNegated": SetNegated,
"setCustomerSegment": SetCustomerSegmentDynamicConditionRelation
}
UpdateCustomerSegmentInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Customer Segment ID |
ops - [UpdateCustomerSegmentOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateCustomerSegmentOperation]
}
UpdateCustomerSegmentOperation
Fields
| Input Field | Description |
|---|---|
setName - SetCustomerSegmentName
|
The name |
setDescription - SetDescription
|
The description |
updateOrCondition - UpdateOrCondition
|
CustomerSegment`s conditions to be updated |
Example
{
"setName": SetCustomerSegmentName,
"setDescription": SetDescription,
"updateOrCondition": UpdateOrCondition
}
UpdateDataExportInput
Description
Input parameters for Updating Data Export
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Data Export ID |
ops - [UpdateDataExportOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateDataExportOperation]
}
UpdateDataExportOperation
Description
Input parameter for Data Export Update Operation
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
Data Export name that will be updated |
setEmail - SetEmail
|
Email that will be updated |
setCompressionType - SetCompressionType
|
Compression Type that will be updated |
setExportType - SetExportType
|
Export Type that will be updated |
setGranularity - SetGranularity
|
Granularity that will be updated |
setCategoriesIgnoreList - SetCategoriesIgnoreList
|
Ignored Categories that will be updated |
removeCategoriesIgnoreList - RemoveCategoriesIgnoreList
|
Ignored Categories List that will be removed |
setArticlesIgnoreList - SetArticlesIgnoreList
|
Ignored articles list that will be updated |
removeArticlesIgnoreList - RemoveArticlesIgnoreList
|
Articles Ignore List that will be removed |
setReplacementList - SetReplacementList
|
The list of replaced strings that will be updated |
removeReplacementList - RemoveReplacementList
|
Replacement List that will be removed |
addOrCondition - AddOrDataExportCondition
|
The parent condition which should be OR condition |
updateOrCondition - UpdateOrCondition
|
Conditions that will be updated |
removeCondition - RemoveCondition
|
Condition that will be removed |
setExportFormat - SetExportFormat
|
Export format that will be updated |
Example
{
"setName": SetName,
"setEmail": SetEmail,
"setCompressionType": SetCompressionType,
"setExportType": SetExportType,
"setGranularity": SetGranularity,
"setCategoriesIgnoreList": SetCategoriesIgnoreList,
"removeCategoriesIgnoreList": RemoveCategoriesIgnoreList,
"setArticlesIgnoreList": SetArticlesIgnoreList,
"removeArticlesIgnoreList": RemoveArticlesIgnoreList,
"setReplacementList": SetReplacementList,
"removeReplacementList": RemoveReplacementList,
"addOrCondition": AddOrDataExportCondition,
"updateOrCondition": UpdateOrCondition,
"removeCondition": RemoveCondition,
"setExportFormat": SetExportFormat
}
UpdateDataExportPreviewInput
Description
Input parameter for Data Export preview update input
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Data Export ID |
ops - [UpdateDataExportPreviewOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateDataExportPreviewOperation]
}
UpdateDataExportPreviewOperation
Description
Input parameter for Data Export preview update Operation
Fields
| Input Field | Description |
|---|---|
setGranularity - SetGranularity
|
Granularity that will be updated |
setCategoriesIgnoreList - SetCategoriesIgnoreList
|
Ignored Categories that will be updated |
removeCategoriesIgnoreList - RemoveCategoriesIgnoreList
|
Ignored Categories List that will be removed |
setArticlesIgnoreList - SetArticlesIgnoreList
|
Ignored articles list that will be updated |
removeArticlesIgnoreList - RemoveArticlesIgnoreList
|
Articles Ignore List that will be removed |
setReplacementList - SetReplacementList
|
The list of replaced strings that will be updated |
removeReplacementList - RemoveReplacementList
|
Replacement List that will be removed |
updateOrCondition - UpdateOrCondition
|
Conditions that will be updated |
removeCondition - RemoveCondition
|
Condition that will be removed |
setExportFormat - SetExportFormat
|
Export format that will be updated |
setPreviewExportFormat - SetPreviewExportFormat
|
Export format |
Example
{
"setGranularity": SetGranularity,
"setCategoriesIgnoreList": SetCategoriesIgnoreList,
"removeCategoriesIgnoreList": RemoveCategoriesIgnoreList,
"setArticlesIgnoreList": SetArticlesIgnoreList,
"removeArticlesIgnoreList": RemoveArticlesIgnoreList,
"setReplacementList": SetReplacementList,
"removeReplacementList": RemoveReplacementList,
"updateOrCondition": UpdateOrCondition,
"removeCondition": RemoveCondition,
"setExportFormat": SetExportFormat,
"setPreviewExportFormat": SetPreviewExportFormat
}
UpdateDateDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateDateDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateDateDynamicConditionOperation]
}
UpdateDateDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setDate - SetDateConditionValue
|
Date value |
Example
{
"setNegated": SetNegated,
"setDate": SetDateConditionValue
}
UpdateDiscountAmountBenefit
Description
Input parameters for DiscountAmountBenefit
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Benefit ID |
ops - [UpdateDiscountAmountBenefitOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateDiscountAmountBenefitOperation]
}
UpdateDiscountAmountBenefitOperation
Description
Input parameters operations for UpdateDiscountAmountBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setBenefitTarget - SetBenefitTarget
|
Benefit target type (ITEM or BASKET) |
setBenefitDiscount - SetBenefitDiscount
|
Percentage value |
setBenefitCurrency - SetBenefitCurrency
|
Currency |
removeBenefitImage - RemoveBenefitImage
|
Remove image for benefit |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setBenefitTarget": SetBenefitTarget,
"setBenefitDiscount": SetBenefitDiscount,
"setBenefitCurrency": SetBenefitCurrency,
"removeBenefitImage": RemoveBenefitImage
}
UpdateDiscountPercentBenefit
Description
Input parameters for DiscountPercentBenefit
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Benefit ID |
ops - [UpdateDiscountPercentBenefitOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateDiscountPercentBenefitOperation]
}
UpdateDiscountPercentBenefitOperation
Description
Input parameters operations for UpdateDiscountPercentBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setBenefitTarget - SetBenefitTarget
|
Benefit target type (ITEM or BASKET) |
setPercentageValue - SetPercentageValue
|
Percentage value |
setPriceType - SetPriceType
|
Price type CURRENT_PRICE or OLD_PRICE |
setCapAmount - SetCapAmount
|
Cap amount |
setCapCurrency - SetCapCurrency
|
Cap currency (EUR, ...etc) |
removeBenefitImage - RemoveBenefitImage
|
Remove image for benefit |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setBenefitTarget": SetBenefitTarget,
"setPercentageValue": SetPercentageValue,
"setPriceType": SetPriceType,
"setCapAmount": SetCapAmount,
"setCapCurrency": SetCapCurrency,
"removeBenefitImage": RemoveBenefitImage
}
UpdateDiscountPercentOnCheapestItemBenefit
Description
Input parameters for DiscountPercentOnCheapestItemBenefit
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Benefit ID |
ops - [UpdateDiscountPercentOnCheapestItemBenefitOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [
UpdateDiscountPercentOnCheapestItemBenefitOperation
]
}
UpdateDiscountPercentOnCheapestItemBenefitOperation
Description
Input parameters operations for UpdateDiscountPercentOnCheapestItemBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setPercentageValue - SetPercentageValue
|
Percentage value |
setCapAmount - SetCapAmount
|
Cap amount |
setCapCurrency - SetCapCurrency
|
Cap currency (EUR, ...etc) |
removeBenefitImage - RemoveBenefitImage
|
Remove image for benefit |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setPercentageValue": SetPercentageValue,
"setCapAmount": SetCapAmount,
"setCapCurrency": SetCapCurrency,
"removeBenefitImage": RemoveBenefitImage
}
UpdateDiscountPercentOnMostExpensiveItemBenefit
Description
Input parameters for DiscountPercentOnMostExpensiveItemBenefit
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Benefit ID |
ops - [UpdateDiscountPercentOnMostExpensiveItemBenefitOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [
UpdateDiscountPercentOnMostExpensiveItemBenefitOperation
]
}
UpdateDiscountPercentOnMostExpensiveItemBenefitOperation
Description
Input parameters operations for UpdateDiscountPercentOnMostExpensiveItemBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setPercentageValue - SetPercentageValue
|
Percentage value |
setCapAmount - SetCapAmount
|
Cap amount |
setCapCurrency - SetCapCurrency
|
Cap currency (EUR, ...etc) |
removeBenefitImage - RemoveBenefitImage
|
Remove image for benefit |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setPercentageValue": SetPercentageValue,
"setCapAmount": SetCapAmount,
"setCapCurrency": SetCapCurrency,
"removeBenefitImage": RemoveBenefitImage
}
UpdateDoubleDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateDoubleDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateDoubleDynamicConditionOperation]
}
UpdateDoubleDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setDouble - SetDoubleConditionValue
|
Double value |
Example
{
"setNegated": SetNegated,
"setDouble": SetDoubleConditionValue
}
UpdateDoubleRange
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
updateDoubleRangeGreaterThan - UpdateDoubleRangeGreaterThan
|
|
updateDoubleRangeLessThan - UpdateDoubleRangeLessThan
|
|
updateDoubleRangeBetween - UpdateDoubleRangeBetween
|
Example
{
"updateDoubleRangeGreaterThan": UpdateDoubleRangeGreaterThan,
"updateDoubleRangeLessThan": UpdateDoubleRangeLessThan,
"updateDoubleRangeBetween": UpdateDoubleRangeBetween
}
UpdateDoubleRangeBetween
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateDoubleRangeBetweenOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateDoubleRangeBetweenOperation]
}
UpdateDoubleRangeBetweenOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight
|
|
setFrom - SetFromDoubleValue
|
|
setTo - SetToDoubleValue
|
Example
{
"setWeight": SetIntWeight,
"setFrom": SetFromDoubleValue,
"setTo": SetToDoubleValue
}
UpdateDoubleRangeGreaterThan
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateDoubleRangeGreaterThanOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateDoubleRangeGreaterThanOperation]
}
UpdateDoubleRangeGreaterThanOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight
|
|
setFrom - SetFromDoubleValue
|
Example
{
"setWeight": SetIntWeight,
"setFrom": SetFromDoubleValue
}
UpdateDoubleRangeLessThan
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateDoubleRangeLessThanOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateDoubleRangeLessThanOperation]
}
UpdateDoubleRangeLessThanOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight
|
|
setTo - SetToDoubleValue
|
Example
{
"setWeight": SetIntWeight,
"setTo": SetToDoubleValue
}
UpdateDoubleTextDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateDoubleTextDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateDoubleTextDynamicConditionOperation]
}
UpdateDoubleTextDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setFirstText - SetTextConditionValue
|
First text |
setSecondText - SetSecondTextConditionValue
|
Second text |
Example
{
"setNegated": SetNegated,
"setFirstText": SetTextConditionValue,
"setSecondText": SetSecondTextConditionValue
}
UpdateFilterCategory
Fields
| Input Field | Description |
|---|---|
updateOrCondition - UpdateOrCondition
|
|
setBasicSettingsUrl - SetBasicSettingsUrl
|
|
setBasicSettingsDescription - SetBasicSettingsDescription
|
|
setTimeValidity - SetPageTimeValidity
|
|
setLimitType - SetFilterCategoryLimitType
|
|
setLimitValue - SetFilterCategoryLimitValue
|
|
setSkuSort - SetBooleanValueCondition
|
|
addFilterCategorySources - [AddFilterCategorySource!]
|
|
removeFilterCategorySources - [RemoveFilterCategorySource!]
|
|
addBlocklistedCategories - [AddFilterCategoryBlocklistedCategory!]
|
|
removeBlocklistedCategories - [RemoveFilterCategoryBlocklistedCategory!]
|
Example
{
"updateOrCondition": UpdateOrCondition,
"setBasicSettingsUrl": SetBasicSettingsUrl,
"setBasicSettingsDescription": SetBasicSettingsDescription,
"setTimeValidity": SetPageTimeValidity,
"setLimitType": SetFilterCategoryLimitType,
"setLimitValue": SetFilterCategoryLimitValue,
"setSkuSort": SetBooleanValueCondition,
"addFilterCategorySources": [AddFilterCategorySource],
"removeFilterCategorySources": [
RemoveFilterCategorySource
],
"addBlocklistedCategories": [
AddFilterCategoryBlocklistedCategory
],
"removeBlocklistedCategories": [
RemoveFilterCategoryBlocklistedCategory
]
}
UpdateFilterCategoryChildOperation
Fields
| Input Field | Description |
|---|---|
setBasicNodeSettings - SetBasicNodeSettings
|
Example
{"setBasicNodeSettings": SetBasicNodeSettings}
UpdateFilterCategoryOperation
Fields
| Input Field | Description |
|---|---|
setBasicNodeSettings - SetBasicNodeExtendedSettings
|
|
updateFilterCategory - UpdateFilterCategory
|
|
updateArchive - UpdateArchive
|
Example
{
"setBasicNodeSettings": SetBasicNodeExtendedSettings,
"updateFilterCategory": UpdateFilterCategory,
"updateArchive": "DELETE"
}
UpdateFilterDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateFilterDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateFilterDynamicConditionOperation]
}
UpdateFilterDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setKey - SetTextConditionValue
|
Filter key |
setValue - SetSecondTextConditionValue
|
Filter value |
Example
{
"setNegated": SetNegated,
"setKey": SetTextConditionValue,
"setValue": SetSecondTextConditionValue
}
UpdateFilterLevel
Fields
| Input Field | Description |
|---|---|
updateOrCondition - UpdateOrCondition
|
|
setBasicSettingsDescription - SetBasicSettingsDescription
|
Example
{
"updateOrCondition": UpdateOrCondition,
"setBasicSettingsDescription": SetBasicSettingsDescription
}
UpdateFilterLevelOperation
Fields
| Input Field | Description |
|---|---|
updateFilterLevel - UpdateFilterLevel
|
|
updateArchive - UpdateArchive
|
|
setBasicNodeSettings - SetBasicNodeExtendedSettings
|
Example
{
"updateFilterLevel": UpdateFilterLevel,
"updateArchive": "DELETE",
"setBasicNodeSettings": SetBasicNodeExtendedSettings
}
UpdateFormatInput
Description
Input parameters for Updating Format
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Format ID |
ops - [UpdateFormatOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateFormatOperation]
}
UpdateFormatOperation
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
Rename Export Format |
setTemplateFormat - SetTemplateFormat
|
Update Template Format |
Example
{
"setName": SetName,
"setTemplateFormat": SetTemplateFormat
}
UpdateFreeItemBenefit
Description
Input parameters for FreeItemsBenefit
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Benefit ID |
ops - [UpdateFreeItemBenefitOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateFreeItemBenefitOperation]
}
UpdateFreeItemBenefitOperation
Description
Input parameters operations for UpdateFreeItemBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setBenefitTarget - SetBenefitTarget
|
Benefit target type (ITEM or BASKET) |
setBenefitItems - SetBenefitItems
|
Selectable items |
setMaxSelectableItems - SetMaxSelectableItems
|
Max selectable items |
removeBenefitImage - RemoveBenefitImage
|
Remove image for benefit |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setBenefitTarget": SetBenefitTarget,
"setBenefitItems": SetBenefitItems,
"setMaxSelectableItems": SetMaxSelectableItems,
"removeBenefitImage": RemoveBenefitImage
}
UpdateFreeShippingBenefit
Description
Input parameters for FreeShippingBenefit
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Benefit ID |
ops - [UpdateFreeShippingBenefitOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateFreeShippingBenefitOperation]
}
UpdateFreeShippingBenefitOperation
Description
Input parameters operations for UpdateFreeShippingBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
removeBenefitImage - RemoveBenefitImage
|
Remove image for benefit |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"removeBenefitImage": RemoveBenefitImage
}
UpdateGlobalParameterInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateGlobalParameterOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateGlobalParameterOperation]
}
UpdateGlobalParameterOperation
Fields
| Input Field | Description |
|---|---|
setAttributeName - SetAttributeName
|
|
setParameterDescription - SetParameterDescription
|
|
setTimeValidity - SetTimeValidity
|
|
removeTimeValidity - RemoveTimeValidity
|
|
updateValue - SetDynamicValueOperation
|
|
removeAbTestValues - [RemoveAbTestValue!]
|
|
removeCustomerSegmentedValues - [RemoveCustomerSegmentedValue!]
|
|
convertToAbTest - ConvertToAbTest
|
|
convertToCustomerSegment - ConvertToCustomerSegment
|
Example
{
"setAttributeName": SetAttributeName,
"setParameterDescription": SetParameterDescription,
"setTimeValidity": SetTimeValidity,
"removeTimeValidity": RemoveTimeValidity,
"updateValue": SetDynamicValueOperation,
"removeAbTestValues": [RemoveAbTestValue],
"removeCustomerSegmentedValues": [
RemoveCustomerSegmentedValue
],
"convertToAbTest": ConvertToAbTest,
"convertToCustomerSegment": ConvertToCustomerSegment
}
UpdateGridContainerAttribute
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Attribute id |
ops - [UpdateRasterParameterOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateRasterParameterOperation]
}
UpdateGridContainerOperation
Fields
| Input Field | Description |
|---|---|
addGridContainerAttribute - AddGridContainerAttribute
|
Add attributes to grid container |
updateGridContainerAttribute - UpdateGridContainerAttribute
|
Update existing attributes into grid container |
removeGridContainerAttribute - RemoveGridContainerAttribute
|
Delete attributes from grid container |
setTrackingCode - SetGridContainerTrackingCode
|
Update grid container tracking code |
setGridContainerType - SetGridContainerType
|
Update grid container type |
Example
{
"addGridContainerAttribute": AddGridContainerAttribute,
"updateGridContainerAttribute": UpdateGridContainerAttribute,
"removeGridContainerAttribute": RemoveGridContainerAttribute,
"setTrackingCode": SetGridContainerTrackingCode,
"setGridContainerType": SetGridContainerType
}
UpdateGridElementInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateGridElementOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateGridElementOperation]
}
UpdateGridElementOperation
Fields
| Input Field | Description |
|---|---|
createContainer - CreateContainer
|
|
updateContainer - UpdateContainer
|
|
copyContainer - CopyContainer
|
|
removeContainer - RemoveContainer
|
Example
{
"createContainer": CreateContainer,
"updateContainer": UpdateContainer,
"copyContainer": CopyContainer,
"removeContainer": RemoveContainer
}
UpdateGridInput
Description
"""Updates (AND Copy on writes in certain cases)"""
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
"""If start date < NOW, copy on write.""" |
ops - [UpdateGridOperation!]!
|
"""Needs to be NOW or later.""" time: DateTime! |
Example
{
"id": EntityId,
"ops": [UpdateGridOperation]
}
UpdateGridOperation
Fields
| Input Field | Description |
|---|---|
setValidityRange - SetValidityRange
|
|
setName - SetName
|
|
updateGridStructure - [UpdateGridStructureOperation!]
|
Example
{
"setValidityRange": SetValidityRange,
"setName": SetName,
"updateGridStructure": [UpdateGridStructureOperation]
}
UpdateGridStructureOperation
Description
Only one of the operation should be set.
Fields
| Input Field | Description |
|---|---|
addAreaForGridElements - AddAreaForGridElements
|
|
addGridElement - CreateGridElement
|
|
removeGridElement - RemoveGridElement
|
|
moveGridElementsInArea - MoveGridElementsInArea
|
|
endGridElement - EndGridElement
|
Example
{
"addAreaForGridElements": AddAreaForGridElements,
"addGridElement": CreateGridElement,
"removeGridElement": RemoveGridElement,
"moveGridElementsInArea": MoveGridElementsInArea,
"endGridElement": EndGridElement
}
UpdateGridTemplateContainerInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Raster element id |
ops - [UpdateGridContainerOperation!]!
|
Grid container update operations |
Example
{
"id": EntityId,
"ops": [UpdateGridContainerOperation]
}
UpdateGridTemplateInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Raster template id |
ops - [UpdateGridTemplateOperation!]!
|
Grid template update operations |
Example
{
"id": EntityId,
"ops": [UpdateGridTemplateOperation]
}
UpdateGridTemplateOperation
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
Change name of existing GridTemplate |
setGridContainers - SetGridContainers
|
create new Containers and drop old ones |
updateContainers - [UpdateGridTemplateContainerInput!]
|
update an existing GridContainer |
Example
{
"setName": SetName,
"setGridContainers": SetGridContainers,
"updateContainers": [UpdateGridTemplateContainerInput]
}
UpdateGroupInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Customer Segment group ID |
ops - [UpdateGroupOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateGroupOperation]
}
UpdateGroupOperation
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
The name |
setPriority - SetPriority
|
The priority |
Example
{
"setName": SetName,
"setPriority": SetPriority
}
UpdateHotSpotOperation
Fields
| Input Field | Description |
|---|---|
setHotSpotTrackingCode - SetHotSpotTrackingCode
|
|
setHotSpotText - SetHotSpotText
|
|
setCoordinates - SetHotSpotCoordinates
|
Example
{
"setHotSpotTrackingCode": SetHotSpotTrackingCode,
"setHotSpotText": SetHotSpotText,
"setCoordinates": SetHotSpotCoordinates
}
UpdateHotSpotRelationInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
ID of the HotSpot |
ops - [UpdateHotSpotOperation]
|
Example
{
"id": EntityId,
"ops": [UpdateHotSpotOperation]
}
UpdateInformativeBenefit
Description
Input parameters for InformativeBenefit
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Benefit ID |
ops - [UpdateInformativeBenefitOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateInformativeBenefitOperation]
}
UpdateInformativeBenefitOperation
Description
Input parameters operations for UpdateInformativeBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setInformativeType - SetInformativeType
|
Informative type |
setInternalName - SetInternalName
|
Internal name |
removeBenefitImage - RemoveBenefitImage
|
Remove image for benefit |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setInformativeType": SetInformativeType,
"setInternalName": SetInternalName,
"removeBenefitImage": RemoveBenefitImage
}
UpdateIntRange
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
updateIntRangeGreaterThan - UpdateIntRangeGreaterThan
|
|
updateIntRangeLessThan - UpdateIntRangeLessThan
|
|
updateIntRangeBetween - UpdateIntRangeBetween
|
Example
{
"updateIntRangeGreaterThan": UpdateIntRangeGreaterThan,
"updateIntRangeLessThan": UpdateIntRangeLessThan,
"updateIntRangeBetween": UpdateIntRangeBetween
}
UpdateIntRangeBetween
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateIntRangeBetweenOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateIntRangeBetweenOperation]
}
UpdateIntRangeBetweenOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight
|
|
setFrom - SetFromIntValue
|
|
setTo - SetToIntValue
|
Example
{
"setWeight": SetIntWeight,
"setFrom": SetFromIntValue,
"setTo": SetToIntValue
}
UpdateIntRangeGreaterThan
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateIntRangeGreaterThanOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateIntRangeGreaterThanOperation]
}
UpdateIntRangeGreaterThanOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight
|
|
setFrom - SetFromIntValue
|
Example
{
"setWeight": SetIntWeight,
"setFrom": SetFromIntValue
}
UpdateIntRangeLessThan
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateIntRangeLessThanOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateIntRangeLessThanOperation]
}
UpdateIntRangeLessThanOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight
|
|
setTo - SetToIntValue
|
Example
{
"setWeight": SetIntWeight,
"setTo": SetToIntValue
}
UpdateIntegerComparisonDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateIntegerComparisonDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [
UpdateIntegerComparisonDynamicConditionOperation
]
}
UpdateIntegerComparisonDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setInteger - SetIntegerConditionValue
|
Integer value |
setOperator - SetMonetaryComparisonOperator
|
Operators >= or <= |
Example
{
"setNegated": SetNegated,
"setInteger": SetIntegerConditionValue,
"setOperator": SetMonetaryComparisonOperator
}
UpdateIntegerDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateIntegerDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateIntegerDynamicConditionOperation]
}
UpdateIntegerDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setInteger - SetIntegerConditionValue
|
Integer value |
Example
{
"setNegated": SetNegated,
"setInteger": SetIntegerConditionValue
}
UpdateLandingPageInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateLandingPageOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateLandingPageOperation]
}
UpdateLandingPageOperation
Fields
| Input Field | Description |
|---|---|
updateArchive - UpdateArchive
|
|
updateBasicSettingsOperation - UpdateBasicSettingsOperation
|
Example
{
"updateArchive": "DELETE",
"updateBasicSettingsOperation": UpdateBasicSettingsOperation
}
UpdateLemmaInput
Description
An ID of an existing lemma and operations to apply to it.
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
The ID of the lemma to update. |
ops - [UpdateLemmaOperation!]!
|
A List of operations to apply to the lemma. |
Example
{
"id": EntityId,
"ops": [UpdateLemmaOperation]
}
UpdateLemmaOperation
Description
Information about an operation to change a lemma. Only allows one element here.
Fields
| Input Field | Description |
|---|---|
setSearchTerms - SetSearchTerms
|
The search terms affected by this lemma. |
setWordStem - SetWordStem
|
The word stem of this lemma. |
Example
{
"setSearchTerms": SetSearchTerms,
"setWordStem": SetWordStem
}
UpdateMonetaryAmountComparisonDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateMonetaryAmountComparisonDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [
UpdateMonetaryAmountComparisonDynamicConditionOperation
]
}
UpdateMonetaryAmountComparisonDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setOperator - SetMonetaryComparisonOperator
|
Operators >= or <= |
setAmount - SetMonetaryAmountConditionValue
|
Double amount |
setCurrency - SetTextConditionValue
|
Currency |
Example
{
"setNegated": SetNegated,
"setOperator": SetMonetaryComparisonOperator,
"setAmount": SetMonetaryAmountConditionValue,
"setCurrency": SetTextConditionValue
}
UpdateMonetaryAmountDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateMonetaryAmountDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateMonetaryAmountDynamicConditionOperation]
}
UpdateMonetaryAmountDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setAmount - SetMonetaryAmountConditionValue
|
Double amount |
setCurrency - SetTextConditionValue
|
Currency |
Example
{
"setNegated": SetNegated,
"setAmount": SetMonetaryAmountConditionValue,
"setCurrency": SetTextConditionValue
}
UpdateMyProfileInput
Description
Input for mutations
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateMyProfileOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateMyProfileOperation]
}
UpdateMyProfileOperation
Description
Possible operations for updating the user information Only one operation should be present
Fields
| Input Field | Description |
|---|---|
setMyProfileUserName - SetMyProfileUserName
|
Set user username |
setUserPassword - SetUserPassword
|
Set user password |
setUserEmail - SetUserEmail
|
Set user email |
setUserSettings - UpdateUserSettingsInput
|
Set user settings |
Example
{
"setMyProfileUserName": SetMyProfileUserName,
"setUserPassword": SetUserPassword,
"setUserEmail": SetUserEmail,
"setUserSettings": UpdateUserSettingsInput
}
UpdateNamedBrandCategorySourceInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateNamedBrandCategorySourceOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateNamedBrandCategorySourceOperation]
}
UpdateNamedBrandCategorySourceOperation
Fields
| Input Field | Description |
|---|---|
setBrandCategoryName - SetBrandCategoryName
|
Example
{"setBrandCategoryName": SetBrandCategoryName}
UpdateNamedLinkRelationInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
ID of the link |
ops - [UpdateNamedLinkRelationOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateNamedLinkRelationOperation]
}
UpdateNamedLinkRelationOperation
Fields
| Input Field | Description |
|---|---|
setNamedLinkName - SetNamedLinkName
|
|
setNamedLinkTitle - SetNamedLinkTitle
|
|
setNamedLinkTrackingCode - SetNamedLinkTrackingCode
|
Example
{
"setNamedLinkName": SetNamedLinkName,
"setNamedLinkTitle": SetNamedLinkTitle,
"setNamedLinkTrackingCode": SetNamedLinkTrackingCode
}
UpdateOrCondition
Description
Update OR condition
Fields
| Input Field | Description |
|---|---|
addAndConditions - [AddAndCondition!]
|
Add And condition to existing OR condition |
updateAndConditions - [UpdateAndCondition!]
|
update And condition |
removeAndConditions - [RemoveCondition!]
|
Delete AND Condition |
Example
{
"addAndConditions": [AddAndCondition],
"updateAndConditions": [UpdateAndCondition],
"removeAndConditions": [RemoveCondition]
}
UpdatePageParameterAttributeInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdatePageParameterOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdatePageParameterOperation]
}
UpdatePageParameterOperation
Fields
| Input Field | Description |
|---|---|
setTimeValidity - SetTimeValidity
|
|
removeTimeValidity - RemoveTimeValidity
|
|
setParameterDescription - SetParameterDescription
|
|
updateValue - SetDynamicValueOperation
|
|
removeAbTestValues - [RemoveAbTestValue!]
|
|
convertToAbTest - ConvertToAbTest
|
|
removeCustomerSegmentedValues - [RemoveCustomerSegmentedValue!]
|
|
convertToCustomerSegment - ConvertToCustomerSegment
|
|
addLinkToLandingTreeEntry - AddLinkToLandingTreeEntry
|
|
removeLinkToLandingTreeEntry - RemoveLinkToLandingTreeEntry
|
|
addLinkToContentTreeEntry - AddLinkToContentTreeEntry
|
|
removeLinkToContentTreeEntry - RemoveLinkToContentTreeEntry
|
|
addLinkToMaintainTreeEntry - AddLinkToMaintainTreeEntry
|
|
removeLinkToMaintainTreeEntry - RemoveLinkToMaintainTreeEntry
|
|
setOverwriteExistingValue - SetOverwriteExistingValue
|
|
addLinkToProductPageTreeEntry - AddLinkToProductPageTreeEntry
|
|
removeLinkToProductPageTreeEntry - RemoveLinkToProductPageTreeEntry
|
|
addLinkToSearchTermGroupTreeEntry - AddLinkToSearchTermGroupTreeEntry
|
|
removeLinkToSearchTermGroupTreeEntry - RemoveLinkToSearchTermGroupTreeEntry
|
Example
{
"setTimeValidity": SetTimeValidity,
"removeTimeValidity": RemoveTimeValidity,
"setParameterDescription": SetParameterDescription,
"updateValue": SetDynamicValueOperation,
"removeAbTestValues": [RemoveAbTestValue],
"convertToAbTest": ConvertToAbTest,
"removeCustomerSegmentedValues": [
RemoveCustomerSegmentedValue
],
"convertToCustomerSegment": ConvertToCustomerSegment,
"addLinkToLandingTreeEntry": AddLinkToLandingTreeEntry,
"removeLinkToLandingTreeEntry": RemoveLinkToLandingTreeEntry,
"addLinkToContentTreeEntry": AddLinkToContentTreeEntry,
"removeLinkToContentTreeEntry": RemoveLinkToContentTreeEntry,
"addLinkToMaintainTreeEntry": AddLinkToMaintainTreeEntry,
"removeLinkToMaintainTreeEntry": RemoveLinkToMaintainTreeEntry,
"setOverwriteExistingValue": SetOverwriteExistingValue,
"addLinkToProductPageTreeEntry": AddLinkToProductPageTreeEntry,
"removeLinkToProductPageTreeEntry": RemoveLinkToProductPageTreeEntry,
"addLinkToSearchTermGroupTreeEntry": AddLinkToSearchTermGroupTreeEntry,
"removeLinkToSearchTermGroupTreeEntry": RemoveLinkToSearchTermGroupTreeEntry
}
UpdateParameterOperation
Fields
| Input Field | Description |
|---|---|
setTimeValidity - SetTimeValidity
|
Time validity range or campaign reference |
setParameterDescription - SetParameterDescription
|
The Description |
removeTimeValidity - RemoveTimeValidity
|
Remove time validity range or campaign reference |
updateValue - SetDynamicValueOperation
|
The attribute name |
removeAbTestValues - [RemoveAbTestValue!]
|
Remove AB test values |
removeCustomerSegmentedValues - [RemoveCustomerSegmentedValue!]
|
Remove the customer segmented values |
convertToAbTest - ConvertToAbTest
|
The AB test values |
convertToCustomerSegment - ConvertToCustomerSegment
|
The customer segmented values |
Example
{
"setTimeValidity": SetTimeValidity,
"setParameterDescription": SetParameterDescription,
"removeTimeValidity": RemoveTimeValidity,
"updateValue": SetDynamicValueOperation,
"removeAbTestValues": [RemoveAbTestValue],
"removeCustomerSegmentedValues": [
RemoveCustomerSegmentedValue
],
"convertToAbTest": ConvertToAbTest,
"convertToCustomerSegment": ConvertToCustomerSegment
}
UpdateParameterTypesInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateParameterTypesOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateParameterTypesOperation]
}
UpdateParameterTypesOperation
Fields
| Input Field | Description |
|---|---|
setHelpText - SetHelpText
|
Example
{"setHelpText": SetHelpText}
UpdatePersonalVoucherDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdatePersonalVoucherDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdatePersonalVoucherDynamicConditionOperation]
}
UpdatePersonalVoucherDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setPersonalVoucher - SetPersonalVoucher
|
Personal voucher id |
Example
{
"setNegated": SetNegated,
"setPersonalVoucher": SetPersonalVoucher
}
UpdatePersonalVoucherInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdatePersonalVoucherOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdatePersonalVoucherOperation]
}
UpdatePersonalVoucherOperation
Fields
| Input Field | Description |
|---|---|
generateVoucherCodePersonalVoucher - GenerateVoucherCodePersonalVoucher
|
|
reactivateVoucherCode - ReactivateVoucherCodePersonalVoucher
|
Example
{
"generateVoucherCodePersonalVoucher": GenerateVoucherCodePersonalVoucher,
"reactivateVoucherCode": ReactivateVoucherCodePersonalVoucher
}
UpdatePimCategoryOperation
Fields
| Input Field | Description |
|---|---|
setBasicNodeSettings - SetBasicNodeSettings
|
Example
{"setBasicNodeSettings": SetBasicNodeSettings}
UpdatePriceFilterDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdatePriceFilterDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdatePriceFilterDynamicConditionOperation]
}
UpdatePriceFilterDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setText - SetTextConditionValue
|
Text |
setMin - SetMinConditionValue
|
Minimum price value |
setMax - SetMaxConditionValue
|
Maximum price value |
setReduced - SetReduced
|
Reduced boolean value |
Example
{
"setNegated": SetNegated,
"setText": SetTextConditionValue,
"setMin": SetMinConditionValue,
"setMax": SetMaxConditionValue,
"setReduced": SetReduced
}
UpdateProductListDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateProductListDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateProductListDynamicConditionOperation]
}
UpdateProductListDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setStringList - SetStringListConditionValue
|
String product list keys |
Example
{
"setNegated": SetNegated,
"setStringList": SetStringListConditionValue
}
UpdatePromotionInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Promotion ID |
ops - [UpdatePromotionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdatePromotionOperation]
}
UpdatePromotionOperation
Fields
| Input Field | Description |
|---|---|
setActive - SetActive
|
Activate/deactivate mcs |
setName - SetName
|
The name |
setDescription - SetDescription
|
The description |
setTimeValidity - SetPromotionTimeValidity
|
Time validity range or campaign reference |
removeTimeValidity - RemoveTimeValidity
|
Remove campaign reference |
updateOrCondition - UpdateOrCondition
|
Promotion's conditions to be updated |
addBenefits - [AddBenefit!]
|
List of promotion's benefits to be added |
updateBenefits - [UpdateBenefit!]
|
List of promotion's benefits to be updated |
removeBenefits - [RemoveBenefit!]
|
List of promotion's benefits to be removed |
setBrokenInheritanceFrom - SetBrokenInheritanceFrom
|
Reference to original field when applying break inheritance logic |
Example
{
"setActive": SetActive,
"setName": SetName,
"setDescription": SetDescription,
"setTimeValidity": SetPromotionTimeValidity,
"removeTimeValidity": RemoveTimeValidity,
"updateOrCondition": UpdateOrCondition,
"addBenefits": [AddBenefit],
"updateBenefits": [UpdateBenefit],
"removeBenefits": [RemoveBenefit],
"setBrokenInheritanceFrom": SetBrokenInheritanceFrom
}
UpdateRangeFilterDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateRangeFilterDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateRangeFilterDynamicConditionOperation]
}
UpdateRangeFilterDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setText - SetTextConditionValue
|
Text |
setMin - SetMinConditionValue
|
Minimum value |
setMax - SetMaxConditionValue
|
Maximum value |
Example
{
"setNegated": SetNegated,
"setText": SetTextConditionValue,
"setMin": SetMinConditionValue,
"setMax": SetMaxConditionValue
}
UpdateRasterParameterOperation
Fields
| Input Field | Description |
|---|---|
updateValue - SetGenericValueOperation
|
Update attribute value |
Example
{"updateValue": SetGenericValueOperation}
UpdateReplacement
UpdateReplacementListInput
Description
Input parameters for Updating Replacement List
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Replacement (export_map) List ID |
ops - [UpdateReplacementListOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateReplacementListOperation]
}
UpdateReplacementListOperation
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
Rename list |
addReplacement - [AddReplacement!]
|
Add new replacement to the list |
updateReplacement - [UpdateReplacement!]
|
Edit existed replacement in the list |
removeReplacement - [RemoveReplacement!]
|
Remove specific replacement from the list |
Example
{
"setName": SetName,
"addReplacement": [AddReplacement],
"updateReplacement": [UpdateReplacement],
"removeReplacement": [RemoveReplacement]
}
UpdateRoleInput
Description
Operations to update single role with menu/group rights
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Id of role to update |
ops - [UpdateRoleOperation!]!
|
Operations to update role |
Example
{
"id": EntityId,
"ops": [UpdateRoleOperation]
}
UpdateRoleOperation
Description
Operation to update role with menu/group rights
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
Operation to set name of role |
setDescription - SetDescription
|
Operation to description name of role |
addRoleRight - AddRoleRight
|
Operation to add menu/group right to role |
setRoleRight - SetRoleRight
|
Operation to update existing role/right relation |
removeRoleRight - RemoveRoleRight
|
Operation to remove menu/group right from role |
Example
{
"setName": SetName,
"setDescription": SetDescription,
"addRoleRight": AddRoleRight,
"setRoleRight": SetRoleRight,
"removeRoleRight": RemoveRoleRight
}
UpdateRoleRightOperation
Description
Operation to update role/right relation
Fields
| Input Field | Description |
|---|---|
addPrivilege - AddPrivilege
|
Operation to add privilege to role/right relation (only privileges that are supported by the right can be added) |
removePrivilege - RemovePrivilege
|
Operation to remove privilege from rile/right relation |
setPrivileges - SetPrivileges
|
Operation to replace all current privileges of a role/right relation with a set of new privileges |
Example
{
"addPrivilege": AddPrivilege,
"removePrivilege": RemovePrivilege,
"setPrivileges": SetPrivileges
}
UpdateSearchExclusionInput
Description
An ID of an existing search exclusion and operations to apply to it.
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
The ID of the search exclusion to update. |
ops - [SearchExclusionUpdateOperation!]!
|
A List of operations to apply to the search exclusion. |
Example
{
"id": EntityId,
"ops": [SearchExclusionUpdateOperation]
}
UpdateSearchIndexScenarioInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateSearchIndexScenarioOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateSearchIndexScenarioOperation]
}
UpdateSearchIndexScenarioOperation
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
|
setScenarioFactor - SetScenarioFactor
|
|
setTrackingCode - SetSearchIndexScenarioTrackingCode
|
|
addAttribute - AddSearchIndexAttribute
|
|
removeAttribute - RemoveSearchIndexAttribute
|
Example
{
"setName": SetName,
"setScenarioFactor": SetScenarioFactor,
"setTrackingCode": SetSearchIndexScenarioTrackingCode,
"addAttribute": AddSearchIndexAttribute,
"removeAttribute": RemoveSearchIndexAttribute
}
UpdateSearchTermGroupInput
Description
An ID of an existing search exclusion and operations to apply to it.
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
The ID of the search exclusion to update. |
ops - [SearchTermGroupUpdateOperation!]!
|
A List of operations to apply to the search exclusion. |
Example
{
"id": EntityId,
"ops": [SearchTermGroupUpdateOperation]
}
UpdateSeoCategory
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": 4}
UpdateSeoTermInput
Description
An ID of an existing seo term and operations to apply to it.
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
The ID of the seo term to update. |
ops - [UpdateSeoTermOperation!]!
|
A List of operations to apply to the seo term. |
Example
{
"id": EntityId,
"ops": [UpdateSeoTermOperation]
}
UpdateSeoTermOperation
Description
Allowed operations to change a seo term.
Fields
| Input Field | Description |
|---|---|
setSeoTerm - SetSeoTerm
|
A term for the seo term. |
setSeoUrl - SetSeoUrl
|
A pretty url for the seo term. |
setSeoMainTerm - SetSeoMainTerm
|
A mainTerm for the seo term. |
updateSeoCategory - UpdateSeoCategory
|
update Category of seo term |
Example
{
"setSeoTerm": SetSeoTerm,
"setSeoUrl": SetSeoUrl,
"setSeoMainTerm": SetSeoMainTerm,
"updateSeoCategory": UpdateSeoCategory
}
UpdateSimpleCondition
Fields
| Input Field | Description |
|---|---|
updateBooleanDynamicCondition - UpdateBooleanDynamicCondition
|
|
updateBrandDynamicCondition - UpdateBrandDynamicCondition
|
|
updateBrandListDynamicCondition - UpdateBrandListDynamicCondition
|
|
updateCategoryDynamicCondition - UpdateCategoryDynamicCondition
|
|
updateCategoryListDynamicCondition - UpdateCategoryListDynamicCondition
|
|
updateColorListDynamicCondition - UpdateColorListDynamicCondition
|
|
updateComboboxDynamicCondition - UpdateComboboxDynamicCondition
|
|
updateCommonVoucherDynamicCondition - UpdateCommonVoucherDynamicCondition
|
|
updateCustomerSegmentDynamicCondition - UpdateCustomerSegmentDynamicCondition
|
|
updateDateDynamicCondition - UpdateDateDynamicCondition
|
|
updateDoubleDynamicCondition - UpdateDoubleDynamicCondition
|
|
updateDoubleTextDynamicCondition - UpdateDoubleTextDynamicCondition
|
|
updateFilterDynamicCondition - UpdateFilterDynamicCondition
|
|
updateIntegerDynamicCondition - UpdateIntegerDynamicCondition
|
|
updateIntegerComparisonDynamicCondition - UpdateIntegerComparisonDynamicCondition
|
|
updateMonetaryAmountComparisonDynamicCondition - UpdateMonetaryAmountComparisonDynamicCondition
|
|
updateMonetaryAmountDynamicCondition - UpdateMonetaryAmountDynamicCondition
|
|
updatePersonalVoucherDynamicCondition - UpdatePersonalVoucherDynamicCondition
|
|
updatePriceFilterDynamicCondition - UpdatePriceFilterDynamicCondition
|
|
updateProductListDynamicCondition - UpdateProductListDynamicCondition
|
|
updateRangeFilterDynamicCondition - UpdateRangeFilterDynamicCondition
|
|
updateStringListDynamicCondition - UpdateStringListDynamicCondition
|
|
updateTextDynamicCondition - UpdateTextDynamicCondition
|
|
updateTouchpointDynamicCondition - UpdateTouchpointDynamicCondition
|
|
updateUserInterestDynamicCondition - UpdateUserInterestDynamicCondition
|
|
updateUserTypeDynamicCondition - UpdateUserTypeDynamicCondition
|
|
updateVoidDynamicCondition - UpdateVoidDynamicCondition
|
Example
{
"updateBooleanDynamicCondition": UpdateBooleanDynamicCondition,
"updateBrandDynamicCondition": UpdateBrandDynamicCondition,
"updateBrandListDynamicCondition": UpdateBrandListDynamicCondition,
"updateCategoryDynamicCondition": UpdateCategoryDynamicCondition,
"updateCategoryListDynamicCondition": UpdateCategoryListDynamicCondition,
"updateColorListDynamicCondition": UpdateColorListDynamicCondition,
"updateComboboxDynamicCondition": UpdateComboboxDynamicCondition,
"updateCommonVoucherDynamicCondition": UpdateCommonVoucherDynamicCondition,
"updateCustomerSegmentDynamicCondition": UpdateCustomerSegmentDynamicCondition,
"updateDateDynamicCondition": UpdateDateDynamicCondition,
"updateDoubleDynamicCondition": UpdateDoubleDynamicCondition,
"updateDoubleTextDynamicCondition": UpdateDoubleTextDynamicCondition,
"updateFilterDynamicCondition": UpdateFilterDynamicCondition,
"updateIntegerDynamicCondition": UpdateIntegerDynamicCondition,
"updateIntegerComparisonDynamicCondition": UpdateIntegerComparisonDynamicCondition,
"updateMonetaryAmountComparisonDynamicCondition": UpdateMonetaryAmountComparisonDynamicCondition,
"updateMonetaryAmountDynamicCondition": UpdateMonetaryAmountDynamicCondition,
"updatePersonalVoucherDynamicCondition": UpdatePersonalVoucherDynamicCondition,
"updatePriceFilterDynamicCondition": UpdatePriceFilterDynamicCondition,
"updateProductListDynamicCondition": UpdateProductListDynamicCondition,
"updateRangeFilterDynamicCondition": UpdateRangeFilterDynamicCondition,
"updateStringListDynamicCondition": UpdateStringListDynamicCondition,
"updateTextDynamicCondition": UpdateTextDynamicCondition,
"updateTouchpointDynamicCondition": UpdateTouchpointDynamicCondition,
"updateUserInterestDynamicCondition": UpdateUserInterestDynamicCondition,
"updateUserTypeDynamicCondition": UpdateUserTypeDynamicCondition,
"updateVoidDynamicCondition": UpdateVoidDynamicCondition
}
UpdateSmartCategory
Fields
| Input Field | Description |
|---|---|
updateOrCondition - UpdateOrCondition
|
|
setBasicSettingsUrl - SetBasicSettingsUrl
|
|
setBasicSettingsDescription - SetBasicSettingsDescription
|
|
setTimeValidity - SetPageTimeValidity
|
|
setSkuSort - SetBooleanValueCondition
|
|
setResultLimit - SetSmartCategoryResultLimit
|
Example
{
"updateOrCondition": UpdateOrCondition,
"setBasicSettingsUrl": SetBasicSettingsUrl,
"setBasicSettingsDescription": SetBasicSettingsDescription,
"setTimeValidity": SetPageTimeValidity,
"setSkuSort": SetBooleanValueCondition,
"setResultLimit": SetSmartCategoryResultLimit
}
UpdateSmartCategoryOperation
Fields
| Input Field | Description |
|---|---|
setBasicNodeSettings - SetBasicNodeExtendedSettings
|
|
updateSmartCategory - UpdateSmartCategory
|
|
updateArchive - UpdateArchive
|
Example
{
"setBasicNodeSettings": SetBasicNodeExtendedSettings,
"updateSmartCategory": UpdateSmartCategory,
"updateArchive": "DELETE"
}
UpdateSmartProductCinema
Fields
| Input Field | Description |
|---|---|
updateOrCondition - UpdateOrCondition!
|
Example
{"updateOrCondition": UpdateOrCondition}
UpdateSpecialPriceBenefit
Description
Input parameters for SpecialPriceBenefit
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Benefit ID |
ops - [UpdateSpecialPriceBenefitOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateSpecialPriceBenefitOperation]
}
UpdateSpecialPriceBenefitOperation
Description
Input parameters operations for UpdateSpecialPriceBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setBenefitItems - SetBenefitItems
|
Selectable items |
setMaxSelectableItems - SetMaxSelectableItems
|
Max selectable items |
removeBenefitImage - RemoveBenefitImage
|
Remove image for benefit |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setBenefitItems": SetBenefitItems,
"setMaxSelectableItems": SetMaxSelectableItems,
"removeBenefitImage": RemoveBenefitImage
}
UpdateStaticContentInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Asset id |
ops - [UpdateStaticContentOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateStaticContentOperation]
}
UpdateStaticContentOperation
Fields
| Input Field | Description |
|---|---|
setIndexHtmlContent - SetIndexHtmlContent
|
Content for static content's index html file |
Example
{"setIndexHtmlContent": SetIndexHtmlContent}
UpdateStringListDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateStringListDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateStringListDynamicConditionOperation]
}
UpdateStringListDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setStringList - SetStringListConditionValue
|
String values |
Example
{
"setNegated": SetNegated,
"setStringList": SetStringListConditionValue
}
UpdateStringRange
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateStringRangeOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateStringRangeOperation]
}
UpdateStringRangeOperation
Description
Set exactly one of the fields
Fields
| Input Field | Description |
|---|---|
setWeight - SetIntWeight
|
|
setStringRangeValue - SetStringRangeValue
|
Example
{
"setWeight": SetIntWeight,
"setStringRangeValue": SetStringRangeValue
}
UpdateTabDynamicAttribute
Fields
| Input Field | Description |
|---|---|
attributeId - EntityId!
|
Id of the specific attribute of a teaser or tab |
setValue - SetGenericValueOperation!
|
Example
{
"attributeId": EntityId,
"setValue": SetGenericValueOperation
}
UpdateTabIndex
UpdateTabIndexByIndex
UpdateTabOperation
Fields
| Input Field | Description |
|---|---|
setTabName - SetTabName
|
|
setTabTrackingCode - SetTabTrackingCode
|
|
setTabSearchable - SetTabSearchable
|
|
setTimeValidity - SetTimeValidity
|
|
setValue - UpdateTabDynamicAttribute
|
Example
{
"setTabName": SetTabName,
"setTabTrackingCode": SetTabTrackingCode,
"setTabSearchable": SetTabSearchable,
"setTimeValidity": SetTimeValidity,
"setValue": UpdateTabDynamicAttribute
}
UpdateTabOperationInput
Description
UPDATE
Fields
| Input Field | Description |
|---|---|
tabId - EntityId!
|
|
ops - [UpdateTabOperation!]!
|
Example
{
"tabId": EntityId,
"ops": [UpdateTabOperation]
}
UpdateTagCloudRelationInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
ID of the link |
ops - [UpdateTagCloudRelationOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateTagCloudRelationOperation]
}
UpdateTagCloudRelationOperation
Fields
| Input Field | Description |
|---|---|
setPriority - SetPriority
|
|
setLinkName - SetNamedLinkName
|
|
setTitle - SetNamedLinkTitle
|
|
setTrackingInfo - SetNamedLinkTrackingCode
|
Example
{
"setPriority": SetPriority,
"setLinkName": SetNamedLinkName,
"setTitle": SetNamedLinkTitle,
"setTrackingInfo": SetNamedLinkTrackingCode
}
UpdateTakeAndPayBenefit
Description
Input parameters for TakeAndPayBenefit
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Benefit ID |
ops - [UpdateTakeAndPayBenefitOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateTakeAndPayBenefitOperation]
}
UpdateTakeAndPayBenefitOperation
Description
Input parameters operations for UpdateTakeAndPayBenefit
Fields
| Input Field | Description |
|---|---|
setBenefitTitle - SetBenefitTitle
|
The maintained title of the benefit |
setBenefitImage - SetBenefitImage
|
The maintained image for the benefit |
setItemsYouTake - SetItemsYouTake
|
Number of items you take |
setItemsYouPay - SetItemsYouPay
|
Number of items you pay |
setOnlyOncePerOrder - SetOnlyOncePerOrder
|
If it is only once per order or not |
removeBenefitImage - RemoveBenefitImage
|
Remove image for benefit |
Example
{
"setBenefitTitle": SetBenefitTitle,
"setBenefitImage": SetBenefitImage,
"setItemsYouTake": SetItemsYouTake,
"setItemsYouPay": SetItemsYouPay,
"setOnlyOncePerOrder": SetOnlyOncePerOrder,
"removeBenefitImage": RemoveBenefitImage
}
UpdateTextDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateTextDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateTextDynamicConditionOperation]
}
UpdateTextDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setText - SetTextConditionValue
|
String value |
Example
{
"setNegated": SetNegated,
"setText": SetTextConditionValue
}
UpdateTouchpointDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateTouchpointDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateTouchpointDynamicConditionOperation]
}
UpdateTouchpointDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setTouchpoint - SetTouchpoint
|
Touchpoint id |
Example
{
"setNegated": SetNegated,
"setTouchpoint": SetTouchpoint
}
UpdateTouchpointInput
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Touchpoint ID |
ops - [UpdateTouchpointOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateTouchpointOperation]
}
UpdateTouchpointOperation
Fields
| Input Field | Description |
|---|---|
setName - SetName
|
The name of the touchpoint |
setDescription - SetDescription
|
The description of the touchpoint |
setPersisted - SetPersisted
|
Set Persisted |
updateOrCondition - UpdateOrCondition
|
Dynamic conditions |
Example
{
"setName": SetName,
"setDescription": SetDescription,
"setPersisted": SetPersisted,
"updateOrCondition": UpdateOrCondition
}
UpdateTranslationInput
Description
Operations to update single translation
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Id of translation to update |
ops - [UpdateTranslationOperation!]!
|
Operations to update translation |
Example
{
"id": EntityId,
"ops": [UpdateTranslationOperation]
}
UpdateTranslationOperation
Description
Operation to update translation
Fields
| Input Field | Description |
|---|---|
setMessageKey - SetMessageKey
|
Operation to set message key |
setMessageValue - SetMessageValue
|
Operation to set translation |
setMessageMcs - SetMessageMcs
|
Operation to set MultiChannelSelector |
Example
{
"setMessageKey": SetMessageKey,
"setMessageValue": SetMessageValue,
"setMessageMcs": SetMessageMcs
}
UpdateUserInformationInput
Description
Input for mutations
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
|
ops - [UpdateUserInformationOperation!]!
|
Example
{
"id": EntityId,
"ops": [UpdateUserInformationOperation]
}
UpdateUserInformationOperation
Description
Possible operations for updating the user information Only one operation should be present
Fields
| Input Field | Description |
|---|---|
setUserName - SetUserName
|
Set user username |
setUserPassword - SetUserPassword
|
Set user password |
setUserEmail - SetUserEmail
|
Set user email |
updateUserRoles - [UpdateUserRole!]
|
update user userRoles |
Example
{
"setUserName": SetUserName,
"setUserPassword": SetUserPassword,
"setUserEmail": SetUserEmail,
"updateUserRoles": [UpdateUserRole]
}
UpdateUserInterestDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateUserInterestDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateUserInterestDynamicConditionOperation]
}
UpdateUserInterestDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
addSimpleCondition - AddSimpleCondition
|
Reference to simple condition |
setIdentifier - SetIdentifier
|
Identifier value |
Example
{
"setNegated": SetNegated,
"addSimpleCondition": AddSimpleCondition,
"setIdentifier": SetIdentifier
}
UpdateUserRole
Fields
| Input Field | Description |
|---|---|
addUserRoles - [AddUserRole!]
|
add list of new userRoles contains role and list of permissions |
removeUserRoles - [RemoveUserRole!]
|
remove list of userRoles |
updateUserRoleShopPermissions - [UpdateUserRoleInput!]
|
update list of shop permissions in user role |
Example
{
"addUserRoles": [AddUserRole],
"removeUserRoles": [RemoveUserRole],
"updateUserRoleShopPermissions": [UpdateUserRoleInput]
}
UpdateUserRoleInput
Description
Operations to update single user/role relation
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Id of user/role relation to update |
ops - [UpdateUserRoleOperation!]!
|
Operations to update user/role relation |
Example
{
"id": EntityId,
"ops": [UpdateUserRoleOperation]
}
UpdateUserRoleOperation
UpdateUserSettingsInput
Description
Input for updating the settings of the current user Empty values mean the app default is used
Fields
| Input Field | Description |
|---|---|
language - SetLanguage
|
ISO 639-1 code of the language the user prefers |
hourFormat - SetHourFormat
|
Hour format for displaying (am/pm or 24hr) |
timeFormat - SetTimeFormat
|
Time format based on the Unicode Technical Standard #35 |
dateFormat - SetDateFormat
|
Date format based on the Unicode Technical Standard #35 |
dateTimeFormat - SetDateTimeFormat
|
Date and time format based on the Unicode Technical Standard #35 |
firstDayOfWeek - SetFirstDayOfWeek
|
Day the week starts for the user |
Example
{
"language": SetLanguage,
"hourFormat": SetHourFormat,
"timeFormat": SetTimeFormat,
"dateFormat": SetDateFormat,
"dateTimeFormat": SetDateTimeFormat,
"firstDayOfWeek": SetFirstDayOfWeek
}
UpdateUserTypeDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateUserTypeDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateUserTypeDynamicConditionOperation]
}
UpdateUserTypeDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
setUserType - SetUserTypeConditionValue
|
User type value |
Example
{
"setNegated": SetNegated,
"setUserType": SetUserTypeConditionValue
}
UpdateVoidDynamicCondition
Fields
| Input Field | Description |
|---|---|
id - EntityId!
|
Condition ID |
ops - [UpdateVoidDynamicConditionOperation!]!
|
List of operation commands to be updated |
Example
{
"id": EntityId,
"ops": [UpdateVoidDynamicConditionOperation]
}
UpdateVoidDynamicConditionOperation
Fields
| Input Field | Description |
|---|---|
setNegated - SetNegated
|
Negated option |
Example
{"setNegated": SetNegated}
UploadedMessageType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"SAME_FILE_EXISTS"
UploadedStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SUCCESS"
UrlParameterTemplateEntity
Description
Representation of a url parameter template.
This is only a start and should be extended with values you need.
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"name": "abc123",
"template": "abc123"
}
UrlParameterTemplateFilterInput
UrlParameterTemplateFindPayload
Description
A list of templates without further details as a result
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
The total amount of results found, unaffected by paging |
entries - [UrlParameterTemplateEntity!]!
|
The result list of url parameters, affected by paging |
Example
{
"totalCount": 987,
"entries": [UrlParameterTemplateEntity]
}
UrlParameterTemplatePagingInput
Description
All relevant information needed to conduct a search
Fields
| Input Field | Description |
|---|---|
pagingInput - Paging!
|
Paging information Default return 100 entries from start. Default = {limit: 100, offset: 0} |
sortInput - UrlParameterTemplateSortingInput!
|
Sorting information Default Ascending on template name. Default = {sortOrder: ASC, sortType: INFO} |
Example
{
"pagingInput": Paging,
"sortInput": UrlParameterTemplateSortingInput
}
UrlParameterTemplateSortTypeInput
Description
Enum describing by what descriptor the returned templates should be sorted
Values
| Enum Value | Description |
|---|---|
|
|
Sort by template name |
|
|
Sorts by inherited mcs, with entries of the current mcs always at the bottom. Sorting within the mcs entries is not defined. |
Example
"NAME"
UrlParameterTemplateSortingInput
Description
Sorting information
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
The sorting order. Default Ascending. Default = ASC |
sortType - UrlParameterTemplateSortTypeInput!
|
Which parameter should the result be sorted on. Default: template name. Default = INFO |
Example
{"sortOrder": "ASC", "sortType": "NAME"}
UserEntity
UserInformation
Description
Representaion of all relevant user information
Fields
| Field Name | Description |
|---|---|
id - ID!
|
ID of the current user |
version - Long!
|
Version of the current user |
name - String!
|
Username of the current user |
email - String
|
Email of the current user |
settings - UserSettings
|
Settings the current user has set |
userRoles - [UserRoleEntity!]!
|
User roles of the current user |
isSystemUser - Boolean!
|
User is system user |
Example
{
"id": 4,
"version": {},
"name": "abc123",
"email": "xyz789",
"settings": UserSettings,
"userRoles": [UserRoleEntity],
"isSystemUser": true
}
UserInformationCreatePayload
Fields
| Field Name | Description |
|---|---|
entries - [UserInformation!]!
|
List of user information |
Example
{"entries": [UserInformation]}
UserInformationDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": true}
UserInformationFilterInput
UserInformationPagingInput
Fields
| Input Field | Description |
|---|---|
sortInput - UserInformationSortInput!
|
Sorting information.{Default Descending on Id field}. Default = {sortOrder: ASC, sortColumn: NAME} |
pagingInput - Paging!
|
Paging information.{Default return 100 entries from start}. Default = {limit: 100, offset: 0} |
Example
{
"sortInput": UserInformationSortInput,
"pagingInput": Paging
}
UserInformationSortColumn
Description
Representation in which will the result be sorted
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NAME"
UserInformationSortInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
list order value (default order is ASC). Default = ASC |
sortColumn - UserInformationSortColumn!
|
Column names which are allowed to sort with. Default = NAME |
Example
{"sortOrder": "ASC", "sortColumn": "NAME"}
UserInformationUpdatePayload
Description
Mutation response after updating user information
Fields
| Field Name | Description |
|---|---|
entries - [UserInformation!]!
|
Example
{"entries": [UserInformation]}
UserInterestConditionType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
displayName - String!
|
|
description - String
|
|
userInterestTypes - [UserInterestType!]!
|
Example
{
"id": "4",
"displayName": "abc123",
"description": "abc123",
"userInterestTypes": [UserInterestType]
}
UserInterestConditionValue
Fields
| Field Name | Description |
|---|---|
value - SimpleCondition!
|
Condition Value of type simple |
internalIdentifier - String!
|
The idenifier of the condition type |
Example
{
"value": SimpleCondition,
"internalIdentifier": "abc123"
}
UserInterestType
Example
{
"descriptionId": 4,
"internalIdentifier": "abc123",
"displayName": "xyz789",
"description": "xyz789",
"valueType": "Text",
"predefinedValues": ["abc123"]
}
UserRoleCreatePayload
Description
Result of creation of user/role relation
Fields
| Field Name | Description |
|---|---|
entries - [UserRoleEntity!]!
|
List of created user/role relations |
Example
{"entries": [UserRoleEntity]}
UserRoleDeletePayload
Description
Result of deletion of user/role relation
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Always true |
Example
{"successful": true}
UserRoleEntity
Description
User/role relation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Id of entity |
version - Long!
|
Version of entity |
user - UserEntity!
|
Simplified backoffice user |
role - RoleEntity!
|
Role with user rights |
mcss - [Mcs!]!
|
MultiChannelSelectors to which this user/role relation applies |
Example
{
"id": 4,
"version": {},
"user": UserEntity,
"role": RoleEntity,
"mcss": [Mcs]
}
UserRoleFilterInput
Description
user ids, user names, role ids, role names and MultiChannelSelectors to filter user/role relations
Fields
| Input Field | Description |
|---|---|
userIds - [ID!]
|
List of user ids |
userNames - [String!]
|
Parts of user names |
roleIds - [ID!]
|
List of role ids |
roleNames - [String!]
|
Parts of role names |
rightTypes - [RightType!]
|
Types of right (role should have at least one right with one of these types) Default: MENU and GROUP |
mcsIds - [ID!]
|
List of MultiChannelSelector ids |
Example
{
"userIds": ["4"],
"userNames": ["xyz789"],
"roleIds": ["4"],
"roleNames": ["xyz789"],
"rightTypes": ["MENU"],
"mcsIds": ["4"]
}
UserRoleFindPayload
Description
User/role relations including total count
Fields
| Field Name | Description |
|---|---|
entries - [UserRoleEntity!]!
|
List of user/role relations |
totalCount - Int!
|
Number of found user/role relations |
Example
{"entries": [UserRoleEntity], "totalCount": 987}
UserRolePagingInput
Description
Sort order/type, limit and offset of results
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
Limit and offset Default: 100 (limit) and 0 (offset). Default = {limit: 100, offset: 0} |
sortOn - UserRoleSortInput!
|
Sort order Default: ascending by user name. Default = {sortOrder: ASC, sortType: USER} |
Example
{
"paging": Paging,
"sortOn": UserRoleSortInput
}
UserRoleSortInput
Description
Sort order and type
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
Sort order Default: ascending. Default = ASC |
sortType - UserRoleSortTypeInput!
|
Sort type Default: by user name. Default = USER |
Example
{"sortOrder": "ASC", "sortType": "USER"}
UserRoleSortTypeInput
Description
Sorting types for user/role relations
Values
| Enum Value | Description |
|---|---|
|
|
Sorting by user name |
|
|
Sorting by role name |
Example
"USER"
UserRoleUpdatePayload
Description
Result of update of user/role relation
Fields
| Field Name | Description |
|---|---|
entries - [UserRoleEntity!]!
|
List of updated user/role relations |
Example
{"entries": [UserRoleEntity]}
UserSettings
Description
Representaion of all user settings Empty values mean the app default is used
Fields
| Field Name | Description |
|---|---|
language - String
|
ISO 639-1 code of the language the user prefers |
hourFormat - HourFormat
|
Hour format for displaying (am/pm or 24hr) |
timeFormat - String
|
Time format based on the Unicode Technical Standard #35 |
dateFormat - String
|
Date format based on the Unicode Technical Standard #35 |
dateTimeFormat - String
|
Date and time format based on the Unicode Technical Standard #35 |
firstDayOfWeek - Weekday
|
Day the week starts for the user |
Example
{
"language": "xyz789",
"hourFormat": "AMPM",
"timeFormat": "xyz789",
"dateFormat": "abc123",
"dateTimeFormat": "abc123",
"firstDayOfWeek": "SUNDAY"
}
UserType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"UnknownGuest"
UserTypeConditionValue
Fields
| Field Name | Description |
|---|---|
value - UserType!
|
Example
{"value": "UnknownGuest"}
UsersFindPayload
Description
A list of users
Fields
| Field Name | Description |
|---|---|
entries - [UserInformation!]!
|
The list of users after applying paging information. |
totalCount - Int!
|
The complete count of users |
Example
{"entries": [UserInformation], "totalCount": 987}
VoucherCode
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the entity |
version - Long!
|
The version of the entity |
voucherGroup - VoucherGroup!
|
voucherGroup |
voucherCode - String!
|
Voucher code |
customerIdentifier - String
|
Customer Identifier |
promotions - [PromotionEntity!]!
|
Promotions list assigned to the Voucher |
redeemedCount - Int!
|
Remained redemptions per code |
Example
{
"id": "4",
"version": {},
"voucherGroup": VoucherGroup,
"voucherCode": "xyz789",
"customerIdentifier": "xyz789",
"promotions": [PromotionEntity],
"redeemedCount": 987
}
VoucherCodeCheckInput
VoucherCodeCheckList
Fields
| Field Name | Description |
|---|---|
voucherCode - VoucherCode
|
The voucher matching voucherCode and customer Identifier input |
status - VoucherStatus!
|
Voucher status |
remainingUsages - Int!
|
Number of remaining usages for voucher code |
Example
{
"voucherCode": VoucherCode,
"status": "CODE_NOT_FOUND",
"remainingUsages": 123
}
VoucherCodeCheckPayload
Fields
| Field Name | Description |
|---|---|
voucherCodeCheckGroup - [VoucherCodeCheckList!]!
|
Example
{"voucherCodeCheckGroup": [VoucherCodeCheckList]}
VoucherCodeFilterInput
VoucherCodeInformation
VoucherCodeSearchSuggestionFindPayload
Fields
| Field Name | Description |
|---|---|
entries - [String!]!
|
The list of voucher code search suggestions after limiting results and applying sorting and filtering. |
Example
{"entries": ["abc123"]}
VoucherCreatePayload
Fields
| Field Name | Description |
|---|---|
entries - [VoucherGroup!]!
|
The list of voucher groups after applying paging, sorting and filtering. |
Example
{"entries": [VoucherGroup]}
VoucherDeletePayload
Fields
| Field Name | Description |
|---|---|
successful - Boolean!
|
Example
{"successful": true}
VoucherFilterInput
Fields
| Input Field | Description |
|---|---|
type - VoucherType
|
The voucher type |
imported - Boolean
|
The imported flag |
isAssigned - Boolean
|
The assignment flag |
searchTerm - String
|
The searchTerm is used to filter by name and voucher code |
isExactName - Boolean
|
Boolean to determine if it will search for the exact name of the group or not. Default = false |
createdBy - String
|
The backoffice user that created the group and the user who last edited it |
voucherGroupIds - [ID!]
|
The voucher group ids |
Example
{
"type": "PERSONAL_VOUCHER",
"imported": true,
"isAssigned": true,
"searchTerm": "abc123",
"isExactName": true,
"createdBy": "xyz789",
"voucherGroupIds": [4]
}
VoucherGroup
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the entity |
version - Long!
|
The version of the entity |
mcs - Mcs!
|
The mcs of the entity |
name - String!
|
The name of the entity |
description - String
|
The description of the entity |
backofficeUserInfoAudit - BackofficeUserInfoAudit!
|
Voucher audit createdAt, updatedAt, createdBy, and updatedBy. |
regex - String!
|
The regex that is followed by the codes of the group |
type - VoucherType!
|
The type of voucher |
imported - Boolean!
|
Boolean to determine whether entity is imported or not |
maxPerCodeRedeemCount - Int!
|
The maximum number of times the code can be used for redemption |
maxPerUserRedeemCount - Int!
|
The maximum number of times the user can redeem the voucher |
codesInGroup - Int!
|
The number of codes in group |
Arguments
|
|
redeemedAmount - Int!
|
|
voucherCodesInfo - [VoucherCodeInformation!]!
|
Voucher codes assigned to the voucher group |
promotionsInfo - [PromotionEntity!]!
|
Promotions assigned to the voucher group |
usedByPromotion - Boolean!
|
A flag that indicates if the voucher group is used by promotion |
Example
{
"id": "4",
"version": {},
"mcs": Mcs,
"name": "abc123",
"description": "abc123",
"backofficeUserInfoAudit": BackofficeUserInfoAudit,
"regex": "abc123",
"type": "PERSONAL_VOUCHER",
"imported": false,
"maxPerCodeRedeemCount": 987,
"maxPerUserRedeemCount": 987,
"codesInGroup": 987,
"redeemedAmount": 987,
"voucherCodesInfo": [VoucherCodeInformation],
"promotionsInfo": [PromotionEntity],
"usedByPromotion": true
}
VoucherGroupFindPayload
Fields
| Field Name | Description |
|---|---|
entries - [VoucherGroup!]!
|
The list of voucher groups after applying paging, sorting and filtering. |
totalCount - Int!
|
The count of voucher groups |
Example
{"entries": [VoucherGroup], "totalCount": 987}
VoucherPagingInput
Fields
| Input Field | Description |
|---|---|
paging - Paging!
|
Paging information.{Default return 100 entries from start}. Default = {limit: 100, offset: 0} |
sortOn - VoucherSortingInput!
|
Sorting information.{Default Ascending on NAME field}. Default = {sortOrder: ASC, sortType: NAME} |
Example
{
"paging": Paging,
"sortOn": VoucherSortingInput
}
VoucherSearchSuggestionFindPayload
Fields
| Field Name | Description |
|---|---|
entries - [String!]!
|
The list of voucher search suggestions after limiting results and applying sorting and filtering. |
Example
{"entries": ["abc123"]}
VoucherSortColumn
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"INFO"
VoucherSortingInput
Fields
| Input Field | Description |
|---|---|
sortOrder - SortOrder!
|
Sort order. Default = ASC |
sortType - VoucherSortColumn!
|
Column names which are allowed to sort with. Default = NAME |
Example
{"sortOrder": "ASC", "sortType": "INFO"}
VoucherStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CODE_NOT_FOUND"
VoucherType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PERSONAL_VOUCHER"
VoucherUpdatePayload
Fields
| Field Name | Description |
|---|---|
entries - [VoucherGroup!]!
|
Example
{"entries": [VoucherGroup]}
Weekday
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SUNDAY"
WidgetKpiData
Description
Return type describing a single kpi
Fields
| Field Name | Description |
|---|---|
label - String!
|
Type, ID or name of the kpi |
totalCount - Float!
|
Amount of results |
unit - String
|
Unit of measurement of the values |
values - [KpiValue!]
|
List of individual values |
Example
{
"label": "xyz789",
"totalCount": 123.45,
"unit": "abc123",
"values": [KpiValue]
}
WithPageReferenceType
Fields
| Field Name | Description |
|---|---|
referenceType - PageReferenceType!
|
Possible Types
| WithPageReferenceType Types |
|---|
Example
{"referenceType": "NONE"}
ZipImportType
Description
Enum represents the import type of a zip file
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BULK_IMAGES"
_Service
Fields
| Field Name | Description |
|---|---|
sdl - String!
|
Example
{"sdl": "xyz789"}