Choose a version:

company

query

Returns a Company object by ID.

Arguments

Anchor to idid • ID!required: The ID of the Company to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Company

•

Company

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

contactRoles • CompanyContactRoleConnection! non-null: The list of roles for the company contacts.
contacts • CompanyContactConnection! non-null: The list of contacts in the company.
contactsCount• Count: The number of contacts that belong to the company.
createdAt• DateTime! non-null: The date and time (ISO 8601 format) at which the company was created in Shopify.
customerSince• DateTime! non-null: The date and time (ISO 8601 format) at which the company became the customer.
defaultCursor• String! non-null: A default cursor that returns the single next record, sorted ascending by ID.
defaultRole• CompanyContactRole: The role proposed by default for a contact at the company.
draftOrders • DraftOrderConnection! non-null: The list of the company's draft orders.
events • EventConnection! non-null: The paginated list of events associated with the host subject.
externalId• String: A unique externally-supplied ID for the company.
hasTimelineComment• Boolean! non-null: Whether the merchant added a timeline comment to the company.
id• ID! non-null: A globally-unique ID.
lifetimeDuration• String! non-null: The lifetime duration of the company, since it became a customer of the shop. Examples: 2 days, 3 months, 1 year.
locations • CompanyLocationConnection! non-null: The list of locations in the company.
locationsCount• Count: The number of locations that belong to the company.
mainContact• CompanyContact: The main contact for the company.
metafield• 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.
metafields • MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
name• String! non-null: The name of the company.
note• String: A note about the company.
orders • OrderConnection! non-null: The list of the company's orders.
ordersCount• Count: The total number of orders placed for this company, across all its locations.
totalSpent• MoneyV2! non-null: The total amount spent by this company, across all its locations.
updatedAt• DateTime! non-null: The date and time (ISO 8601 format) at which the company was last modified.
contactCount• Int! non-nullDeprecated: The number of contacts that belong to the company. Use contactsCount instead.
metafieldDefinitions • MetafieldDefinitionConnection! non-nullDeprecated: List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.
privateMetafield• PrivateMetafield Deprecated: Returns a private metafield by namespace and key that belongs to the resource. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.
privateMetafields • PrivateMetafieldConnection! non-nullDeprecated: List of private metafields that belong to the resource. Metafields created using a reserved namespace are private by default. See our guide for migrating private metafields.

Was this section helpful?

Get a company by its ID
Get a metafield attached to a company
Get metafields attached to a company
Get pinned metafield definitions associated with a company

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

company(id: "gid://shopify/Company/426793626") {

name

note

externalId

totalSpent {

amount

currencyCode

}

}`,

);

const data = await response.json();

query {
  company(id: "gid://shopify/Company/426793626") {
    id
    name
    note
    externalId
    totalSpent {
      amount
      currencyCode
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { company(id: \"gid://shopify/Company/426793626\") { id name note externalId totalSpent { amount currencyCode } } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query {
    company(id: "gid://shopify/Company/426793626") {
      id
      name
      note
      externalId
      totalSpent {
        amount
        currencyCode
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    company(id: "gid://shopify/Company/426793626") {
      id
      name
      note
      externalId
      totalSpent {
        amount
        currencyCode
      }
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    company(id: "gid://shopify/Company/426793626") {
      id
      name
      note
      externalId
      totalSpent {
        amount
        currencyCode
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"company": {

"id": "gid://shopify/Company/426793626",

"name": "Fancy Pants Inc.",

"note": "test notes",

"externalId": "external_id1",

"totalSpent": {

"amount": "120.0",

"currencyCode": "USD"

}