CompanyLocations

Lists locations defined under a company, including addresses and identifiers.

Table-Specific Information

Select

The 本製品 uses the Shopify API to process WHERE clause conditions built with the following column and operators. The 本製品 processes other filters client-side within the 本製品.

CompanyId supports the '=, IN' comparison operators.

For example, the following query is processed server-side:

  SELECT * FROM CompanyLocations WHERE CompanyId = 'Val1'

Insert

The following columns can be used to create a new record:

CompanyId, ExternalId, TaxRegistrationId, Name, Locale, Note, Phone, BillingAddressAddress1, BillingAddressAddress2, BillingAddressCity, BillingAddressPhone, BillingAddressRecipient, BillingAddressZip, BillingAddressCountryCode, BillingAddressZoneCode, BuyerExperienceConfigurationCheckoutToDraft, BuyerExperienceConfigurationEditableShippingAddress, BuyerExperienceConfigurationDepositPercentage, BuyerExperienceConfigurationPaymentTermsTemplateId, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressPhone, ShippingAddressRecipient, ShippingAddressZip, ShippingAddressCountryCode, ShippingAddressZoneCode

Update

The following columns can be updated:

ExternalId, Name, Locale, Note, Phone, BuyerExperienceConfigurationCheckoutToDraft, BuyerExperienceConfigurationEditableShippingAddress, BuyerExperienceConfigurationDepositPercentage, BuyerExperienceConfigurationPaymentTermsTemplateId

Delete

You can delete entries by specifying the following column:

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The globally unique identifier of the company location.
CompanyId	String	True	Companies.Id	The globally unique identifier of the company that this location belongs to.
ExternalId	String	False		An externally supplied identifier used to uniquely reference the company location outside of Shopify.
TaxRegistrationId	String	True		The tax registration identifier of the company location.
Name	String	False		The display name of the company location.
Currency	String	True		The currency of the company location, based on the shipping address. If no shipping address is provided, the value defaults to the shop's primary market currency.
Locale	String	False		The preferred locale (language) of the company location.
Note	String	False		A merchant-facing note about the company location.
Phone	String	False		The phone number of the company location.
DefaultCursor	String	True		A default cursor used to retrieve the next company location record in ascending ID order.
OrdersCount	Int	True		The total number of orders placed for the company location.
OrdersCountPrecision	String	True		The level of precision applied to the order count value.
TaxExemptions	String	True		A list of tax exemptions applied to the company location.
HasTimelineComment	Bool	True		Indicates whether a timeline comment has been added to the company location by the merchant.
CreatedAt	Datetime	True		The date and time when the company location was created in Shopify.
UpdatedAt	Datetime	True		The date and time when the company location record was last updated.
BillingAddressId	String	True		The globally unique identifier of the billing address for this company location.
BillingAddressCompanyName	String	True		The company name listed on the billing address.
BillingAddressFirstName	String	True		The first name of the billing address recipient.
BillingAddressLastName	String	True		The last name of the billing address recipient.
BillingAddressAddress1	String	True		The first line of the billing address, typically a street address or PO Box.
BillingAddressAddress2	String	True		The second line of the billing address, typically an apartment, suite, or unit number.
BillingAddressCity	String	True		The city, town, district, or village of the billing address.
BillingAddressCountry	String	True		The country of the billing address.
BillingAddressPhone	String	True		The phone number associated with the billing address, formatted using the E.164 standard (for example, +16135551111).
BillingAddressProvince	String	True		The province, state, or district of the billing address.
BillingAddressRecipient	String	True		The name of the recipient for the billing address, such as 'Receiving Department'.
BillingAddressZip	String	True		The postal or ZIP code of the billing address.
BillingAddressCountryCode	String	True		The two-letter country code of the billing address, such as US.
BillingAddressFormattedArea	String	True		A comma-separated string combining the city, province, and country of the billing address.
BillingAddressZoneCode	String	True		The two-letter code for the region of the billing address, such as 'ON' for Ontario, Canada.
BillingAddressCreatedAt	Datetime	True		The date and time when the billing address record was created.
BillingAddressUpdatedAt	Datetime	True		The date and time when the billing address record was last updated.
BuyerExperienceConfigurationCheckoutToDraft	Bool	False		Indicates whether checkouts are converted into draft orders for merchant review.
BuyerExperienceConfigurationPayNowOnly	Bool	True		Indicates whether buyers must pay immediately at checkout, or if they can also pay later using net terms.
BuyerExperienceConfigurationEditableShippingAddress	Bool	False		Indicates whether buyers can edit their shipping address during checkout.
BuyerExperienceConfigurationDepositPercentage	Double	False		The percentage of the order total that must be paid as a deposit at checkout.
BuyerExperienceConfigurationPaymentTermsTemplateId	String	False		The globally unique identifier of the payment terms template applied to this location.
BuyerExperienceConfigurationPaymentTermsTemplateName	String	True		The display name of the payment terms template.
BuyerExperienceConfigurationPaymentTermsTemplateTranslatedName	String	True		The translated display name of the payment terms template.
BuyerExperienceConfigurationPaymentTermsTemplateDescription	String	True		The description of the payment terms template.
BuyerExperienceConfigurationPaymentTermsTemplateDueInDays	Int	True		The number of days between the issue date and due date when using net payment terms.
BuyerExperienceConfigurationPaymentTermsTemplatePaymentTermsType	String	True		The type of payment terms defined by the template.
MarketId	String	True		The globally unique identifier of the market associated with this company location.
ShippingAddressId	String	True		The globally unique identifier of the shipping address for this company location.
ShippingAddressCompanyName	String	True		The company name listed on the shipping address.
ShippingAddressFirstName	String	True		The first name of the shipping address recipient.
ShippingAddressLastName	String	True		The last name of the shipping address recipient.
ShippingAddressAddress1	String	True		The first line of the shipping address, typically a street address or PO Box.
ShippingAddressAddress2	String	True		The second line of the shipping address, typically an apartment, suite, or unit number.
ShippingAddressCity	String	True		The city, town, district, or village of the shipping address.
ShippingAddressCountry	String	True		The country of the shipping address.
ShippingAddressPhone	String	True		The phone number associated with the shipping address, formatted using the E.164 standard (for example, +16135551111).
ShippingAddressProvince	String	True		The province, state, or district of the shipping address.
ShippingAddressRecipient	String	True		The name of the recipient for the shipping address, such as 'Receiving Department'.
ShippingAddressZip	String	True		The postal or ZIP code of the shipping address.
ShippingAddressCountryCode	String	True		The two-letter country code of the shipping address, such as US.
ShippingAddressFormattedArea	String	True		A comma-separated string combining the city, province, and country of the shipping address.
ShippingAddressZoneCode	String	True		The two-letter code for the region of the shipping address, such as ON.
ShippingAddressCreatedAt	Datetime	True		The date and time when the shipping address record was created.
ShippingAddressUpdatedAt	Datetime	True		The date and time when the shipping address record was last updated.
TotalSpentAmount	Decimal	True		The total amount spent through this company location, expressed as a decimal money value.
TotalSpentCurrencyCode	String	True		The currency code for the total amount spent through this company location.