queries.mdx 28 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352
  1. ---
  2. title: "Queries"
  3. generated: true
  4. ---
  5. <a name="activeadministrator"></a>
  6. ## activeAdministrator
  7. <GraphQLDoc
  8. type="query"
  9. typeName="activeAdministrator"
  10. typeLinks={{
  11. Administrator: '/reference/graphql-api/admin/object-types#administrator',
  12. }}
  13. >
  14. {`type Query {
  15. activeAdministrator: Administrator
  16. }`}
  17. </GraphQLDoc>
  18. <a name="activechannel"></a>
  19. ## activeChannel
  20. <GraphQLDoc
  21. type="query"
  22. typeName="activeChannel"
  23. typeLinks={{
  24. Channel: '/reference/graphql-api/admin/object-types#channel',
  25. }}
  26. >
  27. {`type Query {
  28. activeChannel: Channel!
  29. }`}
  30. </GraphQLDoc>
  31. <a name="administrator"></a>
  32. ## administrator
  33. <GraphQLDoc
  34. type="query"
  35. typeName="administrator"
  36. typeLinks={{
  37. Administrator: '/reference/graphql-api/admin/object-types#administrator',
  38. ID: '/reference/graphql-api/admin/object-types#id',
  39. }}
  40. >
  41. {`type Query {
  42. administrator(id: ID!): Administrator
  43. }`}
  44. </GraphQLDoc>
  45. <a name="administrators"></a>
  46. ## administrators
  47. <GraphQLDoc
  48. type="query"
  49. typeName="administrators"
  50. typeLinks={{
  51. AdministratorList: '/reference/graphql-api/admin/object-types#administratorlist',
  52. AdministratorListOptions: '/reference/graphql-api/admin/input-types#administratorlistoptions',
  53. }}
  54. >
  55. {`type Query {
  56. administrators(options: AdministratorListOptions): AdministratorList!
  57. }`}
  58. </GraphQLDoc>
  59. <a name="asset"></a>
  60. ## asset
  61. <GraphQLDoc
  62. type="query"
  63. typeName="asset"
  64. typeLinks={{
  65. Asset: '/reference/graphql-api/admin/object-types#asset',
  66. ID: '/reference/graphql-api/admin/object-types#id',
  67. }}
  68. >
  69. {`"""Get a single Asset by id"""
  70. type Query {
  71. asset(id: ID!): Asset
  72. }`}
  73. </GraphQLDoc>
  74. <a name="assets"></a>
  75. ## assets
  76. <GraphQLDoc
  77. type="query"
  78. typeName="assets"
  79. typeLinks={{
  80. AssetList: '/reference/graphql-api/admin/object-types#assetlist',
  81. AssetListOptions: '/reference/graphql-api/admin/input-types#assetlistoptions',
  82. }}
  83. >
  84. {`"""Get a list of Assets"""
  85. type Query {
  86. assets(options: AssetListOptions): AssetList!
  87. }`}
  88. </GraphQLDoc>
  89. <a name="channel"></a>
  90. ## channel
  91. <GraphQLDoc
  92. type="query"
  93. typeName="channel"
  94. typeLinks={{
  95. Channel: '/reference/graphql-api/admin/object-types#channel',
  96. ID: '/reference/graphql-api/admin/object-types#id',
  97. }}
  98. >
  99. {`type Query {
  100. channel(id: ID!): Channel
  101. }`}
  102. </GraphQLDoc>
  103. <a name="channels"></a>
  104. ## channels
  105. <GraphQLDoc
  106. type="query"
  107. typeName="channels"
  108. typeLinks={{
  109. ChannelList: '/reference/graphql-api/admin/object-types#channellist',
  110. ChannelListOptions: '/reference/graphql-api/admin/input-types#channellistoptions',
  111. }}
  112. >
  113. {`type Query {
  114. channels(options: ChannelListOptions): ChannelList!
  115. }`}
  116. </GraphQLDoc>
  117. <a name="collection"></a>
  118. ## collection
  119. <GraphQLDoc
  120. type="query"
  121. typeName="collection"
  122. typeLinks={{
  123. Collection: '/reference/graphql-api/admin/object-types#collection',
  124. ID: '/reference/graphql-api/admin/object-types#id',
  125. String: '/reference/graphql-api/admin/object-types#string',
  126. }}
  127. >
  128. {`"""Get a Collection either by id or slug. If neither id nor slug is specified, an error will result."""
  129. type Query {
  130. collection(id: ID, slug: String): Collection
  131. }`}
  132. </GraphQLDoc>
  133. <a name="collectionfilters"></a>
  134. ## collectionFilters
  135. <GraphQLDoc
  136. type="query"
  137. typeName="collectionFilters"
  138. typeLinks={{
  139. ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
  140. }}
  141. >
  142. {`type Query {
  143. collectionFilters: [ConfigurableOperationDefinition!]!
  144. }`}
  145. </GraphQLDoc>
  146. <a name="collections"></a>
  147. ## collections
  148. <GraphQLDoc
  149. type="query"
  150. typeName="collections"
  151. typeLinks={{
  152. CollectionList: '/reference/graphql-api/admin/object-types#collectionlist',
  153. CollectionListOptions: '/reference/graphql-api/admin/input-types#collectionlistoptions',
  154. }}
  155. >
  156. {`type Query {
  157. collections(options: CollectionListOptions): CollectionList!
  158. }`}
  159. </GraphQLDoc>
  160. <a name="countries"></a>
  161. ## countries
  162. <GraphQLDoc
  163. type="query"
  164. typeName="countries"
  165. typeLinks={{
  166. CountryList: '/reference/graphql-api/admin/object-types#countrylist',
  167. CountryListOptions: '/reference/graphql-api/admin/input-types#countrylistoptions',
  168. }}
  169. >
  170. {`type Query {
  171. countries(options: CountryListOptions): CountryList!
  172. }`}
  173. </GraphQLDoc>
  174. <a name="country"></a>
  175. ## country
  176. <GraphQLDoc
  177. type="query"
  178. typeName="country"
  179. typeLinks={{
  180. Country: '/reference/graphql-api/admin/object-types#country',
  181. ID: '/reference/graphql-api/admin/object-types#id',
  182. }}
  183. >
  184. {`type Query {
  185. country(id: ID!): Country
  186. }`}
  187. </GraphQLDoc>
  188. <a name="customer"></a>
  189. ## customer
  190. <GraphQLDoc
  191. type="query"
  192. typeName="customer"
  193. typeLinks={{
  194. Customer: '/reference/graphql-api/admin/object-types#customer',
  195. ID: '/reference/graphql-api/admin/object-types#id',
  196. }}
  197. >
  198. {`type Query {
  199. customer(id: ID!): Customer
  200. }`}
  201. </GraphQLDoc>
  202. <a name="customergroup"></a>
  203. ## customerGroup
  204. <GraphQLDoc
  205. type="query"
  206. typeName="customerGroup"
  207. typeLinks={{
  208. CustomerGroup: '/reference/graphql-api/admin/object-types#customergroup',
  209. ID: '/reference/graphql-api/admin/object-types#id',
  210. }}
  211. >
  212. {`type Query {
  213. customerGroup(id: ID!): CustomerGroup
  214. }`}
  215. </GraphQLDoc>
  216. <a name="customergroups"></a>
  217. ## customerGroups
  218. <GraphQLDoc
  219. type="query"
  220. typeName="customerGroups"
  221. typeLinks={{
  222. CustomerGroupList: '/reference/graphql-api/admin/object-types#customergrouplist',
  223. CustomerGroupListOptions: '/reference/graphql-api/admin/input-types#customergrouplistoptions',
  224. }}
  225. >
  226. {`type Query {
  227. customerGroups(options: CustomerGroupListOptions): CustomerGroupList!
  228. }`}
  229. </GraphQLDoc>
  230. <a name="customers"></a>
  231. ## customers
  232. <GraphQLDoc
  233. type="query"
  234. typeName="customers"
  235. typeLinks={{
  236. CustomerList: '/reference/graphql-api/admin/object-types#customerlist',
  237. CustomerListOptions: '/reference/graphql-api/admin/input-types#customerlistoptions',
  238. }}
  239. >
  240. {`type Query {
  241. customers(options: CustomerListOptions): CustomerList!
  242. }`}
  243. </GraphQLDoc>
  244. <a name="eligibleshippingmethodsfordraftorder"></a>
  245. ## eligibleShippingMethodsForDraftOrder
  246. <GraphQLDoc
  247. type="query"
  248. typeName="eligibleShippingMethodsForDraftOrder"
  249. typeLinks={{
  250. ShippingMethodQuote: '/reference/graphql-api/admin/object-types#shippingmethodquote',
  251. ID: '/reference/graphql-api/admin/object-types#id',
  252. }}
  253. >
  254. {`"""Returns a list of eligible shipping methods for the draft Order"""
  255. type Query {
  256. eligibleShippingMethodsForDraftOrder(orderId: ID!): [ShippingMethodQuote!]!
  257. }`}
  258. </GraphQLDoc>
  259. <a name="entityduplicators"></a>
  260. ## entityDuplicators
  261. <GraphQLDoc
  262. type="query"
  263. typeName="entityDuplicators"
  264. typeLinks={{
  265. EntityDuplicatorDefinition: '/reference/graphql-api/admin/object-types#entityduplicatordefinition',
  266. }}
  267. >
  268. {`"""Returns all configured EntityDuplicators."""
  269. type Query {
  270. entityDuplicators: [EntityDuplicatorDefinition!]!
  271. }`}
  272. </GraphQLDoc>
  273. <a name="facet"></a>
  274. ## facet
  275. <GraphQLDoc
  276. type="query"
  277. typeName="facet"
  278. typeLinks={{
  279. Facet: '/reference/graphql-api/admin/object-types#facet',
  280. ID: '/reference/graphql-api/admin/object-types#id',
  281. }}
  282. >
  283. {`type Query {
  284. facet(id: ID!): Facet
  285. }`}
  286. </GraphQLDoc>
  287. <a name="facetvalue"></a>
  288. ## facetValue
  289. <GraphQLDoc
  290. type="query"
  291. typeName="facetValue"
  292. typeLinks={{
  293. FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
  294. ID: '/reference/graphql-api/admin/object-types#id',
  295. }}
  296. >
  297. {`type Query {
  298. facetValue(id: ID!): FacetValue
  299. }`}
  300. </GraphQLDoc>
  301. <a name="facetvalues"></a>
  302. ## facetValues
  303. <GraphQLDoc
  304. type="query"
  305. typeName="facetValues"
  306. typeLinks={{
  307. FacetValueList: '/reference/graphql-api/admin/object-types#facetvaluelist',
  308. FacetValueListOptions: '/reference/graphql-api/admin/input-types#facetvaluelistoptions',
  309. }}
  310. >
  311. {`type Query {
  312. facetValues(options: FacetValueListOptions): FacetValueList!
  313. }`}
  314. </GraphQLDoc>
  315. <a name="facets"></a>
  316. ## facets
  317. <GraphQLDoc
  318. type="query"
  319. typeName="facets"
  320. typeLinks={{
  321. FacetList: '/reference/graphql-api/admin/object-types#facetlist',
  322. FacetListOptions: '/reference/graphql-api/admin/input-types#facetlistoptions',
  323. }}
  324. >
  325. {`type Query {
  326. facets(options: FacetListOptions): FacetList!
  327. }`}
  328. </GraphQLDoc>
  329. <a name="fulfillmenthandlers"></a>
  330. ## fulfillmentHandlers
  331. <GraphQLDoc
  332. type="query"
  333. typeName="fulfillmentHandlers"
  334. typeLinks={{
  335. ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
  336. }}
  337. >
  338. {`type Query {
  339. fulfillmentHandlers: [ConfigurableOperationDefinition!]!
  340. }`}
  341. </GraphQLDoc>
  342. <a name="getsettingsstorevalue"></a>
  343. ## getSettingsStoreValue
  344. <GraphQLDoc
  345. type="query"
  346. typeName="getSettingsStoreValue"
  347. typeLinks={{
  348. JSON: '/reference/graphql-api/admin/object-types#json',
  349. String: '/reference/graphql-api/admin/object-types#string',
  350. }}
  351. >
  352. {`"""Get value for a specific key (automatically scoped based on field configuration)"""
  353. type Query {
  354. getSettingsStoreValue(key: String!): JSON
  355. }`}
  356. </GraphQLDoc>
  357. <a name="getsettingsstorevalues"></a>
  358. ## getSettingsStoreValues
  359. <GraphQLDoc
  360. type="query"
  361. typeName="getSettingsStoreValues"
  362. typeLinks={{
  363. JSON: '/reference/graphql-api/admin/object-types#json',
  364. String: '/reference/graphql-api/admin/object-types#string',
  365. }}
  366. >
  367. {`"""Get multiple key-value pairs (each automatically scoped)"""
  368. type Query {
  369. getSettingsStoreValues(keys: [String!]!): JSON
  370. }`}
  371. </GraphQLDoc>
  372. <a name="globalsettings"></a>
  373. ## globalSettings
  374. <GraphQLDoc
  375. type="query"
  376. typeName="globalSettings"
  377. typeLinks={{
  378. GlobalSettings: '/reference/graphql-api/admin/object-types#globalsettings',
  379. }}
  380. >
  381. {`type Query {
  382. globalSettings: GlobalSettings!
  383. }`}
  384. </GraphQLDoc>
  385. <a name="job"></a>
  386. ## job
  387. <GraphQLDoc
  388. type="query"
  389. typeName="job"
  390. typeLinks={{
  391. Job: '/reference/graphql-api/admin/object-types#job',
  392. ID: '/reference/graphql-api/admin/object-types#id',
  393. }}
  394. >
  395. {`type Query {
  396. job(jobId: ID!): Job
  397. }`}
  398. </GraphQLDoc>
  399. <a name="jobbuffersize"></a>
  400. ## jobBufferSize
  401. <GraphQLDoc
  402. type="query"
  403. typeName="jobBufferSize"
  404. typeLinks={{
  405. JobBufferSize: '/reference/graphql-api/admin/object-types#jobbuffersize',
  406. String: '/reference/graphql-api/admin/object-types#string',
  407. }}
  408. >
  409. {`type Query {
  410. jobBufferSize(bufferIds: [String!]): [JobBufferSize!]!
  411. }`}
  412. </GraphQLDoc>
  413. <a name="jobqueues"></a>
  414. ## jobQueues
  415. <GraphQLDoc
  416. type="query"
  417. typeName="jobQueues"
  418. typeLinks={{
  419. JobQueue: '/reference/graphql-api/admin/object-types#jobqueue',
  420. }}
  421. >
  422. {`type Query {
  423. jobQueues: [JobQueue!]!
  424. }`}
  425. </GraphQLDoc>
  426. <a name="jobs"></a>
  427. ## jobs
  428. <GraphQLDoc
  429. type="query"
  430. typeName="jobs"
  431. typeLinks={{
  432. JobList: '/reference/graphql-api/admin/object-types#joblist',
  433. JobListOptions: '/reference/graphql-api/admin/input-types#joblistoptions',
  434. }}
  435. >
  436. {`type Query {
  437. jobs(options: JobListOptions): JobList!
  438. }`}
  439. </GraphQLDoc>
  440. <a name="jobsbyid"></a>
  441. ## jobsById
  442. <GraphQLDoc
  443. type="query"
  444. typeName="jobsById"
  445. typeLinks={{
  446. Job: '/reference/graphql-api/admin/object-types#job',
  447. ID: '/reference/graphql-api/admin/object-types#id',
  448. }}
  449. >
  450. {`type Query {
  451. jobsById(jobIds: [ID!]!): [Job!]!
  452. }`}
  453. </GraphQLDoc>
  454. <a name="me"></a>
  455. ## me
  456. <GraphQLDoc
  457. type="query"
  458. typeName="me"
  459. typeLinks={{
  460. CurrentUser: '/reference/graphql-api/admin/object-types#currentuser',
  461. }}
  462. >
  463. {`type Query {
  464. me: CurrentUser
  465. }`}
  466. </GraphQLDoc>
  467. <a name="metricsummary"></a>
  468. ## metricSummary
  469. <GraphQLDoc
  470. type="query"
  471. typeName="metricSummary"
  472. typeLinks={{
  473. MetricSummary: '/reference/graphql-api/admin/object-types#metricsummary',
  474. MetricSummaryInput: '/reference/graphql-api/admin/input-types#metricsummaryinput',
  475. }}
  476. >
  477. {`"""Get metrics for the given interval and metric types."""
  478. type Query {
  479. metricSummary(input: MetricSummaryInput): [MetricSummary!]!
  480. }`}
  481. </GraphQLDoc>
  482. <a name="order"></a>
  483. ## order
  484. <GraphQLDoc
  485. type="query"
  486. typeName="order"
  487. typeLinks={{
  488. Order: '/reference/graphql-api/admin/object-types#order',
  489. ID: '/reference/graphql-api/admin/object-types#id',
  490. }}
  491. >
  492. {`type Query {
  493. order(id: ID!): Order
  494. }`}
  495. </GraphQLDoc>
  496. <a name="orders"></a>
  497. ## orders
  498. <GraphQLDoc
  499. type="query"
  500. typeName="orders"
  501. typeLinks={{
  502. OrderList: '/reference/graphql-api/admin/object-types#orderlist',
  503. OrderListOptions: '/reference/graphql-api/admin/input-types#orderlistoptions',
  504. }}
  505. >
  506. {`type Query {
  507. orders(options: OrderListOptions): OrderList!
  508. }`}
  509. </GraphQLDoc>
  510. <a name="paymentmethod"></a>
  511. ## paymentMethod
  512. <GraphQLDoc
  513. type="query"
  514. typeName="paymentMethod"
  515. typeLinks={{
  516. PaymentMethod: '/reference/graphql-api/admin/object-types#paymentmethod',
  517. ID: '/reference/graphql-api/admin/object-types#id',
  518. }}
  519. >
  520. {`type Query {
  521. paymentMethod(id: ID!): PaymentMethod
  522. }`}
  523. </GraphQLDoc>
  524. <a name="paymentmethodeligibilitycheckers"></a>
  525. ## paymentMethodEligibilityCheckers
  526. <GraphQLDoc
  527. type="query"
  528. typeName="paymentMethodEligibilityCheckers"
  529. typeLinks={{
  530. ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
  531. }}
  532. >
  533. {`type Query {
  534. paymentMethodEligibilityCheckers: [ConfigurableOperationDefinition!]!
  535. }`}
  536. </GraphQLDoc>
  537. <a name="paymentmethodhandlers"></a>
  538. ## paymentMethodHandlers
  539. <GraphQLDoc
  540. type="query"
  541. typeName="paymentMethodHandlers"
  542. typeLinks={{
  543. ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
  544. }}
  545. >
  546. {`type Query {
  547. paymentMethodHandlers: [ConfigurableOperationDefinition!]!
  548. }`}
  549. </GraphQLDoc>
  550. <a name="paymentmethods"></a>
  551. ## paymentMethods
  552. <GraphQLDoc
  553. type="query"
  554. typeName="paymentMethods"
  555. typeLinks={{
  556. PaymentMethodList: '/reference/graphql-api/admin/object-types#paymentmethodlist',
  557. PaymentMethodListOptions: '/reference/graphql-api/admin/input-types#paymentmethodlistoptions',
  558. }}
  559. >
  560. {`type Query {
  561. paymentMethods(options: PaymentMethodListOptions): PaymentMethodList!
  562. }`}
  563. </GraphQLDoc>
  564. <a name="pendingsearchindexupdates"></a>
  565. ## pendingSearchIndexUpdates
  566. <GraphQLDoc
  567. type="query"
  568. typeName="pendingSearchIndexUpdates"
  569. typeLinks={{
  570. Int: '/reference/graphql-api/admin/object-types#int',
  571. }}
  572. >
  573. {`type Query {
  574. pendingSearchIndexUpdates: Int!
  575. }`}
  576. </GraphQLDoc>
  577. <a name="previewcollectionvariants"></a>
  578. ## previewCollectionVariants
  579. <GraphQLDoc
  580. type="query"
  581. typeName="previewCollectionVariants"
  582. typeLinks={{
  583. ProductVariantList: '/reference/graphql-api/admin/object-types#productvariantlist',
  584. PreviewCollectionVariantsInput: '/reference/graphql-api/admin/input-types#previewcollectionvariantsinput',
  585. ProductVariantListOptions: '/reference/graphql-api/admin/input-types#productvariantlistoptions',
  586. }}
  587. >
  588. {`"""Used for real-time previews of the contents of a Collection"""
  589. type Query {
  590. previewCollectionVariants(input: PreviewCollectionVariantsInput!, options: ProductVariantListOptions): ProductVariantList!
  591. }`}
  592. </GraphQLDoc>
  593. <a name="product"></a>
  594. ## product
  595. <GraphQLDoc
  596. type="query"
  597. typeName="product"
  598. typeLinks={{
  599. Product: '/reference/graphql-api/admin/object-types#product',
  600. ID: '/reference/graphql-api/admin/object-types#id',
  601. String: '/reference/graphql-api/admin/object-types#string',
  602. }}
  603. >
  604. {`"""Get a Product either by id or slug. If neither id nor slug is specified, an error will result."""
  605. type Query {
  606. product(id: ID, slug: String): Product
  607. }`}
  608. </GraphQLDoc>
  609. <a name="productoption"></a>
  610. ## productOption
  611. <GraphQLDoc
  612. type="query"
  613. typeName="productOption"
  614. typeLinks={{
  615. ProductOption: '/reference/graphql-api/admin/object-types#productoption',
  616. ID: '/reference/graphql-api/admin/object-types#id',
  617. }}
  618. >
  619. {`type Query {
  620. productOption(id: ID!): ProductOption
  621. }`}
  622. </GraphQLDoc>
  623. <a name="productoptiongroup"></a>
  624. ## productOptionGroup
  625. <GraphQLDoc
  626. type="query"
  627. typeName="productOptionGroup"
  628. typeLinks={{
  629. ProductOptionGroup: '/reference/graphql-api/admin/object-types#productoptiongroup',
  630. ID: '/reference/graphql-api/admin/object-types#id',
  631. }}
  632. >
  633. {`type Query {
  634. productOptionGroup(id: ID!): ProductOptionGroup
  635. }`}
  636. </GraphQLDoc>
  637. <a name="productoptiongroups"></a>
  638. ## productOptionGroups
  639. <GraphQLDoc
  640. type="query"
  641. typeName="productOptionGroups"
  642. typeLinks={{
  643. ProductOptionGroup: '/reference/graphql-api/admin/object-types#productoptiongroup',
  644. String: '/reference/graphql-api/admin/object-types#string',
  645. }}
  646. >
  647. {`type Query {
  648. productOptionGroups(filterTerm: String): [ProductOptionGroup!]!
  649. }`}
  650. </GraphQLDoc>
  651. <a name="productoptions"></a>
  652. ## productOptions
  653. <GraphQLDoc
  654. type="query"
  655. typeName="productOptions"
  656. typeLinks={{
  657. ProductOptionList: '/reference/graphql-api/admin/object-types#productoptionlist',
  658. ProductOptionListOptions: '/reference/graphql-api/admin/input-types#productoptionlistoptions',
  659. ID: '/reference/graphql-api/admin/object-types#id',
  660. }}
  661. >
  662. {`type Query {
  663. productOptions(options: ProductOptionListOptions, groupId: ID): ProductOptionList!
  664. }`}
  665. </GraphQLDoc>
  666. <a name="productvariant"></a>
  667. ## productVariant
  668. <GraphQLDoc
  669. type="query"
  670. typeName="productVariant"
  671. typeLinks={{
  672. ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
  673. ID: '/reference/graphql-api/admin/object-types#id',
  674. }}
  675. >
  676. {`"""Get a ProductVariant by id"""
  677. type Query {
  678. productVariant(id: ID!): ProductVariant
  679. }`}
  680. </GraphQLDoc>
  681. <a name="productvariants"></a>
  682. ## productVariants
  683. <GraphQLDoc
  684. type="query"
  685. typeName="productVariants"
  686. typeLinks={{
  687. ProductVariantList: '/reference/graphql-api/admin/object-types#productvariantlist',
  688. ProductVariantListOptions: '/reference/graphql-api/admin/input-types#productvariantlistoptions',
  689. ID: '/reference/graphql-api/admin/object-types#id',
  690. }}
  691. >
  692. {`"""List ProductVariants either all or for the specific product."""
  693. type Query {
  694. productVariants(options: ProductVariantListOptions, productId: ID): ProductVariantList!
  695. }`}
  696. </GraphQLDoc>
  697. <a name="products"></a>
  698. ## products
  699. <GraphQLDoc
  700. type="query"
  701. typeName="products"
  702. typeLinks={{
  703. ProductList: '/reference/graphql-api/admin/object-types#productlist',
  704. ProductListOptions: '/reference/graphql-api/admin/input-types#productlistoptions',
  705. }}
  706. >
  707. {`"""List Products"""
  708. type Query {
  709. products(options: ProductListOptions): ProductList!
  710. }`}
  711. </GraphQLDoc>
  712. <a name="promotion"></a>
  713. ## promotion
  714. <GraphQLDoc
  715. type="query"
  716. typeName="promotion"
  717. typeLinks={{
  718. Promotion: '/reference/graphql-api/admin/object-types#promotion',
  719. ID: '/reference/graphql-api/admin/object-types#id',
  720. }}
  721. >
  722. {`type Query {
  723. promotion(id: ID!): Promotion
  724. }`}
  725. </GraphQLDoc>
  726. <a name="promotionactions"></a>
  727. ## promotionActions
  728. <GraphQLDoc
  729. type="query"
  730. typeName="promotionActions"
  731. typeLinks={{
  732. ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
  733. }}
  734. >
  735. {`type Query {
  736. promotionActions: [ConfigurableOperationDefinition!]!
  737. }`}
  738. </GraphQLDoc>
  739. <a name="promotionconditions"></a>
  740. ## promotionConditions
  741. <GraphQLDoc
  742. type="query"
  743. typeName="promotionConditions"
  744. typeLinks={{
  745. ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
  746. }}
  747. >
  748. {`type Query {
  749. promotionConditions: [ConfigurableOperationDefinition!]!
  750. }`}
  751. </GraphQLDoc>
  752. <a name="promotions"></a>
  753. ## promotions
  754. <GraphQLDoc
  755. type="query"
  756. typeName="promotions"
  757. typeLinks={{
  758. PromotionList: '/reference/graphql-api/admin/object-types#promotionlist',
  759. PromotionListOptions: '/reference/graphql-api/admin/input-types#promotionlistoptions',
  760. }}
  761. >
  762. {`type Query {
  763. promotions(options: PromotionListOptions): PromotionList!
  764. }`}
  765. </GraphQLDoc>
  766. <a name="province"></a>
  767. ## province
  768. <GraphQLDoc
  769. type="query"
  770. typeName="province"
  771. typeLinks={{
  772. Province: '/reference/graphql-api/admin/object-types#province',
  773. ID: '/reference/graphql-api/admin/object-types#id',
  774. }}
  775. >
  776. {`type Query {
  777. province(id: ID!): Province
  778. }`}
  779. </GraphQLDoc>
  780. <a name="provinces"></a>
  781. ## provinces
  782. <GraphQLDoc
  783. type="query"
  784. typeName="provinces"
  785. typeLinks={{
  786. ProvinceList: '/reference/graphql-api/admin/object-types#provincelist',
  787. ProvinceListOptions: '/reference/graphql-api/admin/input-types#provincelistoptions',
  788. }}
  789. >
  790. {`type Query {
  791. provinces(options: ProvinceListOptions): ProvinceList!
  792. }`}
  793. </GraphQLDoc>
  794. <a name="role"></a>
  795. ## role
  796. <GraphQLDoc
  797. type="query"
  798. typeName="role"
  799. typeLinks={{
  800. Role: '/reference/graphql-api/admin/object-types#role',
  801. ID: '/reference/graphql-api/admin/object-types#id',
  802. }}
  803. >
  804. {`type Query {
  805. role(id: ID!): Role
  806. }`}
  807. </GraphQLDoc>
  808. <a name="roles"></a>
  809. ## roles
  810. <GraphQLDoc
  811. type="query"
  812. typeName="roles"
  813. typeLinks={{
  814. RoleList: '/reference/graphql-api/admin/object-types#rolelist',
  815. RoleListOptions: '/reference/graphql-api/admin/input-types#rolelistoptions',
  816. }}
  817. >
  818. {`type Query {
  819. roles(options: RoleListOptions): RoleList!
  820. }`}
  821. </GraphQLDoc>
  822. <a name="scheduledtasks"></a>
  823. ## scheduledTasks
  824. <GraphQLDoc
  825. type="query"
  826. typeName="scheduledTasks"
  827. typeLinks={{
  828. ScheduledTask: '/reference/graphql-api/admin/object-types#scheduledtask',
  829. }}
  830. >
  831. {`type Query {
  832. scheduledTasks: [ScheduledTask!]!
  833. }`}
  834. </GraphQLDoc>
  835. <a name="search"></a>
  836. ## search
  837. <GraphQLDoc
  838. type="query"
  839. typeName="search"
  840. typeLinks={{
  841. SearchResponse: '/reference/graphql-api/admin/object-types#searchresponse',
  842. SearchInput: '/reference/graphql-api/admin/input-types#searchinput',
  843. }}
  844. >
  845. {`type Query {
  846. search(input: SearchInput!): SearchResponse!
  847. }`}
  848. </GraphQLDoc>
  849. <a name="seller"></a>
  850. ## seller
  851. <GraphQLDoc
  852. type="query"
  853. typeName="seller"
  854. typeLinks={{
  855. Seller: '/reference/graphql-api/admin/object-types#seller',
  856. ID: '/reference/graphql-api/admin/object-types#id',
  857. }}
  858. >
  859. {`type Query {
  860. seller(id: ID!): Seller
  861. }`}
  862. </GraphQLDoc>
  863. <a name="sellers"></a>
  864. ## sellers
  865. <GraphQLDoc
  866. type="query"
  867. typeName="sellers"
  868. typeLinks={{
  869. SellerList: '/reference/graphql-api/admin/object-types#sellerlist',
  870. SellerListOptions: '/reference/graphql-api/admin/input-types#sellerlistoptions',
  871. }}
  872. >
  873. {`type Query {
  874. sellers(options: SellerListOptions): SellerList!
  875. }`}
  876. </GraphQLDoc>
  877. <a name="shippingcalculators"></a>
  878. ## shippingCalculators
  879. <GraphQLDoc
  880. type="query"
  881. typeName="shippingCalculators"
  882. typeLinks={{
  883. ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
  884. }}
  885. >
  886. {`type Query {
  887. shippingCalculators: [ConfigurableOperationDefinition!]!
  888. }`}
  889. </GraphQLDoc>
  890. <a name="shippingeligibilitycheckers"></a>
  891. ## shippingEligibilityCheckers
  892. <GraphQLDoc
  893. type="query"
  894. typeName="shippingEligibilityCheckers"
  895. typeLinks={{
  896. ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
  897. }}
  898. >
  899. {`type Query {
  900. shippingEligibilityCheckers: [ConfigurableOperationDefinition!]!
  901. }`}
  902. </GraphQLDoc>
  903. <a name="shippingmethod"></a>
  904. ## shippingMethod
  905. <GraphQLDoc
  906. type="query"
  907. typeName="shippingMethod"
  908. typeLinks={{
  909. ShippingMethod: '/reference/graphql-api/admin/object-types#shippingmethod',
  910. ID: '/reference/graphql-api/admin/object-types#id',
  911. }}
  912. >
  913. {`type Query {
  914. shippingMethod(id: ID!): ShippingMethod
  915. }`}
  916. </GraphQLDoc>
  917. <a name="shippingmethods"></a>
  918. ## shippingMethods
  919. <GraphQLDoc
  920. type="query"
  921. typeName="shippingMethods"
  922. typeLinks={{
  923. ShippingMethodList: '/reference/graphql-api/admin/object-types#shippingmethodlist',
  924. ShippingMethodListOptions: '/reference/graphql-api/admin/input-types#shippingmethodlistoptions',
  925. }}
  926. >
  927. {`type Query {
  928. shippingMethods(options: ShippingMethodListOptions): ShippingMethodList!
  929. }`}
  930. </GraphQLDoc>
  931. <a name="slugforentity"></a>
  932. ## slugForEntity
  933. <GraphQLDoc
  934. type="query"
  935. typeName="slugForEntity"
  936. typeLinks={{
  937. String: '/reference/graphql-api/admin/object-types#string',
  938. SlugForEntityInput: '/reference/graphql-api/admin/input-types#slugforentityinput',
  939. }}
  940. >
  941. {`"""Generate slug for entity"""
  942. type Query {
  943. slugForEntity(input: SlugForEntityInput!): String!
  944. }`}
  945. </GraphQLDoc>
  946. <a name="stocklocation"></a>
  947. ## stockLocation
  948. <GraphQLDoc
  949. type="query"
  950. typeName="stockLocation"
  951. typeLinks={{
  952. StockLocation: '/reference/graphql-api/admin/object-types#stocklocation',
  953. ID: '/reference/graphql-api/admin/object-types#id',
  954. }}
  955. >
  956. {`type Query {
  957. stockLocation(id: ID!): StockLocation
  958. }`}
  959. </GraphQLDoc>
  960. <a name="stocklocations"></a>
  961. ## stockLocations
  962. <GraphQLDoc
  963. type="query"
  964. typeName="stockLocations"
  965. typeLinks={{
  966. StockLocationList: '/reference/graphql-api/admin/object-types#stocklocationlist',
  967. StockLocationListOptions: '/reference/graphql-api/admin/input-types#stocklocationlistoptions',
  968. }}
  969. >
  970. {`type Query {
  971. stockLocations(options: StockLocationListOptions): StockLocationList!
  972. }`}
  973. </GraphQLDoc>
  974. <a name="tag"></a>
  975. ## tag
  976. <GraphQLDoc
  977. type="query"
  978. typeName="tag"
  979. typeLinks={{
  980. Tag: '/reference/graphql-api/admin/object-types#tag',
  981. ID: '/reference/graphql-api/admin/object-types#id',
  982. }}
  983. >
  984. {`type Query {
  985. tag(id: ID!): Tag!
  986. }`}
  987. </GraphQLDoc>
  988. <a name="tags"></a>
  989. ## tags
  990. <GraphQLDoc
  991. type="query"
  992. typeName="tags"
  993. typeLinks={{
  994. TagList: '/reference/graphql-api/admin/object-types#taglist',
  995. TagListOptions: '/reference/graphql-api/admin/input-types#taglistoptions',
  996. }}
  997. >
  998. {`type Query {
  999. tags(options: TagListOptions): TagList!
  1000. }`}
  1001. </GraphQLDoc>
  1002. <a name="taxcategories"></a>
  1003. ## taxCategories
  1004. <GraphQLDoc
  1005. type="query"
  1006. typeName="taxCategories"
  1007. typeLinks={{
  1008. TaxCategoryList: '/reference/graphql-api/admin/object-types#taxcategorylist',
  1009. TaxCategoryListOptions: '/reference/graphql-api/admin/input-types#taxcategorylistoptions',
  1010. }}
  1011. >
  1012. {`type Query {
  1013. taxCategories(options: TaxCategoryListOptions): TaxCategoryList!
  1014. }`}
  1015. </GraphQLDoc>
  1016. <a name="taxcategory"></a>
  1017. ## taxCategory
  1018. <GraphQLDoc
  1019. type="query"
  1020. typeName="taxCategory"
  1021. typeLinks={{
  1022. TaxCategory: '/reference/graphql-api/admin/object-types#taxcategory',
  1023. ID: '/reference/graphql-api/admin/object-types#id',
  1024. }}
  1025. >
  1026. {`type Query {
  1027. taxCategory(id: ID!): TaxCategory
  1028. }`}
  1029. </GraphQLDoc>
  1030. <a name="taxrate"></a>
  1031. ## taxRate
  1032. <GraphQLDoc
  1033. type="query"
  1034. typeName="taxRate"
  1035. typeLinks={{
  1036. TaxRate: '/reference/graphql-api/admin/object-types#taxrate',
  1037. ID: '/reference/graphql-api/admin/object-types#id',
  1038. }}
  1039. >
  1040. {`type Query {
  1041. taxRate(id: ID!): TaxRate
  1042. }`}
  1043. </GraphQLDoc>
  1044. <a name="taxrates"></a>
  1045. ## taxRates
  1046. <GraphQLDoc
  1047. type="query"
  1048. typeName="taxRates"
  1049. typeLinks={{
  1050. TaxRateList: '/reference/graphql-api/admin/object-types#taxratelist',
  1051. TaxRateListOptions: '/reference/graphql-api/admin/input-types#taxratelistoptions',
  1052. }}
  1053. >
  1054. {`type Query {
  1055. taxRates(options: TaxRateListOptions): TaxRateList!
  1056. }`}
  1057. </GraphQLDoc>
  1058. <a name="testeligibleshippingmethods"></a>
  1059. ## testEligibleShippingMethods
  1060. <GraphQLDoc
  1061. type="query"
  1062. typeName="testEligibleShippingMethods"
  1063. typeLinks={{
  1064. ShippingMethodQuote: '/reference/graphql-api/admin/object-types#shippingmethodquote',
  1065. TestEligibleShippingMethodsInput: '/reference/graphql-api/admin/input-types#testeligibleshippingmethodsinput',
  1066. }}
  1067. >
  1068. {`type Query {
  1069. testEligibleShippingMethods(input: TestEligibleShippingMethodsInput!): [ShippingMethodQuote!]!
  1070. }`}
  1071. </GraphQLDoc>
  1072. <a name="testshippingmethod"></a>
  1073. ## testShippingMethod
  1074. <GraphQLDoc
  1075. type="query"
  1076. typeName="testShippingMethod"
  1077. typeLinks={{
  1078. TestShippingMethodResult: '/reference/graphql-api/admin/object-types#testshippingmethodresult',
  1079. TestShippingMethodInput: '/reference/graphql-api/admin/input-types#testshippingmethodinput',
  1080. }}
  1081. >
  1082. {`type Query {
  1083. testShippingMethod(input: TestShippingMethodInput!): TestShippingMethodResult!
  1084. }`}
  1085. </GraphQLDoc>
  1086. <a name="zone"></a>
  1087. ## zone
  1088. <GraphQLDoc
  1089. type="query"
  1090. typeName="zone"
  1091. typeLinks={{
  1092. Zone: '/reference/graphql-api/admin/object-types#zone',
  1093. ID: '/reference/graphql-api/admin/object-types#id',
  1094. }}
  1095. >
  1096. {`type Query {
  1097. zone(id: ID!): Zone
  1098. }`}
  1099. </GraphQLDoc>
  1100. <a name="zones"></a>
  1101. ## zones
  1102. <GraphQLDoc
  1103. type="query"
  1104. typeName="zones"
  1105. typeLinks={{
  1106. ZoneList: '/reference/graphql-api/admin/object-types#zonelist',
  1107. ZoneListOptions: '/reference/graphql-api/admin/input-types#zonelistoptions',
  1108. }}
  1109. >
  1110. {`type Query {
  1111. zones(options: ZoneListOptions): ZoneList!
  1112. }`}
  1113. </GraphQLDoc>