Skip to content

Commit 134f02c

Browse files
keharperkeharper
committed
Major revisions
1 parent 962ae9d commit 134f02c

File tree

9 files changed

+86
-33
lines changed

9 files changed

+86
-33
lines changed

‎src/data/navigation/sections/graphql.js

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,10 @@ module.exports = [
127127
title: "Queries",
128128
path: "/graphql/schema/cart/queries/",
129129
pages: [
130+
{
131+
title: "allCartRules",
132+
path: "/graphql/schema/cart/queries/all-rules/",
133+
},
130134
{
131135
title: "cart",
132136
path: "/graphql/schema/cart/queries/cart/",
@@ -443,6 +447,14 @@ module.exports = [
443447
title: "Queries",
444448
path: "/graphql/schema/customer/queries/",
445449
pages: [
450+
{
451+
title: "allCustomerGroups",
452+
path: "/graphql/schema/customer/queries/all-groups/"
453+
},
454+
{
455+
title: "allCustomerSegments",
456+
path: "/graphql/schema/customer/queries/all-segments/"
457+
},
446458
{
447459
title: "customer",
448460
path: "/graphql/schema/customer/queries/customer/",
@@ -459,6 +471,10 @@ module.exports = [
459471
title: "customerOrders",
460472
path: "/graphql/schema/customer/queries/orders/",
461473
},
474+
{
475+
title: "customerSegments",
476+
path: "/graphql/schema/customer/queries/segments/"
477+
},
462478
{
463479
title: "giftCardAccount",
464480
path: "/graphql/schema/customer/queries/giftcard-account/",
@@ -801,6 +817,10 @@ module.exports = [
801817
title: "Queries",
802818
path: "/graphql/schema/products/queries/",
803819
pages: [
820+
{
821+
title: "allCatalogRules",
822+
path: "/graphql/schema/products/queries/all-rules/",
823+
},
804824
{
805825
title: "categories",
806826
path: "/graphql/schema/products/queries/categories/",

‎src/pages/graphql/schema/cart/queries/all-rules.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
---
2-
title: all cart rules query
2+
title: allCartRules query
3+
edition: ee
34
---
45

5-
# All cart rules query
6+
# allCartRules query
67

7-
The `allCartRules` query returns information about all active cart rules in the store.
8+
<InlineAlert variant="info" slots="text1" />
9+
10+
This query is part of the [Storefront Compatibility Package](https://experienceleague.adobe.com/developer/commerce/storefront/setup/storefront-compatibility/). It will be added to Adobe Commerce 2.4.8-beta4.
11+
12+
The `allCartRules` query returns a list of all active cart rules in the store.
813

914
## Syntax
1015

@@ -16,14 +21,14 @@ The `allCartRules` query returns information about all active cart rules in the
1621
}
1722
```
1823

24+
<!---
1925
## Reference
2026
2127
The [`allCartRules`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#query-all-cart-rules) reference provides detailed information about the types and fields defined in this query.
28+
-->
2229

2330
## Example usage
2431

25-
### Retrieve all cart rules
26-
2732
The following call returns a list of all active cart rules in the store.
2833

2934
**Request:**

‎src/pages/graphql/schema/cart/queries/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ title: Cart queries
44

55
# Cart queries
66

7-
The `cart` query returns the content of the shopper's cart. Adobe Commerce returns the [`Cart`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-Cart) object. This object is also returned by numerous mutations, including those that add products to the cart and prepare a cart for checkout.
7+
The [`cart`](./cart.md) query returns the content of the shopper's cart. Adobe Commerce returns the [`Cart`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#definition-Cart) object. This object is also returned by numerous mutations, including those that add products to the cart and prepare a cart for checkout.
88

9-
When Inventory Management is installed and configured, you can use the `pickupLocations` query to help a shopper determine whether their order can be picked up at a physical location. This query is most useful when the shopper has selected one or more items for purchase.
9+
The [`allCartRules`](./all-rules.md) query returns a list of available cart rules.
10+
11+
When Inventory Management is installed and configured, you can use the [`pickupLocations`](./pickup-locations.md) query to help a shopper determine whether their order can be picked up at a physical location. This query is most useful when the shopper has selected one or more items for purchase.

‎src/pages/graphql/schema/customer/queries/groups.md renamed to ‎src/pages/graphql/schema/customer/queries/all-groups.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
---
2-
title: all customer groups query
2+
title: allCustomerGroups query
3+
edition: ee
34
---
45

5-
# All customer groups query
6+
# allCustomerGroups query
67

7-
The `allCustomerGroups` query returns information about all customer groups available.
8+
<InlineAlert variant="info" slots="text1" />
9+
10+
This query is part of the [Storefront Compatibility Package](https://experienceleague.adobe.com/developer/commerce/storefront/setup/storefront-compatibility/). It will be added to Adobe Commerce 2.4.8-beta4.
11+
12+
The `allCustomerGroups` query returns a list of available customer groups.
813

914
## Syntax
1015

@@ -16,9 +21,11 @@ The `allCustomerGroups` query returns information about all customer groups avai
1621
}
1722
```
1823

24+
<!---
1925
## Reference
2026
2127
The [`allCustomerGroups`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#query-all-customer-groups) reference provides detailed information about the types and fields defined in this query.
28+
-->
2229

2330
## Example usage
2431

‎src/pages/graphql/schema/customer/queries/all-segments.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
---
2-
title: all customer segments query
2+
title: allCustomerSegments query
3+
edition: ee
34
---
45

5-
# All customer segments query
6+
# allCustomerSegments query
67

7-
The `allCustomerSegments` query returns information about all the customer segments available.
8+
<InlineAlert variant="info" slots="text1" />
9+
10+
This query is part of the [Storefront Compatibility Package](https://experienceleague.adobe.com/developer/commerce/storefront/setup/storefront-compatibility/). It will be added to Adobe Commerce 2.4.8-beta4.
11+
12+
The `allCustomerSegments` query returns information about the available customer segments.
813

914
## Syntax
1015

@@ -18,14 +23,14 @@ The `allCustomerSegments` query returns information about all the customer segme
1823
}
1924
```
2025

26+
<!--->
2127
## Reference
2228

2329
The [`allCustomerSegments`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#query-all-customer-segments) reference provides detailed information about the types and fields defined in this query.
30+
-->
2431

2532
## Example usage
2633

27-
### Retrieve all active customer segments
28-
2934
The following call returns a list of all active customer segments.
3035

3136
**Request:**
@@ -46,14 +51,14 @@ The following call returns a list of all active customer segments.
4651
{
4752
"allCustomerSegments": [
4853
{
49-
"name": "Segment A",
50-
"description": "Lorem ipsum",
54+
"name": "Guests",
55+
"description": "All shoppers who are not logged in",
5156
"apply_to": "VISITOR"
5257
},
5358
{
54-
"name": "Segment B",
55-
"description": "Lorem ipsum",
56-
"apply_to": "VISITOR"
59+
"name": "Registered",
60+
"description": "Applies to all logged-in customers",
61+
"apply_to": "REGISTERED"
5762
}
5863
]
5964
}

‎src/pages/graphql/schema/customer/queries/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,12 @@ title: Customer queries
66

77
Adobe Commerce provides the following customer-related queries:
88

9+
* [`allCustomerGroups`](all-groups.md)
10+
* [`allCustomerSegments`](all-segments.md)
911
* [`customer`](customer.md)
1012
* [`customerCart`](cart.md)
1113
* [`customerDownloadableProducts`](downloadable-products.md)
1214
* [`customerOrders`](orders.md)
15+
* [`customerSegments`](segments.md)
1316
* [`giftCardAccount`](giftcard-account.md)
1417
* [`isEmailAvailable`](is-email-available.md)

‎src/pages/graphql/schema/customer/queries/segments.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
---
2-
title: customer segments query
2+
title: customerSegments query
3+
edition: ee
34
---
45

5-
# customer segments query
6+
# customerSegments query
67

7-
The `customerSegments` query returns information about the customer segments associated with the current customer or guest/visitor.
8+
<InlineAlert variant="info" slots="text1" />
9+
10+
This query is part of the [Storefront Compatibility Package](https://experienceleague.adobe.com/developer/commerce/storefront/setup/storefront-compatibility/). It will be added to Adobe Commerce 2.4.8-beta4.
11+
12+
The `customerSegments` query returns information about the customer segments associated with the current customer or guest.
813

914
## Syntax
1015

@@ -16,14 +21,14 @@ The `customerSegments` query returns information about the customer segments ass
1621
}
1722
```
1823

24+
<!--->
1925
## Reference
2026

2127
The [`customerSegments`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#query-customer-segments) reference provides detailed information about the types and fields defined in this query.
28+
-->
2229

2330
## Example usage
2431

25-
### Retrieve segments information of a visitor
26-
2732
The following call returns segments currently applied to the visitor.
2833

2934
**Request:**
@@ -44,8 +49,8 @@ The following call returns segments currently applied to the visitor.
4449
{
4550
"customerSegments": [
4651
{
47-
"name": "Segment A",
48-
"description": "Segment applied to visitors only",
52+
"name": "Guests",
53+
"description": "All shoppers who are not logged in",
4954
"apply_to": "VISITOR"
5055
}
5156
]

‎src/pages/graphql/schema/products/queries/all-rules.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
---
2-
title: all catalog rules query
2+
title: allCatalogRules query
3+
edition: ee
34
---
45

5-
# All catalog rules query
6+
# allCatalogRules query
67

7-
The `allCatalogRules` query returns information about all active catalog rules in the store.
8+
<InlineAlert variant="info" slots="text1" />
9+
10+
This query is part of the [Storefront Compatibility Package](https://experienceleague.adobe.com/developer/commerce/storefront/setup/storefront-compatibility/). It will be added to Adobe Commerce 2.4.8-beta4.
11+
12+
The `allCatalogRules` query returns a list of all active catalog rules in the store.
813

914
## Syntax
1015

@@ -16,14 +21,14 @@ The `allCatalogRules` query returns information about all active catalog rules i
1621
}
1722
```
1823

24+
<!---
1925
## Reference
2026
21-
The [`allCatalogRules`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#query-all-catalog-rules) reference provides detailed information about the types and fields defined in this query.
27+
The [`allCatalogRules`](https://developer.adobe.com/commerce/webapi/graphql-api/index.html#query-all-catalog-rules) query returns a list of catalog rule names.
28+
-->
2229

2330
## Example usage
2431

25-
### Retrieve all catalog rules
26-
2732
The following call returns a list of all active catalog rules in the store.
2833

2934
**Request:**

‎src/pages/graphql/schema/products/queries/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ title: Product queries
66

77
This section describes the following queries:
88

9+
* [`allCatalogRules`](all-rules.md)
910
* [`categories`](categories.md)
1011
* [`category`](category.md)
1112
* [`categoryList`](category-list.md)

0 commit comments

Comments
 (0)