CData Python Connector for Shopify

Build 25.0.9454

CompanyLocations

Contains company location data, including address, region, and association with parent companies.

Table-Specific Information

Select

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

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

Id

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A unique identifier for the company location record.

CompanyId String True

Companies.Id

The unique identifier of the company that owns or manages this location.

ExternalId String False

An externally supplied identifier used to link the company location to external systems or integrations.

TaxRegistrationId String True

The tax registration number associated with the company location, used for compliance and invoicing.

Name String False

The name or display label of the company location.

Currency String True

The default currency used for transactions at this location, based on its shipping address or the shop's primary market.

Locale String False

The preferred locale or language setting for the company location.

Note String False

A merchant-authored note providing context or additional details about the company location.

Phone String False

The primary contact phone number for the company location.

DefaultCursor String True

A cursor value that returns the next record in ascending order by ID, used for pagination.

OrdersCount Int True

The total number of orders placed and fulfilled through this company location.

OrdersCountPrecision String True

Indicates whether the order count value is exact or estimated.

TaxExemptions String True

A list of applicable tax exemptions for the location, such as resale or government exemptions.

HasTimelineComment Bool True

Indicates whether a timeline comment has been added to this company location record.

CreatedAt Datetime True

The timestamp marking when the company location was created in Shopify.

UpdatedAt Datetime True

The timestamp marking the most recent update to the company location.

BillingAddressId String True

The unique identifier of the billing address associated with this company location.

BillingAddressCompanyName String True

The name of the company associated with the billing address.

BillingAddressFirstName String True

The first name of the billing contact person.

BillingAddressLastName String True

The last name of the billing contact person.

BillingAddressAddress1 String True

The first line of the billing address, typically the street name or PO Box.

BillingAddressAddress2 String True

The second line of the billing address, such as an apartment, suite, or unit number.

BillingAddressCity String True

The city or locality for the billing address.

BillingAddressCountry String True

The country name for the billing address.

BillingAddressPhone String True

The contact phone number associated with the billing address, formatted in E.164 standard (for example, +16135551111).

BillingAddressProvince String True

The region, state, or province for the billing address.

BillingAddressRecipient String True

The recipient designation for the billing address, such as 'Accounts Payable' or 'Receiving Department'.

BillingAddressZip String True

The postal or ZIP code for the billing address.

BillingAddressCountryCode String True

The two-letter ISO country code representing the billing address country (for example, US).

BillingAddressFormattedArea String True

A formatted list combining the billing address's city, province, and country.

BillingAddressZoneCode String True

The regional code for the billing address, such as the province or state abbreviation (for example, ON).

BillingAddressCreatedAt Datetime True

The timestamp marking when the billing address record was created.

BillingAddressUpdatedAt Datetime True

The timestamp marking when the billing address record was last updated.

BuyerExperienceConfigurationCheckoutToDraft Bool False

Indicates whether checkout automatically creates a draft order for merchant review before completion.

BuyerExperienceConfigurationPayNowOnly Bool True

Specifies whether buyers must pay immediately at checkout or can choose deferred payment terms.

BuyerExperienceConfigurationEditableShippingAddress Bool False

Indicates whether customers are allowed to edit shipping addresses during checkout.

BuyerExperienceConfigurationDepositPercentage Double False

The required deposit percentage that must be paid at checkout.

BuyerExperienceConfigurationPaymentTermsTemplateId String False

The unique identifier of the payment terms template applied to the buyer experience configuration.

BuyerExperienceConfigurationPaymentTermsTemplateName String True

The name of the payment terms template assigned to this company location.

BuyerExperienceConfigurationPaymentTermsTemplateTranslatedName String True

The localized or translated display name of the payment terms template.

BuyerExperienceConfigurationPaymentTermsTemplateDescription String True

A text description explaining the details or rules of the payment terms template.

BuyerExperienceConfigurationPaymentTermsTemplateDueInDays Int True

The number of days between the issue date and due date for net payment term types.

BuyerExperienceConfigurationPaymentTermsTemplatePaymentTermsType String True

The classification of the payment terms template, such as 'Net', 'Immediate', or 'Deferred'.

MarketId String True

The unique identifier of the market associated with this company location.

ShippingAddressId String True

The unique identifier of the shipping address associated with this company location.

ShippingAddressCompanyName String True

The name of the company associated with the shipping address.

ShippingAddressFirstName String True

The first name of the recipient for the shipping address.

ShippingAddressLastName String True

The last name of the recipient for the shipping address.

ShippingAddressAddress1 String True

The first line of the shipping address, typically the street address or PO Box.

ShippingAddressAddress2 String True

The second line of the shipping address, such as apartment, suite, or unit number.

ShippingAddressCity String True

The city or locality for the shipping address.

ShippingAddressCountry String True

The country name for the shipping address.

ShippingAddressPhone String True

The contact phone number associated with the shipping address, formatted in E.164 standard (for example, +16135551111).

ShippingAddressProvince String True

The region, state, or province for the shipping address.

ShippingAddressRecipient String True

The recipient designation for the shipping address, such as 'Receiving Department'.

ShippingAddressZip String True

The postal or ZIP code for the shipping address.

ShippingAddressCountryCode String True

The two-letter ISO country code representing the shipping address country (for example, US).

ShippingAddressFormattedArea String True

A formatted list combining the shipping address's city, province, and country values.

ShippingAddressZoneCode String True

The regional code for the shipping address, such as a state or province abbreviation (for example, ON).

ShippingAddressCreatedAt Datetime True

The timestamp marking when the shipping address record was created.

ShippingAddressUpdatedAt Datetime True

The timestamp marking when the shipping address record was last updated.

TotalSpentAmount Decimal True

The total amount spent by the company through this location, expressed as a decimal money value.

TotalSpentCurrencyCode String True

The three-letter ISO currency code representing the currency of the total amount spent.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454