Purchasing
Requires The user must have access to any of the following: orders, draft orders, or customers.
Represents information about the purchasing entity for the order or draft order.
Anchor to Possible typesPossible types
- Customer (Customer)
- PurchasingCompany (PurchasingCompany)
- •OBJECT
Represents the personal information of a customer. Apps using the Customer Account API must meet the protected customer data requirements.
- Anchor to addressesaddresses•Customer
Address Connection! non-null The addresses associated with the customer.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to skipDefaultskip•Boolean
Default Default:false A flag indicating whether the default address should be included.
Arguments
- Anchor to companyContactscompany•Company
Contacts Contact Connection! non-null The list of contacts the customer is associated with.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to creationDatecreation•Date
Date Time! non-null The date and time when the customer was created.
- Anchor to defaultAddressdefault•Customer
Address Address The default address of the customer.
- Anchor to displayNamedisplay•String!
Name non-null The full name of the customer, based on the first_name and last_name values. If these aren't available, it falls back to the customer's email address, and if that isn't available, the customer's phone number.
- Anchor to draftOrdersdraft•Draft
Orders Order Connection! non-null The Draft Orders associated with the customer.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
- Anchor to default•string
Filter by a case-insensitive search of multiple fields in a document.
query=Bob Normanquery=title:green hoodie- Anchor to company_contact_id•id
- Anchor to created_at•time
- Anchor to customer_id•id
- Anchor to name•string
- Anchor to purchasing_entity•string
- Anchor to source•string
- Anchor to status•string
- Anchor to tag•string
- Anchor to updated_at•time
Example:
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Draft
Key Order Sort Keys Default:ID Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Arguments
- Anchor to emailAddressemail•Customer
Address Email Address The email address of the customer.
- Anchor to firstNamefirst•String
Name The first name of the customer.
- •ID!non-null
A globally-unique ID.
- Anchor to imageUrlimage•URL!
Url non-null The URL to the avatar image of the customer.
- Anchor to lastNamelast•String
Name The last name of the customer.
- Anchor to marketCurrencyCodemarket•Currency
Currency Code Code! non-null The currency for the customer's selected country market, derived from the buyer context (set via the
directive). When no buyer context is present (nodirective) or no market currency matches the context, this falls back to the shop's currency. Use it to choose which store credit balance to present as the primary one.- Anchor to metafieldmetafield•Metafield
A metafield found by namespace and key.
- •String!required
The identifier for the metafield.
- Anchor to namespacenamespace•String!required
A container for a set of metafields.
Arguments
- •String!
- Anchor to metafieldsmetafields•[Metafield]!non-null
The metafields associated with the resource matching the supplied list of namespaces and keys.
- Anchor to identifiersidentifiers•[Has
Metafields Identifier!]! required The list of metafields to retrieve by namespace and key.
Arguments
- Anchor to ordersorders•Order
Connection! non-null The orders associated with the customer.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
- Anchor to default•string
Filter by a case-insensitive search of multiple fields in a document.
query=Bob Normanquery=title:green hoodie- Anchor to confirmation_number•string
- Anchor to created_at•time
- Anchor to name•string
- Anchor to order_number•string
- Anchor to processed_at•time
- Anchor to purchasing_company_contact_id•id
- Anchor to purchasing_company_id•id
- Anchor to purchasing_company_location_id•id
- Anchor to purchasing_entity•string
- Anchor to shipment_status•string
- Anchor to updated_at•time
Example:
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Order
Key Sort Keys Default:ID Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Arguments
- Anchor to phoneNumberphone•Customer
Number Phone Number The phone number of the customer.
- Anchor to storeCreditAccountsstore•Store
Credit Accounts Credit Account Connection! non-null A list of the owner resource's store credit accounts. Store credit accounts are not shown for shops with store credit disabled at checkout.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Arguments
- Anchor to subscriptionContractsubscription•Subscription
Contract Contract Returns a
resource by ID.- •ID!required
The ID of the
to return.
Arguments
- •ID!
- Anchor to subscriptionContractssubscription•Subscription
Contracts Contract Connection! non-null The Subscription Contracts associated with the customer.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Subscription
Key Contracts Sort Keys Default:CREATED_AT Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Arguments
- •[String!]!non-null
A comma-separated list of tags that have been added to the customer.
- Anchor to lastIncompleteCheckoutlast•Checkout
Incomplete Checkout Deprecated
- •OBJECT
The information of the purchasing company for an order or draft order.
- Anchor to companycompany•Company!non-null
The company associated with the order or draft order.
- Anchor to contactcontact•Company
Contact The company contact associated with the order or draft order.
- Anchor to locationlocation•Company
Location! non-null The company location associated with the order or draft order.
Anchor to Fields with this unionFields with this union
- •OBJECT
A draft order for the customer. Any fields related to money are in the presentment currency. Apps using the Customer Account API must meet the protected customer data requirements.
- •OBJECT
A customer’s completed request to purchase one or more products from a shop. Apps using the Customer Account API must meet the protected customer data requirements.