companyLocation - admin-graphql - QUERY

Version: 2024-10

Description:

Returns a `CompanyLocation` object by ID.

Access Scopes

Arguments

  • id: ID! - The ID of the CompanyLocation to return.

Returns

  • billingAddress: CompanyAddress The address used as billing address for the location.
  • buyerExperienceConfiguration: BuyerExperienceConfiguration The configuration for the buyer's B2B checkout.
  • catalogsCount: Count The number of catalogs associated with the company location. Limited to a maximum of 10000.
  • company: Company! The company that the company location belongs to.
  • createdAt: DateTime! The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was created in Shopify.
  • currency: CurrencyCode! 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: String! A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID.
  • externalId: String A unique externally-supplied ID for the company location.
  • hasTimelineComment: Boolean! Whether the merchant added a timeline comment to the company location.
  • id: ID! A globally-unique ID.
  • inCatalog: Boolean! Whether the company location is assigned a specific catalog.
  • locale: String The preferred locale of the company location.
  • market: Market! 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: Metafield A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
  • name: String! The name of the company location.
  • note: String A note about the company location.
  • orderCount: Int! The total number of orders placed for the location.
  • ordersCount: Count The total number of orders placed for the location.
  • phone: String The phone number of the company location.
  • privateMetafield: PrivateMetafield Returns a private metafield by namespace and key that belongs to the resource.
  • shippingAddress: CompanyAddress The address used as shipping address for the location.
  • taxExemptions: TaxExemption! The list of tax exemptions applied to the location.
  • taxRegistrationId: String The tax registration ID for the company location.
  • totalSpent: MoneyV2! The total amount spent by the location.
  • updatedAt: DateTime! The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was last modified.

Examples