Skip to content

Commit 0a043da

Browse files
tjoyaltjoyal
authored
Merge pull request #638 from Shopify/update-schemas
Update schemas
2 parents f794310 + c8f11d0 commit 0a043da

File tree

54 files changed

+1259
-1725
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+1259
-1725
lines changed

‎checkout/javascript/cart-checkout-validation/default/schema.graphql

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -77,21 +77,25 @@ type BuyerJourney {
7777
}
7878

7979
"""
80-
Different steps in the buyer journey.
80+
A specific stage in the customer's purchasing journey that indicates where the customer is in the checkout
81+
process.
8182
"""
8283
enum BuyerJourneyStep {
8384
"""
84-
Buyer is interacting with the cart.
85+
The customer is interacting with the cart. For example, the customer is adding items to the cart
86+
or removing items from the cart.
8587
"""
8688
CART_INTERACTION
8789

8890
"""
89-
Buyer is completing the checkout.
91+
The customer is completing checkout. For example, the customer is reviewing their order before
92+
finalizing the purchase.
9093
"""
9194
CHECKOUT_COMPLETION
9295

9396
"""
94-
Buyer is interacting with the checkout.
97+
The customer is interacting with checkout. For example, the customer is adding their shipping
98+
address or payment information.
9599
"""
96100
CHECKOUT_INTERACTION
97101
}
@@ -137,6 +141,13 @@ type Cart {
137141
fulfillment by organizing items that can be shipped together, based on the customer's
138142
shipping address. For example, if a customer orders a t-shirt and a pair of shoes that can be shipped
139143
together, then the items are included in the same delivery group.
144+
145+
In the [Order Discount](https://shopify.dev/docs/api/functions/reference/order-discounts) and
146+
[Product Discount](https://shopify.dev/docs/api/functions/reference/product-discounts) legacy APIs,
147+
the `cart.deliveryGroups` input is always an empty array. This means you can't access delivery groups when
148+
creating Order Discount or Product Discount Functions. If you need to apply discounts to shipping costs,
149+
then use the [Discount Function API](https://shopify.dev/docs/api/functions/reference/discount)
150+
instead.
140151
"""
141152
deliveryGroups: [CartDeliveryGroup!]!
142153

@@ -1763,8 +1774,9 @@ enum CountryCode {
17631774
}
17641775

17651776
"""
1766-
The three-letter currency codes that represent the world currencies used in stores. Currency codes include
1767-
[standard ISO 4217 codes](https://en.wikipedia.org/wiki/ISO_4217), legacy codes, and non-standard codes.
1777+
The currency codes that represent the world currencies throughout the Admin API. Currency codes include
1778+
[standard ISO 4217 codes](https://en.wikipedia.org/wiki/ISO_4217), legacy codes, non-standard codes,
1779+
digital currency codes.
17681780
"""
17691781
enum CurrencyCode {
17701782
"""
@@ -1890,7 +1902,7 @@ enum CurrencyCode {
18901902
"""
18911903
Belarusian Ruble (BYR).
18921904
"""
1893-
BYR @deprecated(reason: "`BYR` is deprecated. Use `BYN` available from version `2021-01` onwards instead.")
1905+
BYR @deprecated(reason: "Use `BYN` instead.")
18941906

18951907
"""
18961908
Belize Dollar (BZD).
@@ -2415,7 +2427,7 @@ enum CurrencyCode {
24152427
"""
24162428
Sao Tome And Principe Dobra (STD).
24172429
"""
2418-
STD @deprecated(reason: "`STD` is deprecated. Use `STN` available from version `2022-07` onwards instead.")
2430+
STD @deprecated(reason: "Use `STN` instead.")
24192431

24202432
"""
24212433
Sao Tome And Principe Dobra (STN).
@@ -2492,6 +2504,11 @@ enum CurrencyCode {
24922504
"""
24932505
USD
24942506

2507+
"""
2508+
United States Dollars Coin (USDC).
2509+
"""
2510+
USDC
2511+
24952512
"""
24962513
Uruguayan Pesos (UYU).
24972514
"""
@@ -2510,7 +2527,7 @@ enum CurrencyCode {
25102527
"""
25112528
Venezuelan Bolivares (VEF).
25122529
"""
2513-
VEF @deprecated(reason: "`VEF` is deprecated. Use `VES` available from version `2020-10` onwards instead.")
2530+
VEF @deprecated(reason: "Use `VES` instead.")
25142531

25152532
"""
25162533
Venezuelan Bolivares Soberanos (VES).
@@ -2807,13 +2824,14 @@ A Function error for a path.
28072824
"""
28082825
input FunctionError {
28092826
"""
2810-
Returns a message describing the error.
2827+
A description of the validation error. For example, "The product is out of stock" or
2828+
"The product isn't available for purchase in your region". The message is localized for the customer.
28112829
"""
28122830
localizedMessage: String!
28132831

28142832
"""
2815-
Specifies the path/target for use by the UI. See [Supported checkout field targets](https://shopify.dev/docs/api/functions/reference/cart-checkout-validation/graphql#supported-checkout-field-targets)
2816-
for a list of supported targets.
2833+
The [identifier](https://shopify.dev/docs/api/functions/reference/cart-checkout-validation/graphql#supported-checkout-field-targets)
2834+
in `shopify.extension.toml` that specifies where you're injecting code in the checkout process.
28172835
"""
28182836
target: String!
28192837
}

‎checkout/javascript/cart-transform/default/schema.graphql

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1694,8 +1694,9 @@ enum CountryCode {
16941694
}
16951695

16961696
"""
1697-
The three-letter currency codes that represent the world currencies used in stores. Currency codes include
1698-
[standard ISO 4217 codes](https://en.wikipedia.org/wiki/ISO_4217), legacy codes, and non-standard codes.
1697+
The currency codes that represent the world currencies throughout the Admin API. Currency codes include
1698+
[standard ISO 4217 codes](https://en.wikipedia.org/wiki/ISO_4217), legacy codes, non-standard codes,
1699+
digital currency codes.
16991700
"""
17001701
enum CurrencyCode {
17011702
"""
@@ -1821,7 +1822,7 @@ enum CurrencyCode {
18211822
"""
18221823
Belarusian Ruble (BYR).
18231824
"""
1824-
BYR @deprecated(reason: "`BYR` is deprecated. Use `BYN` available from version `2021-01` onwards instead.")
1825+
BYR @deprecated(reason: "Use `BYN` instead.")
18251826

18261827
"""
18271828
Belize Dollar (BZD).
@@ -2346,7 +2347,7 @@ enum CurrencyCode {
23462347
"""
23472348
Sao Tome And Principe Dobra (STD).
23482349
"""
2349-
STD @deprecated(reason: "`STD` is deprecated. Use `STN` available from version `2022-07` onwards instead.")
2350+
STD @deprecated(reason: "Use `STN` instead.")
23502351

23512352
"""
23522353
Sao Tome And Principe Dobra (STN).
@@ -2423,6 +2424,11 @@ enum CurrencyCode {
24232424
"""
24242425
USD
24252426

2427+
"""
2428+
United States Dollars Coin (USDC).
2429+
"""
2430+
USDC
2431+
24262432
"""
24272433
Uruguayan Pesos (UYU).
24282434
"""
@@ -2441,7 +2447,7 @@ enum CurrencyCode {
24412447
"""
24422448
Venezuelan Bolivares (VEF).
24432449
"""
2444-
VEF @deprecated(reason: "`VEF` is deprecated. Use `VES` available from version `2020-10` onwards instead.")
2450+
VEF @deprecated(reason: "Use `VES` instead.")
24452451

24462452
"""
24472453
Venezuelan Bolivares Soberanos (VES).

‎checkout/javascript/delivery-customization/default/schema.graphql

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,13 @@ type Cart {
113113
fulfillment by organizing items that can be shipped together, based on the customer's
114114
shipping address. For example, if a customer orders a t-shirt and a pair of shoes that can be shipped
115115
together, then the items are included in the same delivery group.
116+
117+
In the [Order Discount](https://shopify.dev/docs/api/functions/reference/order-discounts) and
118+
[Product Discount](https://shopify.dev/docs/api/functions/reference/product-discounts) legacy APIs,
119+
the `cart.deliveryGroups` input is always an empty array. This means you can't access delivery groups when
120+
creating Order Discount or Product Discount Functions. If you need to apply discounts to shipping costs,
121+
then use the [Discount Function API](https://shopify.dev/docs/api/functions/reference/discount)
122+
instead.
116123
"""
117124
deliveryGroups: [CartDeliveryGroup!]!
118125

@@ -1739,8 +1746,9 @@ enum CountryCode {
17391746
}
17401747

17411748
"""
1742-
The three-letter currency codes that represent the world currencies used in stores. Currency codes include
1743-
[standard ISO 4217 codes](https://en.wikipedia.org/wiki/ISO_4217), legacy codes, and non-standard codes.
1749+
The currency codes that represent the world currencies throughout the Admin API. Currency codes include
1750+
[standard ISO 4217 codes](https://en.wikipedia.org/wiki/ISO_4217), legacy codes, non-standard codes,
1751+
digital currency codes.
17441752
"""
17451753
enum CurrencyCode {
17461754
"""
@@ -1866,7 +1874,7 @@ enum CurrencyCode {
18661874
"""
18671875
Belarusian Ruble (BYR).
18681876
"""
1869-
BYR @deprecated(reason: "`BYR` is deprecated. Use `BYN` available from version `2021-01` onwards instead.")
1877+
BYR @deprecated(reason: "Use `BYN` instead.")
18701878

18711879
"""
18721880
Belize Dollar (BZD).
@@ -2391,7 +2399,7 @@ enum CurrencyCode {
23912399
"""
23922400
Sao Tome And Principe Dobra (STD).
23932401
"""
2394-
STD @deprecated(reason: "`STD` is deprecated. Use `STN` available from version `2022-07` onwards instead.")
2402+
STD @deprecated(reason: "Use `STN` instead.")
23952403

23962404
"""
23972405
Sao Tome And Principe Dobra (STN).
@@ -2468,6 +2476,11 @@ enum CurrencyCode {
24682476
"""
24692477
USD
24702478

2479+
"""
2480+
United States Dollars Coin (USDC).
2481+
"""
2482+
USDC
2483+
24712484
"""
24722485
Uruguayan Pesos (UYU).
24732486
"""
@@ -2486,7 +2499,7 @@ enum CurrencyCode {
24862499
"""
24872500
Venezuelan Bolivares (VEF).
24882501
"""
2489-
VEF @deprecated(reason: "`VEF` is deprecated. Use `VES` available from version `2020-10` onwards instead.")
2502+
VEF @deprecated(reason: "Use `VES` instead.")
24902503

24912504
"""
24922505
Venezuelan Bolivares Soberanos (VES).

‎checkout/javascript/payment-customization/default/schema.graphql

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,13 @@ type Cart {
113113
fulfillment by organizing items that can be shipped together, based on the customer's
114114
shipping address. For example, if a customer orders a t-shirt and a pair of shoes that can be shipped
115115
together, then the items are included in the same delivery group.
116+
117+
In the [Order Discount](https://shopify.dev/docs/api/functions/reference/order-discounts) and
118+
[Product Discount](https://shopify.dev/docs/api/functions/reference/product-discounts) legacy APIs,
119+
the `cart.deliveryGroups` input is always an empty array. This means you can't access delivery groups when
120+
creating Order Discount or Product Discount Functions. If you need to apply discounts to shipping costs,
121+
then use the [Discount Function API](https://shopify.dev/docs/api/functions/reference/discount)
122+
instead.
116123
"""
117124
deliveryGroups: [CartDeliveryGroup!]!
118125

@@ -1739,8 +1746,9 @@ enum CountryCode {
17391746
}
17401747

17411748
"""
1742-
The three-letter currency codes that represent the world currencies used in stores. Currency codes include
1743-
[standard ISO 4217 codes](https://en.wikipedia.org/wiki/ISO_4217), legacy codes, and non-standard codes.
1749+
The currency codes that represent the world currencies throughout the Admin API. Currency codes include
1750+
[standard ISO 4217 codes](https://en.wikipedia.org/wiki/ISO_4217), legacy codes, non-standard codes,
1751+
digital currency codes.
17441752
"""
17451753
enum CurrencyCode {
17461754
"""
@@ -1866,7 +1874,7 @@ enum CurrencyCode {
18661874
"""
18671875
Belarusian Ruble (BYR).
18681876
"""
1869-
BYR @deprecated(reason: "`BYR` is deprecated. Use `BYN` available from version `2021-01` onwards instead.")
1877+
BYR @deprecated(reason: "Use `BYN` instead.")
18701878

18711879
"""
18721880
Belize Dollar (BZD).
@@ -2391,7 +2399,7 @@ enum CurrencyCode {
23912399
"""
23922400
Sao Tome And Principe Dobra (STD).
23932401
"""
2394-
STD @deprecated(reason: "`STD` is deprecated. Use `STN` available from version `2022-07` onwards instead.")
2402+
STD @deprecated(reason: "Use `STN` instead.")
23952403

23962404
"""
23972405
Sao Tome And Principe Dobra (STN).
@@ -2468,6 +2476,11 @@ enum CurrencyCode {
24682476
"""
24692477
USD
24702478

2479+
"""
2480+
United States Dollars Coin (USDC).
2481+
"""
2482+
USDC
2483+
24712484
"""
24722485
Uruguayan Pesos (UYU).
24732486
"""
@@ -2486,7 +2499,7 @@ enum CurrencyCode {
24862499
"""
24872500
Venezuelan Bolivares (VEF).
24882501
"""
2489-
VEF @deprecated(reason: "`VEF` is deprecated. Use `VES` available from version `2020-10` onwards instead.")
2502+
VEF @deprecated(reason: "Use `VES` instead.")
24902503

24912504
"""
24922505
Venezuelan Bolivares Soberanos (VES).

0 commit comments

Comments
 (0)