company
The Location corresponding to the provided ID. Apps using the Customer Account API must meet the protected customer data requirements.
Anchor to Possible returnsPossible returns
- CompanyLocation (CompanyLocation)
- Anchor to CompanyLocationCompany•Company
Location Location Represents a company's business location.
- Anchor to billingAddressbilling•Company
Address Address The billing address of the company location.
- Anchor to buyerExperienceConfigurationbuyer•Buyer
Experience Configuration Experience Configuration The configuration of the buyer's B2B checkout.
- Anchor to contactscontacts•Company
Contact Connection! non-null The list of contacts under a particular business location.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Company
Key Contact Sort Keys Default:ID Sort the underlying list by the given key.
- 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_id•id
- Anchor to company_location_id•id
- Anchor to created_at•time
- Anchor to email•string
- Anchor to location_name•string
- Anchor to name•string
- Anchor to role_name•string
- Anchor to status•string
- Anchor to updated_at•time
Example:
Arguments
- Anchor to draftOrdersdraft•Draft
Orders Order Connection! non-null The list of company draft orders.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Draft
Key Order By Location 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.
- 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:
Arguments
- Anchor to externalIdexternal•String
Id A unique externally-supplied ID for the location.
- •ID!non-nullPre-auth accessible
A globally-unique ID.
- Anchor to metafieldmetafield•Metafield
A metafield found by namespace and key.
- Anchor to namespacenamespace•String!required
A container for a set of metafields.
- •String!required
The identifier for the metafield.
Arguments
- Anchor to metafieldsmetafields•[Metafield]!non-nullPre-auth accessible
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 namename•String!non-nullPre-auth accessible
The name of the company location.
- Anchor to ordersorders•Order
Connection! non-null The list of customer orders under the company.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Order
Key By Location 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.
- 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:
Arguments
- Anchor to roleAssignmentsrole•Company
Assignments Contact Role Assignment Connection! non-null The list of roles assigned to this location.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Company
Key Contact Role Assignment Sort Keys Default:ID Sort the underlying list by the given key.
- 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 company_contact_role_id•id
- Anchor to company_id•id
- Anchor to company_location_id•id
- Anchor to created_at•time
- Anchor to location_name•string
- Anchor to role_name•string
- Anchor to updated_at•time
Example:
Arguments
- Anchor to shippingAddressshipping•Company
Address Address The shipping address of the company location.
- Anchor to storeCreditAccountsstore•Store
Credit Accounts Credit Account Connection! non-nullPre-auth accessible 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 firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- 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 taxIdentifiertax•String
Identifier The tax id of the company location.
- Anchor to marketmarket•Market!