Shopify SDK for Unity
Public Member Functions | List of all members
Shopify.Unity.GraphQL.MailingAddressQuery Class Reference

Represents a mailing address for customers and shipping. More...

Public Member Functions

 MailingAddressQuery (StringBuilder query)
 MailingAddressQuery is used to build queries. Typically MailingAddressQuery will not be used directly but instead will be used when building queries from either QueryRootQuery or MutationQuery. More...
 
MailingAddressQuery address1 ()
 The first line of the address. Typically the street address or PO Box number. More...
 
MailingAddressQuery address2 ()
 The second line of the address. Typically the number of the apartment, suite, or unit. More...
 
MailingAddressQuery city ()
 The name of the city, district, village, or town. More...
 
MailingAddressQuery company ()
 The name of the customer's company or organization. More...
 
MailingAddressQuery country ()
 The name of the country. More...
 
MailingAddressQuery countryCode ()
 The two-letter code for the country of the address. More...
 
MailingAddressQuery countryCodeV2 ()
 The two-letter code for the country of the address. More...
 
MailingAddressQuery firstName ()
 The first name of the customer. More...
 
MailingAddressQuery formatted (bool? withName=null, bool? withCompany=null, string alias=null)
 A formatted version of the address, customized by the provided arguments. More...
 
MailingAddressQuery formattedArea ()
 A comma-separated list of the values for city, province, and country. More...
 
MailingAddressQuery id ()
 Globally unique identifier. More...
 
MailingAddressQuery lastName ()
 The last name of the customer. More...
 
MailingAddressQuery latitude ()
 The latitude coordinate of the customer address. More...
 
MailingAddressQuery longitude ()
 The longitude coordinate of the customer address. More...
 
MailingAddressQuery name ()
 The full name of the customer, based on firstName and lastName. More...
 
MailingAddressQuery phone ()
 A unique phone number for the customer. More...
 
MailingAddressQuery province ()
 The region of the address, such as the province, state, or district. More...
 
MailingAddressQuery provinceCode ()
 The two-letter code for the region. More...
 
MailingAddressQuery zip ()
 The zip or postal code of the address. More...
 

Detailed Description

Represents a mailing address for customers and shipping.

Constructor & Destructor Documentation

◆ MailingAddressQuery()

Shopify.Unity.GraphQL.MailingAddressQuery.MailingAddressQuery ( StringBuilder  query)
inline

MailingAddressQuery is used to build queries. Typically MailingAddressQuery will not be used directly but instead will be used when building queries from either QueryRootQuery or MutationQuery.

Member Function Documentation

◆ address1()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.address1 ( )
inline

The first line of the address. Typically the street address or PO Box number.

◆ address2()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.address2 ( )
inline

The second line of the address. Typically the number of the apartment, suite, or unit.

◆ city()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.city ( )
inline

The name of the city, district, village, or town.

◆ company()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.company ( )
inline

The name of the customer's company or organization.

◆ country()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.country ( )
inline

The name of the country.

◆ countryCode()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.countryCode ( )
inline

The two-letter code for the country of the address.

Deprecated:
Use countryCodeV2 instead

For example, US.

◆ countryCodeV2()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.countryCodeV2 ( )
inline

The two-letter code for the country of the address.

For example, US.

◆ firstName()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.firstName ( )
inline

The first name of the customer.

◆ formatted()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.formatted ( bool?  withName = null,
bool?  withCompany = null,
string  alias = null 
)
inline

A formatted version of the address, customized by the provided arguments.

Parameters
withNameWhether to include the customer's name in the formatted address.
withCompanyWhether to include the customer's company in the formatted address.

◆ formattedArea()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.formattedArea ( )
inline

A comma-separated list of the values for city, province, and country.

◆ id()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.id ( )
inline

Globally unique identifier.

◆ lastName()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.lastName ( )
inline

The last name of the customer.

◆ latitude()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.latitude ( )
inline

The latitude coordinate of the customer address.

◆ longitude()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.longitude ( )
inline

The longitude coordinate of the customer address.

◆ name()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.name ( )
inline

The full name of the customer, based on firstName and lastName.

◆ phone()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.phone ( )
inline

A unique phone number for the customer.

Formatted using E.164 standard. For example, +16135551111.

◆ province()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.province ( )
inline

The region of the address, such as the province, state, or district.

◆ provinceCode()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.provinceCode ( )
inline

The two-letter code for the region.

For example, ON.

◆ zip()

MailingAddressQuery Shopify.Unity.GraphQL.MailingAddressQuery.zip ( )
inline

The zip or postal code of the address.


The documentation for this class was generated from the following file: