Skip to main content
query

The information of the customer's company. Apps using the Customer Account API must meet the protected customer data requirements.

•ID!
required

The ID of the Company.


Was this section helpful?

•Company

Represents a company's information.

•DraftOrderConnection!
non-null

The list of company draft orders.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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_contact_id
•id
Anchor to created_at
•time
Anchor to customer_id
•id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
•string
Anchor to purchasing_entity
•string
•string
•string
•string
Anchor to updated_at
•time
•Boolean
Default:false

Reverse the order of the underlying list.

•DraftOrderByCompanySortKeys
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.


•String

A unique externally-supplied ID for the company.

•ID!
non-null

A globally-unique ID.

•CompanyLocationConnection!
non-null

The list of locations that the business of the business contact belongs to.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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_contact_id
•id
Anchor to company_id
•id
Anchor to created_at
•time
Anchor to external_id
•string
•id

Filter by id range.

Example:

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

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

•
  • metafields.custom.on_sale:true
    - metafields.product.material:"gid://shopify/Metaobject/43458085"
•string
Anchor to updated_at
•time
•Boolean
Default:false

Reverse the order of the underlying list.

•CompanyLocationSortKeys
Default:ID

Sort the underlying list by the given key.


•Metafield

A metafield found by namespace and key.

Arguments

•String!
required

The identifier for the metafield.

•String!
required

A container for a set of metafields.


•[Metafield]!
non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

•[HasMetafieldsIdentifier!]!
required

The list of metafields to retrieve by namespace and key.


•String!
non-null

The name of the company.

•OrderConnection!
non-null

The list of customer orders under the company.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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 confirmation_number
•string
Anchor to created_at
•time
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
•string
Anchor to order_number
•string
Anchor to processed_at
•time
Anchor to purchasing_company_contact_id
•id
Anchor to purchasing_company_id
•id
Anchor to purchasing_company_location_id
•id
Anchor to purchasing_entity
•string
Anchor to shipment_status
•string
Anchor to updated_at
•time
•Boolean
Default:false

Reverse the order of the underlying list.

•OrderByCompanySortKeys
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.



Was this section helpful?