Company
Requires access scope or 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 Fields and connectionsFields and connections
- Anchor to contactRolescontact•Company
Roles Contact Role Connection!non-null The list of roles for the company contacts.
- Anchor to contactscontacts•Company
Contact Connection!non-null The list of contacts in the company.
- Anchor to contactsCountcontacts•Count
Count The number of contacts that belong to the company.
- Anchor to createdAtcreated•Date
At Time!non-null The date and time (ISO 8601 format) at which the company was created in Shopify.
- Anchor to customerSincecustomer•Date
Since Time!non-null The date and time (ISO 8601 format) at which the company became the customer.
- Anchor to defaultCursordefault•String!non-null
Cursor A default cursor that returns the single next record, sorted ascending by ID.
- Anchor to defaultRoledefault•Company
Role Contact Role The role proposed by default for a contact at the company.
- Anchor to draftOrdersdraft•Draft
Orders Order Connection!non-null The list of the company's draft orders.
- Anchor to eventsevents•Event
Connection!non-null The paginated list of events associated with the host subject.
- Anchor to externalIdexternal•String
Id A unique externally-supplied ID for the company.
- Anchor to hasTimelineCommenthas•Boolean!non-null
Timeline Comment Whether the merchant added a timeline comment to the company.
- •ID!non-null
A globally-unique ID.
- Anchor to lifetimeDurationlifetime•String!non-null
Duration The lifetime duration of the company, since it became a customer of the shop. Examples:
2 days,3 months,1 year.- Anchor to locationslocations•Company
Location Connection!non-null The list of locations in the company.
- Anchor to locationsCountlocations•Count
Count The number of locations that belong to the company.
- Anchor to mainContactmain•Company
Contact Contact The main contact for the company.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection!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•Order
Connection!non-null The list of the company's orders.
- Anchor to ordersCountorders•Count
Count The total number of orders placed for this company, across all its locations.
- Anchor to totalSpenttotal•Money
Spent V2!non-null The total amount spent by this company, across all its locations.
- Anchor to updatedAtupdated•Date
At Time!non-null The date and time (ISO 8601 format) at which the company was last modified.
Deprecated fields and connections
- Anchor to contactCountcontact•Int!non-nullDeprecated
Count - Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection!non-nullDeprecated
Anchor to QueriesQueries
- •query
Returns the list of companies in the shop.
- •query
Returns a
Companyobject by ID.
Anchor to MutationsMutations
- •mutation
Assigns the main contact for the company.
- Anchor to companyContactIdcompany•ID!required
Contact Id The ID of the company contact to be assigned as the main contact.
- Anchor to companyIdcompany•ID!required
Id The ID of the company to assign the main contact to.
Arguments
- Anchor to companycompany•Company
The company for which the main contact is assigned.
- Anchor to userErrorsuser•[Business
Errors Customer User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a company.
- Anchor to inputinput•Company
Create Input!required The fields to use when creating the company.
Arguments
- Anchor to companycompany•Company
The created company.
- Anchor to userErrorsuser•[Business
Errors Customer User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Revokes the main contact from the company.
- Anchor to companyIdcompany•ID!required
Id The ID of the company to revoke the main contact from.
Arguments
- Anchor to companycompany•Company
The company from which the main contact is revoked.
- Anchor to userErrorsuser•[Business
Errors Customer User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a company.
- Anchor to companyIdcompany•ID!required
Id The ID of the company to be updated.
- Anchor to inputinput•Company
Input!required The input fields to update the company.
Arguments
- Anchor to companycompany•Company
The updated company.
- Anchor to userErrorsuser•[Business
Errors Customer User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
Anchor to InterfacesInterfaces
- •interface
- •interface
- •interface
- •interface
- •interface