CompanyLocations
Returns a list of locations in the company.
Table-Specific Information
Select
The component uses the Shopify API to process WHERE clause conditions built with the CompanyId column, which supports the '=' comparison operator.
The component processes other filters client-side within the component.
For example, the following query is processed server-side:
SELECT * FROM CompanyLocations WHERE CompanyId='VALUE'
Insert
INSERT statements are mapped to the 'companyLocationCreate' GraphQL mutation.
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, ShippingAddressAddress1, ShippingAddressAddress2, ShippingAddressCity, ShippingAddressPhone, ShippingAddressRecipient, ShippingAddressZip, ShippingAddressCountryCode, ShippingAddressZoneCode
UPDATE
UPDATE statements are mapped to the 'companyLocationUpdate' GraphQL mutation.
The following columns can be updated:
ExternalId, Name, Locale, Note, Phone
DELETE
DELETE statements are mapped to the 'companyLocationDelete' GraphQL mutation.
You can delete entries by specifying the Id.
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | True |
A globally-unique ID. | |
CompanyId | String | True |
Companies.Id |
A globally-unique ID. |
ExternalId | String | False |
A unique externally-supplied ID for the company location. | |
TaxRegistrationId | String | True |
The tax registration ID for the company location. | |
Name | String | False |
The name of the company location. | |
Currency | String | True |
The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market. | |
Locale | String | False |
The preferred locale of the company location. | |
Note | String | False |
A note about the company location. | |
Phone | String | False |
The phone number of the company location. | |
DefaultCursor | String | True |
A default cursor that returns the single next record, sorted ascending by ID. | |
OrderCount | Int | True |
The total number of orders placed for the location. | |
TaxExemptions | String | True |
The list of tax exemptions applied to the location. | |
HasTimelineComment | Bool | True |
Whether the merchant added a timeline comment to the company location. | |
CreatedAt | Datetime | True |
The date and time at which the company location was created in Shopify. | |
UpdatedAt | Datetime | True |
The date and time at which the company location was last modified. | |
BillingAddressId | String | True |
A globally-unique ID. | |
BillingAddressCompanyName | String | True |
The name of the company. | |
BillingAddressAddress1 | String | True |
The first line of the address. Typically the street address or PO Box number. | |
BillingAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
BillingAddressCity | String | True |
The name of the city, district, village, or town. | |
BillingAddressCountry | String | True |
The name of the country. | |
BillingAddressPhone | String | True |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
BillingAddressProvince | String | True |
The region of the address, such as the province, state, or district. | |
BillingAddressRecipient | String | True |
The identity of the recipient e. g. 'Receiving Department'. | |
BillingAddressZip | String | True |
The zip or postal code of the address. | |
BillingAddressCountryCode | String | True |
The two-letter code for the country of the address. For example, US. | |
BillingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
BillingAddressZoneCode | String | True |
The two-letter code for the region. For example, ON. | |
BillingAddressCreatedAt | Datetime | True |
The date and time at which the company address was created. | |
BillingAddressUpdatedAt | Datetime | True |
The date and time at which the company address was last updated. | |
BuyerExperienceConfigurationCheckoutToDraft | Bool | True |
Whether to checkout to draft order for merchant review. | |
BuyerExperienceConfigurationPayNowOnly | Bool | True |
Whether a buyer must pay at checkout or they can also choose to pay later using net terms. | |
BuyerExperienceConfigurationPaymentTermsTemplateId | String | True |
A globally-unique ID. | |
BuyerExperienceConfigurationPaymentTermsTemplateName | String | True |
The name of the payment terms template. | |
BuyerExperienceConfigurationPaymentTermsTemplateTranslatedName | String | True |
The translated payment terms template name. | |
BuyerExperienceConfigurationPaymentTermsTemplateDescription | String | True |
The description of the payment terms template. | |
BuyerExperienceConfigurationPaymentTermsTemplateDueInDays | Int | True |
The number of days between the issued date and due date if this is the net type of payment terms. | |
BuyerExperienceConfigurationPaymentTermsTemplatePaymentTermsType | String | True |
The type of the payment terms template. | |
MarketId | String | True |
A globally-unique ID. | |
ShippingAddressId | String | True |
A globally-unique ID. | |
ShippingAddressCompanyName | String | True |
The name of the company. | |
ShippingAddressAddress1 | String | True |
The first line of the address. Typically the street address or PO Box number. | |
ShippingAddressAddress2 | String | True |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
ShippingAddressCity | String | True |
The name of the city, district, village, or town. | |
ShippingAddressCountry | String | True |
The name of the country. | |
ShippingAddressPhone | String | True |
A unique phone number for the customer. Formatted using E. 164 standard. For example, _+16135551111_. | |
ShippingAddressProvince | String | True |
The region of the address, such as the province, state, or district. | |
ShippingAddressRecipient | String | True |
The identity of the recipient e. g. 'Receiving Department'. | |
ShippingAddressZip | String | True |
The zip or postal code of the address. | |
ShippingAddressCountryCode | String | True |
The two-letter code for the country of the address. For example, US. | |
ShippingAddressFormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
ShippingAddressZoneCode | String | True |
The two-letter code for the region. For example, ON. | |
ShippingAddressCreatedAt | Datetime | True |
The date and time at which the company address was created. | |
ShippingAddressUpdatedAt | Datetime | True |
The date and time at which the company address was last updated. | |
TotalSpentAmount | Decimal | True |
Decimal money amount. | |
TotalSpentCurrencyCode | String | True |
Currency of the money. |