Skip to main content
Anchor to CompanyLocationConnection

CompanyLocationConnection

connection

An auto-generated type for paginating through multiple CompanyLocations.

Anchor to Fields with this connectionFields with this connection

Anchor to Company.locationsCompany.locations
•OBJECT

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 CompanyLocationCatalog.companyLocationsCompanyLocationCatalog.companyLocations
•OBJECT

A list of products with publishing and pricing information associated with company locations.

Anchor to CompanyLocationsCondition.companyLocationsCompanyLocationsCondition.companyLocations
•OBJECT

A condition checking the company location a visitor is purchasing for.

Was this section helpful?

Anchor to Queries with this connectionQueries with this connection

Anchor to companyLocationscompanyLocations
•query

A paginated list of CompanyLocation objects for B2B customers. Company locations represent individual branches or offices of a Company where B2B orders can be placed.

Each location can have its own billing and shipping addresses, tax settings, PaymentTerms, and Catalog assignments with custom pricing. Use the query parameter to search locations by name or other attributes.

Learn more about managing company locations.

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
Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges
•[CompanyLocationEdge!]!
non-null

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

Anchor to nodesnodes
•[CompanyLocation!]!
non-null

A list of nodes that are contained in CompanyLocationEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.

Anchor to pageInfopageInfo
•PageInfo!
non-null

An object that’s used to retrieve cursor information about the current page.

Was this section helpful?