Updating Quote Endpoint with Query and Mutations #3838

erikmarr · 2019-02-28T17:52:30Z

This PR is a:

New topic
Content update
Content fix or rewrite
Bug fix or improvement

Summary

When this pull request is merged, it will fix #3337.

Additional information

List all affected URLs

https://devdocs.magento.com/guides/v2.3/graphql/reference/quote.html

whatsnew
Added queries and mutations to the quote endpoint

erikmarr · 2019-02-28T18:35:24Z

@keharper here's a build for your review:
https://devdocs.magedevteam.com/em_magento-graphqlQuote2/guides/v2.3/graphql/reference/quote.html

keharper · 2019-02-28T19:00:20Z

guides/v2.3/graphql/reference/quote.md

+
+### Syntax
+
+`cart: Cart`


Use the syntax displayed in the Graphiql browser

cart(cart_id: String!): Cart

keharper · 2019-02-28T19:01:21Z

guides/v2.3/graphql/reference/quote.md

+`billing_address` | [CartAddress](#cartAddressAttributes) | Contains the billing address specified in the customer's cart
+`cart_id` | String | The unique ID that identifies the customer's cart
+`items` | [CartItemInterface](#cartItemsInterface) | Contains the items in the customer's cart
+`shipping_addresses` | [CartAddress] | Contains one or more shipping addresses


Add .a link to CartAddress

keharper · 2019-02-28T19:04:12Z

guides/v2.3/graphql/reference/quote.md

+`shipping_addresses` | [CartAddress] | Contains one or more shipping addresses
+
+### Cart address attributes {#cartAddressAttributes}
+The cart address object can contain the following attributes:


List the object name.

keharper · 2019-02-28T19:22:16Z

guides/v2.3/graphql/reference/quote.md

+
+Attribute |  Data Type | Description
+--- | --- | ---
+`address_type` | [AddressTypeEnum] | Specifies if the type of address is shipping or billing


The square brackets around a data type indicates an array, which means it can have multiple values or parts. This enumeration can have only 1 value, SHIPPING or BILLING.

So, remove the brackets. Since the enumeration values are defined in all caps, I'm inclined to say use the same case. However, if there are a lot of all uppercase enumerations, that's going to feel like too much shouting. Use your best judgment on that.

decided to go with all caps. I don't believe there are many enums so I don't anticipate this being an issue.

keharper · 2019-02-28T20:06:18Z

guides/v2.3/graphql/reference/quote.md

+`telephone` | String | The telephone number for the shipping or billing address
+
+### Cart item interface attributes {#cartItemsInterface}
+The cart item interface object can contain the following attributes:


Include the object name

keharper · 2019-02-28T21:30:47Z

guides/v2.3/graphql/reference/quote.md

+
+You can set the billing and shipping addresses on a cart and specify shipping methods.
+
+### Set billing address on cart attributes


Suggested change

### Set billing address on cart attributes

### Set the billing address on cart attributes

keharper · 2019-02-28T21:30:59Z

guides/v2.3/graphql/reference/quote.md

+`billing_address` | [BillingAddressInput](#billingAddressInput) | The list of items to add to the cart
+`cart_id` | String | The unique ID that identifies the customer's cart
+
+### Set billing address input attributes {#billingAddressInput}


Suggested change

### Set billing address input attributes {#billingAddressInput}

### Set the billing address input attributes {#billingAddressInput}

keharper · 2019-02-28T21:31:27Z

guides/v2.3/graphql/reference/quote.md

+You can set the billing and shipping addresses on a cart and specify shipping methods.
+
+### Set billing address on cart attributes
+The Set billing address on cart object can contain the following attributes:


State the name of the object

keharper · 2019-02-28T21:31:57Z

guides/v2.3/graphql/reference/quote.md

+`cart_id` | String | The unique ID that identifies the customer's cart
+
+### Set billing address input attributes {#billingAddressInput}
+The Set billing address input object can contain the following attributes:


State the nsme of the object

keharper · 2019-02-28T21:33:27Z

guides/v2.3/graphql/reference/quote.md

+Adds simple items to a specific cart.
+
+### Add simple products to cart attributes
+The Add simple products to cart object can contain the following attributes:


State the nsme of the object

erikmarr

entered Kevin's edits

keharper

There's a broken link that has to be fixed. Send me the link to an updated build.

keharper · 2019-03-02T21:09:17Z

guides/v2.3/graphql/reference/quote.md

+  }
+}
+```
+<!--


addConfigurableProductsToCart mutation is defined in the ConfigurableProducts module. Issue 3779 covers this mutation, so remove the commented-out text. Also delete the commented out text toward the top of the topic.

guides/v2.3/graphql/reference/quote.md

keharper · 2019-03-02T21:54:02Z

guides/v2.3/graphql/reference/quote.md

+          postcode: "887766"
+          country_code: "US"
+          telephone: "88776655"
+          save_in_address_book: false


The description of this parameter says the boolean value is either True or False, with a capital letter. I don't know if it matters, but make them consistent.

Initial cap'd value.

guides/v2.3/graphql/reference/quote.md

keharper · 2019-03-02T22:00:12Z

guides/v2.3/graphql/reference/quote.md

+`street` | [String] | The street for the billing address
+`telephone` | String | The telephone number for the billing address
+
+### Set billing address on cart


Suggested change

### Set billing address on cart

### Set the billing address on a cart

keharper · 2019-03-02T22:00:58Z

guides/v2.3/graphql/reference/quote.md

+      cart_id: "4JQaNVJokOpFxrykGVvYrjhiNv9qt31C"
+      billing_address: {
+         address: {
+          firstname: "test firstname"


Make the address look realistic

keharper · 2019-03-02T22:01:20Z

guides/v2.3/graphql/reference/quote.md

+}
+```
+
+### Set shipping address on cart


Suggested change

### Set shipping address on cart

### Set the shipping address on cart

keharper

Approved, pending changes.

keharper · 2019-03-03T17:15:47Z

guides/v2.3/graphql/reference/quote.md

@@ -137,6 +118,9 @@ The following returns information about a cart given a `cart_id`. Note that the

 ## Mutations

+### Create an empty cart {#createEmptyCart}
+{:.no_toc}


This heading should appear in the right nav

removed text

keharper · 2019-03-03T17:23:41Z

guides/v2.3/graphql/reference/quote.md

  }
 }
 ```
+
+### Add and remove coupons from a cart


Move the coupons mutations to the bottom. They won't be used as frequently as the others.

keharper · 2019-03-03T17:25:52Z

guides/v2.3/graphql/reference/quote.md

+}
+```
+
+### Adding products to cart


Suggested change

### Adding products to cart

### Adding simple products to a cart

ghost · 2019-03-03T22:49:17Z

Hi @erikmarr, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

dshevtsov · 2019-03-25T19:45:05Z

@erikmarr
There is missing whatsnew for the Major Update PR.

updating with mutations

5e22379

erikmarr requested a review from keharper February 28, 2019 17:52

erikmarr self-assigned this Feb 28, 2019

erikmarr added Major Update Significant original updates to existing content Community Docs impacted by community code contribution xx2.3.1 Magento 2.3.1 changes labels Feb 28, 2019

erikmarr changed the title ~~updating with mutations~~ Updating Quote Endpoint with Query and Mutations Feb 28, 2019

keharper suggested changes Feb 28, 2019

View reviewed changes

erikmarr commented Mar 1, 2019

View reviewed changes

erikmarr added 2 commits March 1, 2019 13:36

entered edits from Kevin

13d9f4c

entering edits from kevin

671f261

keharper suggested changes Mar 2, 2019

View reviewed changes

entered more edits from kevin

12713d7

keharper approved these changes Mar 3, 2019

View reviewed changes

erikmarr added 2 commits March 3, 2019 13:51

more edits from kevin

ab5339f

added heading to appear in right nav

795fefe

erikmarr merged commit 475d8ec into 2.3.1-integration Mar 3, 2019

erikmarr deleted the em_magento-graphqlQuote2 branch March 5, 2019 16:49


		You can set the billing and shipping addresses on a cart and specify shipping methods.

		### Set billing address on cart attributes

	### Set billing address on cart attributes
	### Set the billing address on cart attributes

	### Set billing address input attributes {#billingAddressInput}
	### Set the billing address input attributes {#billingAddressInput}

	### Set billing address on cart
	### Set the billing address on a cart

	### Set shipping address on cart
	### Set the shipping address on cart

	### Adding products to cart
	### Adding simple products to a cart

Updating Quote Endpoint with Query and Mutations #3838

Updating Quote Endpoint with Query and Mutations #3838

Conversation

erikmarr commented Feb 28, 2019 • edited Loading

This PR is a:

Summary

Additional information

erikmarr commented Feb 28, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erikmarr left a comment

Choose a reason for hiding this comment

keharper left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

keharper left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Mar 3, 2019

dshevtsov commented Mar 25, 2019

erikmarr commented Feb 28, 2019 •

edited

Loading