Skip to main content
Anchor to Company

Company

object

Requires read_customers access scope or read_companies access scope. Also: The API client must be installed on a Shopify Plus store.

Represents information about a company which is also a customer of the shop.

Anchor to FieldsFields

Anchor to contactRolescontactRoles
•CompanyContactRoleConnection!
non-null

The list of roles for the company contacts.

Anchor to contactscontacts
•CompanyContactConnection!
non-null

The list of contacts in the company.

Anchor to contactsCountcontactsCount
•Count

The number of contacts that belong to the company.

Anchor to createdAtcreatedAt
•DateTime!
non-null

The date and time (ISO 8601 format) at which the company was created in Shopify.

Anchor to customerSincecustomerSince
•DateTime!
non-null

The date and time (ISO 8601 format) at which the company became the customer.

Anchor to defaultCursordefaultCursor
•String!
non-null

A default cursor that returns the single next record, sorted ascending by ID.

Anchor to defaultRoledefaultRole
•CompanyContactRole

The role proposed by default for a contact at the company.

Anchor to draftOrdersdraftOrders
•DraftOrderConnection!
non-null

The list of the company's draft orders.

Anchor to eventsevents
•EventConnection!
non-null

The paginated list of events associated with the host subject.

Anchor to externalIdexternalId
•String

A unique externally-supplied ID for the company.

Anchor to hasTimelineCommenthasTimelineComment
•Boolean!
non-null

Whether the merchant added a timeline comment to the company.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to lifetimeDurationlifetimeDuration
•String!
non-null

The lifetime duration of the company, since it became a customer of the shop. Examples: 2 days, 3 months, 1 year.

Anchor to locationslocations
•CompanyLocationConnection!
non-null

The list of locations in the company.

Anchor to locationsCountlocationsCount
•Count

The number of locations that belong to the company.

Anchor to mainContactmainContact
•CompanyContact

The main contact for the company.

Anchor to metafieldmetafield
•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to metafieldsmetafields
•MetafieldConnection!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to namename
•String!
non-null

The name of the company.

Anchor to notenote
•String

A note about the company.

Anchor to ordersorders
•OrderConnection!
non-null

The list of the company's orders.

Anchor to ordersCountordersCount
•Count

The total number of orders placed for this company, across all its locations.

Anchor to totalSpenttotalSpent
•MoneyV2!
non-null

The total amount spent by this company, across all its locations.

Anchor to updatedAtupdatedAt
•DateTime!
non-null

The date and time (ISO 8601 format) at which the company was last modified.

Deprecated fields

Anchor to contactCountcontactCount
•Int!
non-nullDeprecated
Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated
Was this section helpful?

Anchor to QueriesQueries

Anchor to companiescompanies
•query

Returns the list of companies in the shop.

Anchor to companycompany
•query

Returns a Company resource by ID.

Was this section helpful?

Anchor to MutationsMutations

Anchor to companyAssignMainContactcompanyAssignMainContact
•mutation

Assigns the main contact for the company.

Anchor to companyCreatecompanyCreate
•mutation

Creates a company.

Anchor to companyRevokeMainContactcompanyRevokeMainContact
•mutation

Revokes the main contact from the company.

Anchor to companyUpdatecompanyUpdate
•mutation

Updates a company.

Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?