company_location

A location of the company that a customer is purchasing for.

To learn about B2B in themes, refer to Support B2B customers in your theme.

Properties

company company: The company that the location is associated with.
current? boolean: Returns true if the location is currently selected. Returns false if not.
external_id string: The external ID of the location.
id number: The ID of the location.
metafields array of metafield: The metafields applied to the company location.

Tip
To learn about how to create metafields, refer to Create and manage metafields or visit the Shopify Help Center.
Tip: To learn about how to create metafields, refer to <a href="/apps/metafields/manage">Create and manage metafields</a> or visit the <a href="https://help.shopify.com/manual/metafields">Shopify Help Center</a>.
name string: The name of the location.
shipping_address company_address: The address of the location.
store_credit_account store_credit_account: The store credit account associated with the company location.

The account shown will be in the currency associated with the company location’s current context. For example, when browsing a storefront for a company location in the US market, the company location's USD store credit account will be returned. If the company location does not have a USD store credit account nil will be returned.
tax_registration_id number: The tax ID of the location.
url_to_set_as_current string: The URL to set the location as the current location for the customer.

{

"company": {},

"current?": false,

"external_id": null,

"id": 98369,

"metafields": {},

"name": "99 Cauldron Lane",

"shipping_address": {},

"store_credit_account": null,

"tax_registration_id": null,

"url_to_set_as_current": "https://polinas-potent-potions.myshopify.com/company_location/update?location_id=98369&return_to=/resource"

}

Example

{
  "company": {},
  "current?": false,
  "external_id": null,
  "id": 98369,
  "metafields": {},
  "name": "99 Cauldron Lane",
  "shipping_address": {},
  "store_credit_account": null,
  "tax_registration_id": null,
  "url_to_set_as_current": "https://polinas-potent-potions.myshopify.com/company_location/update?location_id=98369&return_to=/resource"
}

Was this section helpful?