Home > @infiniteobjects/shopify-data-manager > AdminTypes > Company
Represents information about a company which is also a customer of the shop.
Signature:
export interface Company extends CommentEventSubject, HasEvents, HasMetafieldDefinitions, HasMetafields, Navigable, Node
Extends: CommentEventSubject, HasEvents, HasMetafieldDefinitions, HasMetafields, Navigable, Node
| Property | Modifiers | Type | Description |
|---|---|---|---|
| contactCount | Scalars[‘Int’][‘output’] | The number of contacts that belong to the company. | |
| contactRoles | CompanyContactRoleConnection | The list of roles for the company contacts. | |
| contacts | CompanyContactConnection | The list of contacts in the company. | |
| createdAt | Scalars[‘DateTime’][‘output’] | The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company was created in Shopify. | |
| customerSince | Scalars[‘DateTime’][‘output’] | The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company became the customer. | |
| defaultCursor | Scalars[‘String’][‘output’] | A default cursor that returns the single next record, sorted ascending by ID. | |
| defaultRole? | Maybe<CompanyContactRole> | (Optional) The role proposed by default for a contact at the company. | |
| draftOrders | DraftOrderConnection | The list of the company’s draft orders. | |
| events | EventConnection | The paginated list of events associated with the host subject. | |
| externalId? | Maybe<Scalars[‘String’][‘output’]> | (Optional) A unique externally-supplied ID for the company. | |
| hasTimelineComment | Scalars[‘Boolean’][‘output’] | Whether the merchant added a timeline comment to the company. | |
| id | Scalars[‘ID’][‘output’] | A globally-unique ID. | |
| lifetimeDuration | Scalars[‘String’][‘output’] | The lifetime duration of the company, since it became a customer of the shop. Examples: 2 days, 3 months, 1 year. |
|
| locationCount | Scalars[‘Int’][‘output’] | The number of locations that belong to the company. | |
| locations | CompanyLocationConnection | The list of locations in the company. | |
| mainContact? | Maybe<CompanyContact> | (Optional) The main contact for the company. | |
| metafield? | Maybe<Metafield> | (Optional) Returns a metafield by namespace and key that belongs to the resource. | |
| metafieldDefinitions | MetafieldDefinitionConnection | List of metafield definitions. | |
| metafields | MetafieldConnection | List of metafields that belong to the resource. | |
| name | Scalars[‘String’][‘output’] | The name of the company. | |
| note? | Maybe<Scalars[‘String’][‘output’]> | (Optional) A note about the company. | |
| orderCount | Scalars[‘Int’][‘output’] | The total number of orders placed for this company, across all its locations. | |
| orders | OrderConnection | The list of the company’s orders. | |
| privateMetafield? | Maybe<PrivateMetafield> | (Optional) Returns a private metafield by namespace and key that belongs to the resource. | |
| privateMetafields | PrivateMetafieldConnection | List of private metafields that belong to the resource. | |
| totalSpent | MoneyV2 | The total amount spent by this company, across all its locations. | |
| updatedAt | Scalars[‘DateTime’][‘output’] | The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company was last modified. |