Merge pull request #7436 from magento/kh_graphql-customer-orders

GraphQL: Add support for order details in My Orders

Author: keharper

src/_includes/graphql/customer-address-output.md

@@ -1,4 +1,4 @@
-### CustomerAddress attributes {#customerAddressOutput}
+### Address attributes (CustomerAddress) {#customerAddressOutput}
 
 The values assigned to attributes such as `firstname` and `lastname` in this object may be different from those defined in the `Customer` object.
 
@@ -29,7 +29,7 @@ Attribute |  Data Type | Description
 `telephone` | String | The telephone number
 `vat_id` | String | The customer's Tax/VAT number (for corporate customers)
 
-### CustomerAddressAttribute attributes {#customerAddressAttributeOutput}
+#### CustomerAddressAttribute attributes {#customerAddressAttributeOutput}
 
 The `CustomerAddressAttribute` output data type has been deprecated because the contents are not applicable for GraphQL. It can contain the following attributes:
 
@@ -38,7 +38,7 @@ Attribute |  Data Type | Description
 `attribute_code` | String | Attribute code
 `value` | String | Attribute value
 
-### CustomerAddressRegion attributes {#customerAddressRegionOutput}
+#### CustomerAddressRegion attributes {#customerAddressRegionOutput}
 
 The `customerAddressRegion` output returns the following attributes:
 

src/_includes/graphql/customer-orders-output.md

@@ -1,6 +1,16 @@
+{% if page.url contains 'graphql/queries/customer.html' %}
+{% assign customeraddress_text = '[CustomerAddress](#customerAddressOutput)' %}
+{% assign customeroutput_text = '[CustomerOrders](#customerOrders)' %}
+{% assign crossref_text = '. See [`orders` input attributes](#orders) for details' %}
+{% else %}
+{% assign customeraddress_text = 'CustomerAddress' %}
+{% assign customeroutput_text = '[CustomerOrders]' %}
+{% assign crossref_text = '' %}
+{% endif %}
+
 Attribute |  Data Type | Description
 --- | --- | ---
-`addresses` | [CustomerAddress](#customerAddressOutput)  | An array containing the customer's shipping and billing addresses
+`addresses` | {{ customeraddress_text }}  | An array containing the customer's shipping and billing addresses
 `created_at` | String | Timestamp indicating when the account was created
 `date_of_birth` | String | The customer's date of birth
 `default_billing` | String | The ID assigned to the billing address
@@ -14,9 +24,8 @@ Attribute |  Data Type | Description
 `is_subscribed` | Boolean | Indicates whether the customer is subscribed to the company's newsletter
 `lastname` | String | The customer's family name
 `middlename` |String | The customer's middle name
+`orders(<FilterCriteria>)` | {{ customeroutput_text }} | A list of the customer's placed orders{{ crossref_text }}
 `prefix` | String | An honorific, such as Dr., Mr., or Mrs.
 `suffix` | String | A value such as Sr., Jr., or III
 `taxvat` | String | The customer's Tax/VAT number (for corporate customers)
 `wishlist` | Wishlist! | Contains the contents of the customer's wish lists
-
-{% include graphql/customer-address-output-24.md %}

src/_includes/graphql/customer-output-24.md

@@ -0,0 +1,76 @@
+---
+group: graphql
+title: changeCustomerPassword mutation
+---
+
+Use the `changeCustomerPassword` mutation to change the password for the logged-in customer.
+
+To return or modify information about a customer, Magento recommends you use customer tokens in the header of your GraphQL calls. However, you also can use [session authentication]({{ page.baseurl }}/get-started/authentication/gs-authentication-session.html).
+
+## Syntax
+
+`mutation: {changeCustomerPassword(currentPassword: String! newPassword: String!) {Customer}}`
+
+## Example usage
+
+The following call updates the customer's password.
+
+**Request:**
+
+```graphql
+mutation {
+  changeCustomerPassword(
+    currentPassword: "[email protected]"
+    newPassword: "[email protected]"
+  ) {
+    id
+    email
+  }
+}
+```
+
+**Response:**
+
+```json
+{
+  "data": {
+    "changeCustomerPassword": {
+      "id": 1,
+      "email": "[email protected]"
+    }
+  }
+}
+```
+
+## Input attributes
+
+The `changeCustomerPassword` mutation requires the following inputs:
+
+Attribute |  Data Type | Description
+--- | --- | ---
+`currentPassword` | String | The customer's current password
+`newPassword` | String | The customer's new password
+
+## Output attributes
+
+The `changeCustomerPassword` mutation returns the `customer` object.
+
+The following table lists the top-level attributes of the `customer` object. See the [`customer` query]({{page.baseurl}}/graphql/queries/customer.html) for complete details about this object.
+
+{% include graphql/customer-output-24.md %}
+
+## Errors
+
+Error | Description
+--- | ---
+`The current customer isn't authorized.` | The customer's token does not exist in the `oauth_token` table.
+`Invalid login or password.` | The password specified in the `currentPassword` argument is not valid.
+`Specify the "currentPassword" value.` | The password specified in the `currentPassword` argument is empty.
+`Specify the "newPassword" value.` | The password specified in the `newPassword` argument is empty.
+`The account is locked.` | The customer's password cannot be changed because the account is locked.
+
+## Related topics
+
+*  [customer query]({{page.baseurl}}/graphql/queries/customer.html)
+*  [createCustomer mutation]({{page.baseurl}}/graphql/mutations/create-customer.html)
+*  [updateCustomer mutation]({{page.baseurl}}/graphql/mutations/update-customer.html)

src/guides/v2.4/graphql/mutations/change-customer-password.md

@@ -65,6 +65,8 @@ The following table lists the attributes you can use as input for the `createCus
 
 The `createCustomer` mutation returns the `CustomerOutput` object.
 
+The following table lists the top-level attributes of the `customer` object. See the [`customer` query]({{page.baseurl}}/graphql/queries/customer.html) for complete details about this object.
+
 {% include graphql/customer-output-24.md %}
 
 ## Errors

src/guides/v2.4/graphql/mutations/change-customer-password.md

@@ -58,6 +58,8 @@ The following table lists the attributes you can use as input for the `updateCus
 
 The `updateCustomer` mutation returns the `CustomerOutput` object.
 
+The following table lists the top-level attributes of the `customer` object. See the [`customer` query]({{page.baseurl}}/graphql/queries/customer.html) for complete details about this object.
+
 {% include graphql/customer-output-24.md %}
 
 ## Related topics

src/guides/v2.4/graphql/mutations/create-customer.md

@@ -0,0 +1,88 @@
+---
+group: graphql
+title: customerOrders query
+---
+{:.bs-callout-warning}
+The `customerOrders` query has been deprecated. Specify the `orders` object in the [`customer`]({{page.baseurl}}/graphql/queries/customer.html) query instead.
+
+The Sales module performs a wide variety of functions, including order, invoice, and shipment management. However, most of these functions are performed on the backend, and the customer does not have access to this information. By returning a list of customer orders, the `customerOrders` query allows a customer to retrieve their order histories.
+
+Magento recommends you use customer tokens in the header of your GraphQL calls. However, you also can use [session authentication]({{ page.baseurl }}/get-started/authentication/gs-authentication-session.html).
+
+## Syntax
+
+`{customerOrders {CustomerOrders}}`
+
+## Example usage
+
+The following query returns the order history of the logged in customer.
+
+**Request:**
+
+```graphql
+{
+  customerOrders {
+    items {
+      order_number
+      id
+      created_at
+      grand_total
+      status
+    }
+  }
+}
+```
+
+**Response:**
+
+```json
+{
+  "data": {
+    "customerOrders": {
+      "items": [
+        {
+          "order_number": "000000001",
+          "id": 1,
+          "created_at": "2019-02-21 00:24:34",
+          "grand_total": 36.39,
+          "status": "processing"
+        },
+        {
+          "order_number": "000000002",
+          "id": 2,
+          "created_at": "2019-02-21 00:24:35",
+          "grand_total": 39.64,
+          "status": "closed"
+        }
+      ]
+    }
+  }
+}
+```
+
+## Output attributes
+
+The `CustomerOrders` object contains the `items` attribute.
+
+Attribute | Data type | Description
+--- | --- | ---
+`items` | [`[CustomerOrder]`](#customerOrderAttributes) | An array of customer orders
+
+### Customer order items attributes {#customerOrderAttributes}
+
+The `CustomerOrder` object defines details about each order the customer has placed.
+
+Attribute | Data type | Description
+--- | --- | ---
+`created_at` | String | A timestamp indicating when the order was placed
+`grand_total` | Float | The total of the order
+`id` | Int | The ID assigned to the customer's order
+`increment_id` | String | Deprecated. Use `order_number` instead. An ID that indicates the sequence of the order in the customer's order history
+`order_number` | String! | The order number assigned to the order
+`status` | String | The status of the order, such as `open`, `processing`, or `closed`
+
+## Errors
+
+Error | Description
+--- | ---
+`The current customer isn't authorized.` | The current customer is not currently logged in, or the customer's token does not exist in the `oauth_token` table.