Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 2d7775c

Browse files
committed
incorporate developer feedback
1 parent 1a73b29 commit 2d7775c

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

guides/v2.3/graphql/queries.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ redirect_from:
55
- /guides/v2.3/graphql/search-pagination.html
66
---
77

8-
A GraphQL query retrieves data from the Magento server in a similar manner as a REST GET call. However, Magento GraphQL queries are not meant to be as comprehensive as their REST counterparts. The main purpose of the Magento GraphQL queries is to allow a mobile app or browser to render a wide variety of information, including the following:
8+
A GraphQL query retrieves data from the Magento server in a similar manner as a REST GET call. The current set of Magento GraphQL queries allow a mobile app or browser to render a wide variety of information, including the following:
99

1010
* A set of products to be displayed. This can include the entire catalog or those that match customer-specified criteria.
1111
* Customer data. With a customer token, a query can retrieve basic information about a customer as well as billing and shipping addresses, wishlists, order history, and other sensitive data.
@@ -14,6 +14,8 @@ A GraphQL query retrieves data from the Magento server in a similar manner as a
1414

1515
The Magento REST GET endpoints retrieve a wide variety of information on behalf of the merchant. Many of these endpoints are for retrieving backend information. For example, the `GET /V1/customers/search` endpoint can be used to find a subset of customers that meet certain criteria, such as those that live in a particular state or have a birthday this month. Likewise, the `GET /V1/invoices` endpoint can return all the recently-generated invoices. This type of functionality is not required for the frontend, so it is not available in GraphQL queries. The queries are designed to improve the customer's user experience by quickly retrieving the data needed to render pages.
1616

17+
Over time, the Magento GraphQL queries will duplicate the functionality of all storefront-facing GET calls, while making it possible to query more data in one request. The main difference will be that GraphQL will support storefront use cases, while REST will support admin use cases.
18+
1719
## Structure of a query
1820

1921
A query contains the following elements:

0 commit comments

Comments
 (0)