Company
Requires access scope or access scope. Also: The shop must have access to B2B. Some operations may require additional plan capabilities.
A person who acts on behalf of a
Company
to make B2B purchases. Company contacts are associated with
Customer
accounts and can place orders on behalf of their company.
Each contact can be assigned to one or more
objects with specific roles that determine their permissions and access to
catalogs, pricing, and payment terms configured for those locations.
Anchor to FieldsFields
- company (Company!)
- createdAt (DateTime!)
- customer (Customer!)
- draftOrders (DraftOrderConnection!)
- id (ID!)
- isMainContact (Boolean!)
- lifetimeDuration (String!)
- locale (String)
- orders (OrderConnection!)
- roleAssignments (CompanyContactRoleAssignmentConnection!)
- title (String)
- updatedAt (DateTime!)
- Anchor to companycompany•Company!non-null
The company to which the contact belongs.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time (ISO 8601 format) at which the company contact was created at Shopify.
- Anchor to customercustomer•Customer!non-null
The customer associated to this contact.
- Anchor to draftOrdersdraft•Draft
Orders Order Connection! non-null The list of draft orders for the company contact.
- 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.
name type description acceptable_values default_value example_use default string Filter by a case-insensitive search of multiple fields in a document. - query=Bob Norman
-query=title:green hoodiecreated_at time customer_id id id id Filter by idrange.- id:1234
-id:>=1234
-id:<=1234source string status string tag string updated_at time You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). - 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
- •ID!non-null
A globally-unique ID.
- Anchor to isMainContactis•Boolean!
Main Contact non-null Whether the contact is the main contact of the company.
- Anchor to lifetimeDurationlifetime•String!
Duration non-null The lifetime duration of the company contact, since its creation date on Shopify. Examples:
1 year,2 months,3 days.- Anchor to localelocale•String
The company contact's locale (language).
- Anchor to ordersorders•Order
Connection! non-null The list of orders for the company contact.
- 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 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 roleAssignmentsrole•Company
Assignments Contact Role Assignment Connection! non-null The list of roles assigned to this company contact.
- 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.
name type description acceptable_values default_value example_use default string Filter by a case-insensitive search of multiple fields in a document. - query=Bob Norman
-query=title:green hoodiecompany_contact_id id company_contact_role_id id company_id id company_location_id id created_at time id id Filter by idrange.- id:1234
-id:>=1234
-id:<=1234location_name string role_name string updated_at time You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). - 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.
Arguments
- Anchor to titletitle•String
The company contact's job title.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time (ISO 8601 format) at which the company contact was last updated.
Anchor to QueriesQueries
- companyContact (CompanyContact)
- •query
Returns a
resource by ID.- •ID!required
The ID of the
to return.
Arguments
- •ID!
Anchor to MutationsMutations
- companyAssignCustomerAsContact (CompanyAssignCustomerAsContactPayload)
- companyContactCreate (CompanyContactCreatePayload)
- companyContactSendWelcomeEmail (CompanyContactSendWelcomeEmailPayload)
- companyContactUpdate (CompanyContactUpdatePayload)
- •mutation
Adds an existing
Customeras a contact to aCompany. Companies are business entities that make purchases from the merchant's store. Use this mutation when you have a customer who needs to be associated with a B2B company to make purchases on behalf of that company.The mutation returns the newly created
that links the customer to the company. After assignment, the customer becomes a company contact who can place orders on behalf of the company with access to any catalogs, pricing, and payment terms configured for the company's locations.- Anchor to companyIdcompany•ID!
Id required The ID of the company to assign the contact to.
- Anchor to customerIdcustomer•ID!
Id required The ID of the customer to assign as the contact.
Arguments
- •mutation
Creates a company contact and the associated customer.
- Anchor to companyIdcompany•ID!
Id required The ID of the company that the company contact belongs to.
- Anchor to inputinput•Company
Contact Input! required The fields to use to create the company contact.
Arguments
- •mutation
Sends the company contact a welcome email.
- Anchor to companyContactIdcompany•ID!
Contact Id required The ID of the company contact to send welcome email to.
- Anchor to emailemail•Email
Input The welcome email fields.
Arguments
- •mutation
Updates a company contact.
- Anchor to companyContactIdcompany•ID!
Contact Id required The ID of the company contact to be updated.
- Anchor to inputinput•Company
Contact Input! required The fields to use to update the company contact.
Arguments