OBJECT
Query
link GraphQL Schema definition
1 type Query { 2 3 # Gets layout details by layout unique ID. 4 # 5 # Equivalent to GET /store/{storeId}/layout/{layoutId} 6 # 7 # Arguments 8 # layoutId: The layout unique ID. 9 # profileName: Profile name. Profiles determine the subset of 10 # data returned by a query. 11 # responseFormat: The response format. Valid values are json and 12 # xml. If the request contains an input body, it must use the format specified in 13 # responseFormat. If the responseFormat is not specified, the accept HTTP header 14 # determines the format of the response. If the accept HTTP header is not 15 # specified then default response format is json. 16 # storeId: The store identifier. 17 ( 18 BigInt!, : 19 ProfileName!, : 20 ResponseFormat, : 21 String! : 22 ): LayoutLayout 212 23 # Searches for layouts based on the layout state and the search criteria. The 24 # default sorting order is based on the created date of layouts. 25 # 26 # Equivalent to GET /store/{storeId}/layout 27 # 28 # Arguments 29 # deviceClass: The device class name 30 # layoutGroup: The layout group name 31 # layoutId: The layout unique ID. 32 # locationName: The location name search criteria. 33 # managingTool: The managing tool used. The Default value is 34 # IBM_COMMERCE_INSIGHTS_TOOL. 35 # name: The layout name search criteria. 36 # ownerID: The ownerID of the layout. When the managingTool is 37 # IBM_COMMERCE_INSIGHTS_TOOL, not specifying the ownerID parameter in a pagination 38 # request may result in variances based on the caller's Access Control privileges. 39 # pageNumber: Page number. Valid values are positive integers 40 # starting at 1. Use pageNumber with pageSize. 41 # pageSize: Page size. Used to limit the amount of data returned 42 # by a query. Valid values are integers starting with 1. Use pageSize with 43 # pageNumber. 44 # profileName: Profile name. Profiles determine the subset of 45 # data returned by a query. 46 # q: The query name. 47 # sortBy: The sort order for the layouts. The default sort 48 # criteria depends on the query. 49 # sortOrder: The sorting order. The default sort order is 50 # ascending. 51 # state: The state of the layout. If this parameter is not 52 # specified, the default state is Active. 53 # storeId: The store identifier. 54 # templateId: The unique ID of the template used by the layout. 55 ( 56 DeviceClass, : 57 String!, : 58 Int!, : 59 String, : 60 ManagingTool, : 61 String, : 62 BigInt, : 63 Int, : 64 Int, : 65 ProfileName!, : 66 Q2!, : 67 SortBy, : 68 SortOrder, : 69 String, : 70 String!, : 71 Int! : 72 ): LayoutLayout 212 73 # Finds pages by category IDs. Invalid category IDs are ignored. 74 # 75 # Equivalent to GET /store/{storeId}/page 76 # 77 # Arguments 78 # catalogEntryId: The catalog entry ID. 79 # categoryId: The category ID. 80 # name: The page name. 81 # pageId: The page ID. 82 # pageNumber: Page number, starting at 1. Valid values include 83 # positive integers of 1 and above. The "pageSize" must be specified for paging to 84 # work. 85 # pageSize: Page size. Used to limit the amount of data returned 86 # by a query. Valid values include positive integers of 1 and above. The 87 # "pageNumber" must be specified for paging to work. 88 # profileName: Profile name. Profiles determine the subset of 89 # data to be returned by a query. 90 # q: The query name. 91 # storeId: The store identifier. 92 # urlConfigurable: Whether the URL of the page is configurable. 93 ( 94 String!, : 95 String]!, : [ 96 String!, : 97 String!, : 98 Int, : 99 Int, : 100 ProfileName3, : 101 Q4!, : 102 String!, : 103 Boolean! : 104 ): PageIBMStoreDetailsSEO 212 105 # Finds a product display layout page by product ID. 106 # 107 # Equivalent to GET /store/{storeId}/page_design 108 # 109 # Arguments 110 # deviceClass: The deviceClass. 111 # layoutActivityId: The layout activity ID. 112 # layoutId: The layout ID. 113 # objectIdentifier: The object identifier 114 # pageGroup: The pageGroup. 115 # productId: The product ID. 116 # q: The query name. 117 # storeId: The store identifier. 118 ( 119 String!, : 120 String!, : 121 String!, : 122 String!, : 123 String!, : 124 String!, : 125 Q!, : 126 String! : 127 ): PageDesignIBMStoreDetails 212 128 # Finds a page by its name. 129 # 130 # Equivalent to GET /store/{storeId}/page/name/{name} 131 # 132 # Arguments 133 # name: The page name. 134 # profileName: Profile name. Profiles determine the subset of 135 # data returned by a query. 136 # storeId: The store identifier. 137 ( 138 String!, : 139 ProfileName3!, : 140 String! : 141 ): PageIBMStoreDetails 212 142 # Finds a page by its ID. 143 # 144 # Equivalent to GET /store/{storeId}/page/{pageId} 145 # 146 # Arguments 147 # pageId: The page ID. 148 # profileName: Profile name. Profiles determine the subset of 149 # data returned by a query. 150 # storeId: The store identifier. 151 ( 152 String!, : 153 ProfileName3!, : 154 String! : 155 ): PageIBMStoreDetails 212 156 # Finds widget definitions by widget types. Invalid widget types are ignored. 157 # 158 # Equivalent to GET /store/{storeId}/widget_definition 159 # 160 # Arguments 161 # dataLanguageIds: Data languages restrict the language specific 162 # data in the result to the languages specified. 163 # identifier: The widget definition identifier. 164 # includeInactiveWidgets: Boolean flag to indicate if inactive 165 # widget definitions must be included in the response. By default inactive widgets 166 # are filtered. 167 # pageNumber: Page number. Valid values are positive integers 168 # starting at 1. Use pageNumber with pageSize. 169 # pageSize: Page size. Used to limit the amount of data returned 170 # by a query. Valid values are integers starting with 1. Use pageSize with 171 # pageNumber. 172 # profileName: Profile name. Profiles determine the subset of 173 # data returned by a query. 174 # q: The query name. 175 # storeId: The store identifier. 176 # widgetDefinitionId: The widget definition ID. 177 # widgetType: The widget type. 178 ( 179 Int], : [ 180 String!, : 181 Boolean, : 182 Int, : 183 Int, : 184 ProfileName2, : 185 Q3!, : 186 String!, : 187 String!, : 188 Int]! : [ 189 ): WidgetDefinitionIBMAdminSummary 212 190 # Finds a widget definition by its identifier. 191 # 192 # Equivalent to GET /store/{storeId}/widget_definition/identifier/{identifier} 193 # 194 # Arguments 195 # identifier: The widget definition identifier. 196 # storeId: The store identifier. 197 ( 198 String!, : 199 String! : 200 ): WidgetDefinitionIBMStoreSummary 212 201 # Finds a widget definition by its ID. 202 # 203 # Equivalent to GET /store/{storeId}/widget_definition/{widgetDefinitionId} 204 # 205 # Arguments 206 # storeId: The store identifier. 207 # widgetDefinitionId: The widget definition ID. 208 ( 209 String!, : 210 String! : 211 ): WidgetDefinitionIBMStoreSummary 213 214 }
link Required by
This element is not required by anyone