diff --git a/_includes/graphql/cart-object.md b/_includes/graphql/cart-object.md index e8095eefad8..ec7df4933a6 100644 --- a/_includes/graphql/cart-object.md +++ b/_includes/graphql/cart-object.md @@ -7,6 +7,7 @@ Attribute | Data Type | Description `available_payment_methods` | [[AvailablePaymentMethod]][AvailablePaymentMethod] | Available payment methods `billing_address` | [BillingCartAddress][BillingCartAddress]! | Contains the billing address specified in the customer's cart `email` | String | The customer's email address +`is_virtual` | Boolean | Indicates whether the cart contains only virtual products `items` | [[CartItemInterface]][CartItemInterface] | Contains the items in the customer's cart `prices` | [CartPrices][CartPrices] | Contains subtotals and totals `selected_payment_method` | [SelectedPaymentMethod][SelectedPaymentMethod] | Selected payment method diff --git a/_includes/graphql/customer-address-input.md b/_includes/graphql/customer-address-input.md index cefbe8d9a39..127cb977df5 100644 --- a/_includes/graphql/customer-address-input.md +++ b/_includes/graphql/customer-address-input.md @@ -1,13 +1,13 @@ -### CustomerAddress input {#customerAddressInput} +### CustomerAddressInput attributes {#customerAddressInput} -The `CustomerAddress` input can contain the following attributes: +The `CustomerAddressInput` object can contain the following attributes: Attribute | Data Type | Description --- | --- | --- `city` | String | The city or town `company` | String | The customer's company `country_id` | String | The customer's country -`custom_attributes` | [CustomerAddressAttribute](#customerAddressAttributeInput) | Address custom attributes +`custom_attributes` | [CustomerAddressAttributeInput](#customerAddressAttributeInput) | Deprecated. Not applicable for GraphQL `customer_id` | Int | The customer ID `default_billing` | Boolean | Indicates whether the address is the default billing address `default_shipping` | Boolean | Indicates whether the address is the default shipping address @@ -19,28 +19,28 @@ Attribute | Data Type | Description `middlename` | String | The middle name of the person associated with the shipping/billing address `postcode` | String | The customer's ZIP or postal code `prefix` | String | An honorific, such as Dr., Mr., or Mrs. -`region` | [CustomerAddressRegion](#customerAddressRegionInput) | An object that defines the customer's state or province -`region_id` | Int | A number that uniquely identifies the state, province, or other area +`region` | [CustomerAddressRegionInput](#customerAddressRegionInput) | An object that defines the customer's state or province +`region_id` | Int | Deprecated. Use `region` instead. A number that uniquely identifies the state, province, or other area `street` | [String] | An array of strings that define the street number and name `suffix` | String | A value such as Sr., Jr., or III `telephone` | String | The telephone number `vat_id` | String | The customer's Tax/VAT number (for corporate customers) -### CustomerAddressAttribute input {#customerAddressAttributeInput} +### CustomerAddressAttributeInput attributes {#customerAddressAttributeInput} -The `CustomerAddressAttribute` input can contain the following attributes: +The `CustomerAddressAttributeInput` data type has been deprecated because the contents are not applicable for GraphQL. It can contain the following attributes: Attribute | Data Type | Description --- | --- | --- `attribute_code` | String | Attribute code `value` | String | Attribute value -### CustomerAddressRegion input {#customerAddressRegionInput} +### CustomerAddressRegionInput attributes {#customerAddressRegionInput} -The `customerAddressRegion` input can contain the following attributes: +The `customerAddressRegionInput` object can contain the following attributes: Attribute | Data Type | Description --- | --- | --- -`region_code` | String | The address region code `region` | String | The state or province name -`region_id` | Int | Uniquely identifies the region \ No newline at end of file +`region_code` | String | The address region code +`region_id` | Int | Deprecated. Use `region` instead. Uniquely identifies the region \ No newline at end of file diff --git a/_includes/graphql/customer-address-output.md b/_includes/graphql/customer-address-output.md index cc96fdc532e..e4dd76be772 100644 --- a/_includes/graphql/customer-address-output.md +++ b/_includes/graphql/customer-address-output.md @@ -1,4 +1,4 @@ -### CustomerAddress output {#customerAddressOutput} +### CustomerAddress attributes {#customerAddressOutput} The values assigned to attributes such as `firstname` and `lastname` in this object may be different from those defined in the `Customer` object. @@ -9,7 +9,7 @@ Attribute | Data Type | Description `city` | String | The city or town `company` | String | The customer's company `country_id` | String | The customer's country -`custom_attributes` | [CustomerAddressAttribute](#customerAddressAttributeOutput) | Address custom attributes +`custom_attributes` | [CustomerAddressAttribute](#customerAddressAttributeOutput) | Deprecated. Not applicable for GraphQL `customer_id` | Int | The customer ID `default_billing` | Boolean | Indicates whether the address is the default billing address `default_shipping` | Boolean | Indicates whether the address is the default shipping address @@ -22,27 +22,27 @@ Attribute | Data Type | Description `postcode` | String | The customer's ZIP or postal code `prefix` | String | An honorific, such as Dr., Mr., or Mrs. `region` | [CustomerAddressRegion](#customerAddressRegionOutput) | An object that defines the customer's state or province -`region_id` | Int | A number that uniquely identifies the state, province, or other area +`region_id` | Int | Deprecated. Use `region` instead. A number that uniquely identifies the state, province, or other area `street` | [String] | An array of strings that define the street number and name `suffix` | String | A value such as Sr., Jr., or III `telephone` | String | The telephone number `vat_id` | String | The customer's Tax/VAT number (for corporate customers) -### CustomerAddressAttribute output {#customerAddressAttributeOutput} +### CustomerAddressAttribute attributes {#customerAddressAttributeOutput} -The `CustomerAddressAttribute` output returns the following attributes: +The `CustomerAddressAttribute` output data type has been deprecated because the contents are not applicable for GraphQL. It can contain the following attributes: Attribute | Data Type | Description --- | --- | --- `attribute_code` | String | Attribute code `value` | String | Attribute value -### CustomerAddressRegion output {#customerAddressRegionOutput} +### CustomerAddressRegion attributes {#customerAddressRegionOutput} The `customerAddressRegion` output returns the following attributes: Attribute | Data Type | Description --- | --- | --- -`region_code` | String | The address region code `region` | String | The state or province name -`region_id` | Int | Uniquely identifies the region \ No newline at end of file +`region_code` | String | The address region code +`region_id` | Int | Deprecated. Use `region` instead. Uniquely identifies the region \ No newline at end of file diff --git a/_includes/graphql/customer-input.md b/_includes/graphql/customer-input.md index 265b1030ebf..2bd29d56b11 100644 --- a/_includes/graphql/customer-input.md +++ b/_includes/graphql/customer-input.md @@ -8,7 +8,7 @@ Attribute | Data Type | Description `email` | String | The customer's email address `firstname` | String | The customer's first name `gender` | Int | The customer's gender (Male - 1, Female - 2) -`group_id` | Int | The group assigned to the user. Default values are 0 (Not logged in), 1 (General), 2 (Wholesale), and 3 (Retailer) +`group_id` | Int | Deprecated. This attribute is not applicable for GraphQL. The group assigned to the user. Default values are 0 (Not logged in), 1 (General), 2 (Wholesale), and 3 (Retailer) `id` | Int | The ID assigned to the customer `is_subscribed` | Boolean | Indicates whether the customer is subscribed to the company's newsletter `lastname` | String | The customer's family name diff --git a/_includes/graphql/customer-output.md b/_includes/graphql/customer-output.md index 7b5d6061627..2686a6ae199 100644 --- a/_includes/graphql/customer-output.md +++ b/_includes/graphql/customer-output.md @@ -8,7 +8,7 @@ Attribute | Data Type | Description `email` | String | The customer's email address `firstname` | String | The customer's first name `gender` | Int | The customer's gender (Male - 1, Female - 2) -`group_id` | Int | The group assigned to the user. Default values are 0 (Not logged in), 1 (General), 2 (Wholesale), and 3 (Retailer) +`group_id` | Int | Deprecated. This attribute is not applicable for GraphQL. The group assigned to the user. Default values are 0 (Not logged in), 1 (General), 2 (Wholesale), and 3 (Retailer) `id` | Int | The ID assigned to the customer `is_subscribed` | Boolean | Indicates whether the customer is subscribed to the company's newsletter `lastname` | String | The customer's family name diff --git a/guides/v2.3/graphql/mutations/create-customer-address.md b/guides/v2.3/graphql/mutations/create-customer-address.md index 2efe62e82c9..202e12c158c 100644 --- a/guides/v2.3/graphql/mutations/create-customer-address.md +++ b/guides/v2.3/graphql/mutations/create-customer-address.md @@ -22,7 +22,6 @@ mutation { createCustomerAddress(input: { region: { region: "Arizona" - region_id: 4 region_code: "AZ" } country_id: US @@ -63,7 +62,6 @@ mutation { "customer_id": 5, "region": { "region": "Arizona", - "region_id": 4, "region_code": "AZ" }, "country_id": "US", diff --git a/guides/v2.3/graphql/mutations/set-shipping-address.md b/guides/v2.3/graphql/mutations/set-shipping-address.md index 7462fd99e2c..f0ef9573dbe 100644 --- a/guides/v2.3/graphql/mutations/set-shipping-address.md +++ b/guides/v2.3/graphql/mutations/set-shipping-address.md @@ -104,6 +104,7 @@ Attribute | Data Type | Description --- | --- | --- `address` | [CartAddressInput](#CartAddressInputShip) | The shipping address for the cart `customer_address_id` | Int | The unique ID that identifies the customer's address +`customer_notes` | String | Text provided by the customer ## Output attributes diff --git a/guides/v2.3/graphql/queries/cart.md b/guides/v2.3/graphql/queries/cart.md index aa4d1515725..9ef73d5d541 100644 --- a/guides/v2.3/graphql/queries/cart.md +++ b/guides/v2.3/graphql/queries/cart.md @@ -898,12 +898,12 @@ The `SelectedShippingMethod` object can contain the following attributes. Attribute | Data Type | Description --- | --- | --- -`amount` | Money | The cost of shipping using this shipping method -`base_amount` | Money | The base shipping cost, not including taxes or other cost adjustment -`carrier_code` | String | A string that identifies a commercial carrier or an offline shipping method -`carrier_title` | String | The label for the carrier code -`method_code` | String | A shipping method code associated with a carrier -`method_title` | String | The label for the method code +`amount` | Money! | The cost of shipping using this shipping method +`base_amount` | Money | Deprecated. This attribute is not applicable for GraphQL. The base shipping cost, not including taxes or other cost adjustment +`carrier_code` | String! | A string that identifies a commercial carrier or an offline shipping method +`carrier_title` | String! | The label for the carrier code +`method_code` | String! | A shipping method code associated with a carrier +`method_title` | String! | The label for the method code ### ShippingCartAddress object {#ShippingCartAddress} diff --git a/guides/v2.3/graphql/queries/customer-orders.md b/guides/v2.3/graphql/queries/customer-orders.md index 0c7ccc4bda8..f18b541da90 100644 --- a/guides/v2.3/graphql/queries/customer-orders.md +++ b/guides/v2.3/graphql/queries/customer-orders.md @@ -23,7 +23,7 @@ The following query returns the order history of the logged in customer. { customerOrders { items { - increment_id + order_number id created_at grand_total @@ -41,14 +41,14 @@ The following query returns the order history of the logged in customer. "customerOrders": { "items": [ { - "increment_id": "000000001", + "order_number": "000000001", "id": 1, "created_at": "2019-02-21 00:24:34", "grand_total": 36.39, "status": "processing" }, { - "increment_id": "000000002", + "order_number": "000000002", "id": 2, "created_at": "2019-02-21 00:24:35", "grand_total": 39.64, @@ -77,5 +77,6 @@ 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 | An ID that indicates the sequence of the order in the customer's order history +`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`