OBJECT
Query
link GraphQL Schema definition
1 type Query { 2 3 # Gets shipping modes for the shopping cart. 4 # 5 # Equivalent to GET /store/{storeId}/cart/shipping_modes 6 # 7 # Arguments 8 # langId: Language identifier. If not specified, the "locale" 9 # parameter is used. If "locale" is not specified, then the store default language 10 # is used. 11 # locale: The locale to use for example, locale=en_US. If the 12 # "langId" parameter is specified, the "locale" parameter is ignored. If no locale 13 # is specified, the store default locale is used. 14 # responseFormat: The response format. Valid values are json and 15 # xml. If the request contains an input body, it must use the format specified in 16 # responseFormat. If the responseFormat is not specified, the accept HTTP header 17 # determines the format of the response. If the accept HTTP header is not 18 # specified then default response format is json. 19 # storeId: The store identifier. 20 ( 21 : String, 22 : String, 23 : ResponseFormat, 24 : String! 25 ): shippingModes 387 26 # Gets buyer purchase order information for the specified buyer purchase order ID. 27 # 28 # Equivalent to GET 29 # /store/{storeId}/cart/@self/buyer_purchase_order/{buyerPurchaseOrderId} 30 # 31 # Arguments 32 # buyerPurchaseOrderId: The buyer purchase order identifier. 33 # profileName: Profile name. Profiles determine the subset of 34 # data returned by a query. 35 # responseFormat: The response format. Valid values are json and 36 # xml. If the request contains an input body, it must use the format specified in 37 # responseFormat. If the responseFormat is not specified, the accept HTTP header 38 # determines the format of the response. If the accept HTTP header is not 39 # specified then default response format is json. 40 # storeId: The store identifier. 41 ( 42 : String!, 43 : String, 44 : ResponseFormat, 45 : String! 46 ): buyerPurchaseOrderSummary 387 47 # Gets order details for the shopping cart. 48 # 49 # Equivalent to GET /store/{storeId}/cart/@self 50 # 51 # Arguments 52 # currency: The currency code to use for example, currency=USD. 53 # If no currency code is specified, the store default currency is used. 54 # langId: Language identifier. If not specified, the locale 55 # parameter will be used. If locale isn't specified, then the store default 56 # language shall be used. 57 # pageNumber: Page number. Valid values are positive integers 58 # starting at 1. Use pageNumber with pageSize. 59 # pageSize: Page size. Used to limit the amount of data returned 60 # by a query. Valid values are integers starting with 1. Use pageSize with 61 # pageNumber. 62 # profileName: Profile name. Profiles determine the subset of 63 # data returned by a query. 64 # responseFormat: The response format. Valid values are json and 65 # xml. If the request contains an input body, it must use the format specified in 66 # responseFormat. If the responseFormat is not specified, the accept HTTP header 67 # determines the format of the response. If the accept HTTP header is not 68 # specified then default response format is json. 69 # sortOrderItemBy: The sort order of the results for example, 70 # sort by orderItemID. 71 # storeId: The store identifier. 72 ( 73 : Currency, 74 : String, 75 : Int, 76 : Int, 77 : ProfileName, 78 : ResponseFormat, 79 : String, 80 : String! 81 ): CartCartItem 387 82 # Gets payment attribute order information for the terms and conditions ID. 83 # 84 # Equivalent to GET 85 # /store/{storeId}/cart/@self/pattribute/{initKey_referenceNumber} 86 # 87 # Arguments 88 # initKeyReferenceNumber: The referenceNumber key of the access 89 # bean. 90 # profileName: Profile name. Profiles determine the subset of 91 # data returned by a query. 92 # responseFormat: The response format. Valid values are json and 93 # xml. If the request contains an input body, it must use the format specified in 94 # responseFormat. If the responseFormat is not specified, the accept HTTP header 95 # determines the format of the response. If the accept HTTP header is not 96 # specified then default response format is json. 97 # storeId: The store identifier. 98 ( 99 : String!, 100 : String, 101 : ResponseFormat, 102 : String! 103 ): PAttributeDetailed 387 104 # Lists payment policies for the store. 105 # 106 # Equivalent to GET /store/{storeId}/cart/@self/payment_policy_list 107 # 108 # Arguments 109 # profileName: Profile name. Profiles determine the subset of 110 # data returned by a query. 111 # responseFormat: The response format. Valid values are json and 112 # xml. If the request contains an input body, it must use the format specified in 113 # responseFormat. If the responseFormat is not specified, the accept HTTP header 114 # determines the format of the response. If the accept HTTP header is not 115 # specified then default response format is json. 116 # storeId: The store identifier. 117 ( 118 : String, 119 : ResponseFormat, 120 : String! 121 ): paymentPolicyListDetailed 387 122 # Gets billing address information for the specified order ID. 123 # 124 # Equivalent to GET /store/{storeId}/cart/@self/usable_billing_address/{orderId} 125 # 126 # Arguments 127 # orderId: The order ID. 128 # paymentTCId: The payment Term & Condition identifier for this 129 # payment instruction. 130 # profileName: Profile name. Profiles determine the subset of 131 # data returned by a query. 132 # responseFormat: The response format. Valid values are json and 133 # xml. If the request contains an input body, it must use the format specified in 134 # responseFormat. If the responseFormat is not specified, the accept HTTP header 135 # determines the format of the response. If the accept HTTP header is not 136 # specified then default response format is json. 137 # storeId: The store identifier. 138 ( 139 : String!, 140 : String, 141 : String, 142 : ResponseFormat, 143 : String! 144 ): usableBillingAddressListSummary 387 145 # Gets payment information for the shopping cart. 146 # 147 # Equivalent to GET /store/{storeId}/cart/@self/usable_payment_info 148 # 149 # Arguments 150 # orderId: The order ID. 151 # pageNumber: Page number. Valid values are positive integers 152 # starting at 1. Use pageNumber with pageSize. 153 # pageSize: Page size. Used to limit the amount of data returned 154 # by a query. Valid values are integers starting with 1. Use pageSize with 155 # pageNumber. 156 # responseFormat: The response format. Valid values are json and 157 # xml. If the request contains an input body, it must use the format specified in 158 # responseFormat. If the responseFormat is not specified, the accept HTTP header 159 # determines the format of the response. If the accept HTTP header is not 160 # specified then default response format is json. 161 # storeId: The store identifier. 162 ( 163 : String, 164 : Int, 165 : Int, 166 : ResponseFormat, 167 : String! 168 ): CartUsablePaymentInfo 387 169 # Gets usable shipping charge information for the specified order ID. 170 # 171 # Equivalent to GET 172 # /store/{storeId}/cart/{orderId}/usable_ship_charges_by_ship_mode 173 # 174 # Arguments 175 # orderId: The order ID. 176 # profileName: Profile name. Profiles determine the subset of 177 # data returned by a query. 178 # responseFormat: The response format. Valid values are json and 179 # xml. If the request contains an input body, it must use the format specified in 180 # responseFormat. If the responseFormat is not specified, the accept HTTP header 181 # determines the format of the response. If the accept HTTP header is not 182 # specified then default response format is json. 183 # storeId: The store identifier. 184 ( 185 : String!, 186 : String, 187 : ResponseFormat, 188 : String! 189 ): usableShipChargesByShipMode 387 190 # Gets shipping information for the shopping cart. 191 # 192 # Equivalent to GET /store/{storeId}/cart/@self/usable_shipping_info 193 # 194 # Arguments 195 # orderId: The order ID. 196 # pageNumber: Page number. Valid values are positive integers 197 # starting at 1. Use pageNumber with pageSize. 198 # pageSize: Page size. Used to limit the amount of data returned 199 # by a query. Valid values are integers starting with 1. Use pageSize with 200 # pageNumber. 201 # responseFormat: The response format. Valid values are json and 202 # xml. If the request contains an input body, it must use the format specified in 203 # responseFormat. If the responseFormat is not specified, the accept HTTP header 204 # determines the format of the response. If the accept HTTP header is not 205 # specified then default response format is json. 206 # storeId: The store identifier. 207 ( 208 : String, 209 : Int, 210 : Int, 211 : ResponseFormat, 212 : String! 213 ): CartUsableShippingInfo 387 214 # Gets assigned promotion codes for the shopping cart. 215 # 216 # Equivalent to GET /store/{storeId}/cart/@self/assigned_promotion_code 217 # 218 # Arguments 219 # responseFormat: The response format. If the request has an 220 # input body, that body must also use the format specified in "responseFormat". 221 # Valid values include "json" and "xml" without the quotes. If the responseFormat 222 # isn't specified, the "accept" HTTP header shall be used to determine the format 223 # of the response. If the "accept" HTTP header isn't specified as well, the 224 # default response format shall be in json. 225 # storeId: The store identifier. 226 ( 227 : ResponseFormat, 228 : String! 229 ): CartAssignedPromotionCode 387 230 # Gets assigned coupons for the shopping cart. 231 # 232 # Equivalent to GET /store/{storeId}/cart/@self/assigned_coupon 233 # 234 # Arguments 235 # responseFormat: The response format. Valid values are json and 236 # xml. If the request contains an input body, it must use the format specified in 237 # responseFormat. If the responseFormat is not specified, the accept HTTP header 238 # determines the format of the response. If the accept HTTP header is not 239 # specified then default response format is json. 240 # storeId: The store identifier. 241 ( 242 : ResponseFormat, 243 : String! 244 ): CartAssignedCoupon 387 245 # Gets payment instructions for the shopping cart. 246 # 247 # Equivalent to GET /store/{storeId}/cart/@self/payment_instruction/payment_token 248 # 249 # Arguments 250 # paymentMethod: payment_method 251 # paymentToken: payment_token 252 # responseFormat: The response format. If the request has an 253 # input body, that body must also use the format specified in "responseFormat". 254 # Valid values include "json" and "xml" without the quotes. If the responseFormat 255 # isn't specified, the "accept" HTTP header shall be used to determine the format 256 # of the response. If the "accept" HTTP header isn't specified as well, the 257 # default response format shall be in json. 258 # storeId: The store identifier. 259 ( 260 : String!, 261 : String!, 262 : ResponseFormat, 263 : String! 264 ): String 387 265 # Gets usable shipping information for the shopping cart by address. 266 # 267 # Equivalent to GET /store/{storeId}/cart/@self/usable_shipping_mode 268 # 269 # Arguments 270 # orderId: The order ID. 271 # pageNumber: Page number, starting at 1. Valid values include 272 # positive integers of 1 and above. The "pageSize" must be specified for paging to 273 # work. 274 # pageSize: Page size. Used to limit the amount of data returned 275 # by a query. Valid values include positive integers of 1 and above. The 276 # "pageNumber" must be specified for paging to work. 277 # responseFormat: The response format. If the request has an 278 # input body, that body must also use the format specified in "responseFormat". 279 # Valid values include "json" and "xml" without the quotes. If the responseFormat 280 # isn't specified, the "accept" HTTP header shall be used to determine the format 281 # of the response. If the "accept" HTTP header isn't specified as well, the 282 # default response format shall be in json. 283 # storeId: The store identifier. 284 ( 285 : String, 286 : Int, 287 : Int, 288 : ResponseFormat, 289 : String! 290 ): UsableShippingMode 387 291 # Gets payment instructions for the shopping cart. 292 # 293 # Equivalent to GET /store/{storeId}/cart/@self/payment_instruction 294 # 295 # Arguments 296 # currency: The currency code to use for example, currency=USD. 297 # If no currency code is specified, the store default currency is used. 298 # responseFormat: The response format. Valid values are json and 299 # xml. If the request contains an input body, it must use the format specified in 300 # responseFormat. If the responseFormat is not specified, the accept HTTP header 301 # determines the format of the response. If the accept HTTP header is not 302 # specified then default response format is json. 303 # storeId: The store identifier. 304 ( 305 : Currency, 306 : ResponseFormat, 307 : String! 308 ): CartPaymentInstruction 387 309 # Gets payment instruction for the punch-out payment. 310 # 311 # Equivalent to GET 312 # /store/{storeId}/cart/@self/payment_instruction/punchoutPaymentInfo 313 # 314 # Arguments 315 # currency: The currency code to use for example, currency=USD. 316 # If no currency code is specified, the store default currency is used. 317 # orderId: The order identifier. 318 # piId: The payment instruction identifier. 319 # responseFormat: The response format. Valid values are json and 320 # xml. If the request contains an input body, it must use the format specified in 321 # responseFormat. If the responseFormat is not specified, the accept HTTP header 322 # determines the format of the response. If the accept HTTP header is not 323 # specified then default response format is json. 324 # storeId: The store identifier. 325 ( 326 : Currency, 327 : String!, 328 : String!, 329 : ResponseFormat, 330 : String! 331 ): CartPaymentInstruction 387 332 # Gets sensitive data mask information for plain string. 333 # 334 # Equivalent to GET 335 # /store/{storeId}/cart/@self/payment_instruction/sensitive_data_mask_by_plain_string 336 # 337 # Arguments 338 # plainString: The plain string for the sensitive data. 339 # profileName: The plain string for the sensitive data. 340 # responseFormat: The response format. If the request has an 341 # input body, that body must also use the format specified in "responseFormat". 342 # Valid values include "json" and "xml" without the quotes. If the responseFormat 343 # isn't specified, the "accept" HTTP header shall be used to determine the format 344 # of the response. If the "accept" HTTP header isn't specified as well, the 345 # default response format shall be in json. 346 # storeId: The store identifier. 347 ( 348 : String, 349 : String, 350 : ResponseFormat, 351 : String! 352 ): EDPsensitiveDataMaskByPlainString 387 353 # Gets shipping information for the shopping cart. 354 # 355 # Equivalent to GET /store/{storeId}/cart/@self/shipping_info 356 # 357 # Arguments 358 # forUser: User name to act on behalf of. 359 # forUserId: User identifier to act on behalf of. 360 # langId: Language identifier. If not specified, the "locale" 361 # parameter is used. If "locale" is not specified, then the store default language 362 # is used. 363 # locale: The locale to use for example, locale=en_US. If the 364 # "langId" parameter is specified, the "locale" parameter is ignored. If no locale 365 # is specified, the store default locale is used. 366 # pageNumber: Page number. Valid values are positive integers 367 # starting at 1. Use pageNumber with pageSize. 368 # pageSize: Page size. Used to limit the amount of data returned 369 # by a query. Valid values are integers starting with 1. Use pageSize with 370 # pageNumber. 371 # responseFormat: The response format. Valid values are json and 372 # xml. If the request contains an input body, it must use the format specified in 373 # responseFormat. If the responseFormat is not specified, the accept HTTP header 374 # determines the format of the response. If the accept HTTP header is not 375 # specified then default response format is json. 376 # storeId: The store identifier. 377 ( 378 : String, 379 : String, 380 : String, 381 : String, 382 : Int, 383 : Int, 384 : ResponseFormat, 385 : String! 386 ): CartShippingInfo 388 389 }
link Required by
This element is not required by anyone