Skip to main content
Log inSign up

Shopify uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.

query

Returns a CompanyLocation object by ID.

•
ID!required

The ID of the CompanyLocation to return.


Was this section helpful?

•

A location or branch of a company that's a customer of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location.

billingAddress•

The address used as billing address for the location.

buyerExperienceConfiguration•

The configuration for the buyer's B2B checkout.

catalogs•
non-null

The list of catalogs associated with the company location.

catalogsCount•

The number of catalogs associated with the company location. Limited to a maximum of 10000.

company•
non-null

The company that the company location belongs to.

createdAt•
non-null

The date and time (ISO 8601 format) at which the company location was created in Shopify.

currency•
non-null

The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market.

defaultCursor•
non-null

A default cursor that returns the single next record, sorted ascending by ID.

draftOrders•
non-null

The list of draft orders for the company location.

events•
non-null

The paginated list of events associated with the host subject.

externalId•

A unique externally-supplied ID for the company location.

hasTimelineComment•
non-null

Whether the merchant added a timeline comment to the company location.

id•
non-null

A globally-unique ID.

inCatalog•
non-null

Whether the company location is assigned a specific catalog.

locale•

The preferred locale of the company location.

market•
non-null

The market that includes the location's shipping address. If the shipping address is empty, then the value is the shop's primary market.

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•
non-null

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

name•
non-null

The name of the company location.

note•

A note about the company location.

orders•
non-null

The list of orders for the company location.

ordersCount•

The total number of orders placed for the location.

phone•

The phone number of the company location.

roleAssignments•
non-null

The list of roles assigned to the company location.

shippingAddress•

The address used as shipping address for the location.

totalSpent•
non-null

The total amount spent by the location.

updatedAt•
non-null

The date and time (ISO 8601 format) at which the company location was last modified.

metafieldDefinitions•
non-nullDeprecated

List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.

orderCount•
non-nullDeprecated

The total number of orders placed for the location. Use ordersCount instead.

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

taxExemptions•
non-nullDeprecated

The list of tax exemptions applied to the location. Use taxSettings instead.

taxRegistrationId•
Deprecated

The tax registration ID for the company location. Use taxSettings instead.


Was this section helpful?