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.

A business entity that purchases from the shop as part of B2B commerce. Companies organize multiple locations and contacts who can place orders on behalf of the organization. CompanyLocation objects can have custom pricing through Catalog and PriceList configurations.

Anchor to FieldsFields

Anchor to contactRolescontactRoles
•CompanyContactRoleConnection!
non-null

The list of roles for the company contacts.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•CompanyContactRoleSortKeys
Default:ID

Sort the underlying list by the given key.

Anchor to contactscontacts
•CompanyContactConnection!
non-null

The list of contacts in the company.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•CompanyContactSortKeys
Default:ID

Sort the underlying list by the given key.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to company_id
•id
Anchor to company_location_id
•id
Anchor to created_at
•time
Anchor to email
•string
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to location_name
•string
Anchor to name
•string
Anchor to role_name
•string
Anchor to status
•string
Anchor to updated_at
•time
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.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•DraftOrderSortKeys
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.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to created_at
•time
Anchor to customer_id
•id
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to source
•string
Anchor to status
•string
Anchor to tag
•string
Anchor to updated_at
•time
Anchor to eventsevents
•EventConnection!
non-null

The paginated list of events associated with the host subject.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•EventSortKeys
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.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action
•string

The action that occured.

Example:

  • action:create
Anchor to comments
•boolean

Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.

Example:

  • false
  • true
Anchor to created_at
•time

Filter by the date and time when the event happened.

Example:

  • created_at:>2020-10-21
  • created_at:<now
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to subject_type
•string

The resource type affected by this event. See EventSubjectType for possible values.

Example:

  • PRODUCT_VARIANT
  • PRODUCT
  • COLLECTION
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.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•CompanyLocationSortKeys
Default:ID

Sort the underlying list by the given key.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to company_id
•id
Anchor to created_at
•time
Anchor to external_id
•string
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to ids
•string
Anchor to metafields.{namespace}.{key}
•mixed

Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.

Example:

  • metafields.custom.on_sale:true
  • metafields.product.material:"gid://shopify/Metaobject/43458085"
Anchor to name
•string
Anchor to updated_at
•time
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.

Arguments

Anchor to namespacenamespace
•String

The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to keykey
•String!
required

The key for the metafield.

Anchor to metafieldsmetafields
•MetafieldConnection!
non-null

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

Arguments

Anchor to namespacenamespace
•String

The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.

Anchor to keyskeys
•[String!]

List of keys of metafields in the format namespace.key, will be returned in the same format.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

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.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•OrderSortKeys
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.

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

Arguments

Anchor to namespacenamespace
•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus
•MetafieldDefinitionPinnedStatus
Default:ANY

Filter by the definition's pinned status.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•MetafieldDefinitionSortKeys
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.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to created_at
•time

Filter by the date and time when the metafield definition was created.

Example:

  • created_at:>2020-10-21T23:39:20Z
  • created_at:<now
  • created_at:<=2024
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to key
•string

Filter by the metafield definition key field.

Example:

  • key:some-key
Anchor to namespace
•string

Filter by the metafield definition namespace field.

Example:

  • namespace:some-namespace
Anchor to owner_type
•string

Filter by the metafield definition ownerType field.

Example:

  • owner_type:PRODUCT
Anchor to type
•string

Filter by the metafield definition type field.

Example:

  • type:single_line_text_field
Anchor to updated_at
•time

Filter by the date and time when the metafield definition was last updated.

Example:

  • updated_at:>2020-10-21T23:39:20Z
  • updated_at:<now
  • updated_at:<=2024
Was this section helpful?

Anchor to QueriesQueries

Anchor to companiescompanies
•query

A paginated list of companies in the shop. Company objects are business entities that purchase from the merchant.

Use the query argument to filter companies by attributes like name or externalId. Sort and paginate results to handle large datasets efficiently. Learn more about Shopify API search syntax.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•CompanySortKeys
Default:ID

Sort the underlying list by the given key.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to active_customers_count
•integer
Anchor to created_at
•time
Anchor to external_id
•id
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to metafields.{namespace}.{key}
•mixed

Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.

Example:

  • metafields.custom.on_sale:true
  • metafields.product.material:"gid://shopify/Metaobject/43458085"
Anchor to name
•string
Anchor to since_date
•time
Anchor to updated_at
•time
Anchor to companycompany
•query

Returns a Company resource by ID.

Arguments

Anchor to idid
•ID!
required

The ID of the Company to return.

Was this section helpful?

Anchor to MutationsMutations

Anchor to companyAssignMainContactcompanyAssignMainContact
•mutation

Assigns the main contact for the company.

Arguments

Anchor to companyIdcompanyId
•ID!
required

The ID of the company to assign the main contact to.

Anchor to companyContactIdcompanyContactId
•ID!
required

The ID of the company contact to be assigned as the main contact.

Anchor to companyCreatecompanyCreate
•mutation

Creates a Company for B2B commerce. This mutation creates the company and can optionally create an initial CompanyContact and CompanyLocation in a single operation. Company contacts are people who place orders on behalf of the company. Company locations are branches or offices with their own billing and shipping addresses.

Note

Creating a company without a name returns an error.

Learn more about creating companies for B2B.

Arguments

Anchor to inputinput
•CompanyCreateInput!
required

The fields to use when creating the company.

Anchor to companyRevokeMainContactcompanyRevokeMainContact
•mutation

Revokes the main contact from the company.

Arguments

Anchor to companyIdcompanyId
•ID!
required

The ID of the company to revoke the main contact from.

Anchor to companyUpdatecompanyUpdate
•mutation

Updates a Company with new information. Companies represent business customers that can have multiple contacts and locations with specific pricing, payment terms, and checkout settings.

The mutation accepts the company's ID and an input object containing the fields to update. You can modify the company name, add or update internal notes, set an external ID for integration with other systems, or adjust the customer relationship start date.

Learn more about building B2B features.

Arguments

Anchor to companyIdcompanyId
•ID!
required

The ID of the company to be updated.

Anchor to inputinput
•CompanyInput!
required

The input fields to update the company.

Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?