Fields Reference

Learn about Sellers fields to model seller details.

These field references describe settings for a seller in a specific country, region, or subdivision.

General seller settings

The following general seller settings are available:

FieldTypeDescription
countryStringThe two-letter ISO country code.
settingsObjectGroups information about settings.
business_nameStringThe seller's business name. The service displays this value on invoices.
emailStringThe email address of the seller's legal representative.
postal_address_line1StringThe seller's first address line. The service displays this value on invoices when the seller is liable.
postal_address_line2StringThe seller's second address line. The service displays this value on invoices when the seller is liable.
postal_address_line3StringThe seller's third address line. The service displays this value on invoices when the seller is liable.
first_nameStringThe first name of the seller's legal representative.
middle_nameStringThe middle name of the seller's legal representative.
last_nameStringThe last name of the seller's legal representative.
seller_codeStringThe code that the marketplace uses to identify the seller associated with a transaction line. When required, provide this value in the seller_code field in the request.

Time zone settings

The following time zone settings are available:

FieldTypeDescription
timezoneStringThe seller's time zone used for all time-based operations. For example, if a tax is configured to apply on a specific date, the service uses this time zone to determine the applicable date.

Invoicing settings

The following invoice settings are available:

FieldTypePatternDescription
generate_optional_invoicesBooleanSpecifies whether to generate an invoice when the applicable tax rule does not specify whether an invoice is required. If the tax rule does not specify this, the service generates an invoice only when this setting is enabled.
invoice_footer_textStringThe custom text that the service adds to the footer of generated invoices.
invoice_email_from_addressString[^@]+@[^@]+The email address used in the "reply-to" field when the service sends an invoice or refund note to the buyer.
invoice_number_formatString

The format string used to generate invoice numbers.

You can use the following placeholders:
{territory} for the country code
{year} for the year
{month} for the month
{day} for the day
{index} for a number one greater than the index used for the previous invoice

The default value is {territory}{year}-{index}.

invoice_logo_urlString^https?:\/\/.\*The URL of the image to display on invoices.
detect_currency_from_tax_countryBooleanSpecifies whether to determine the invoice currency code from the country where the tax liability lies.

Country settings

The following country settings are available:

FieldTypeDescription
countries.{key}StringThe two-letter ISO country code.
is_domesticBooleanIf true, transactions for digital goods with tax liability in this country are treated as domestic transactions.

Country tax settings

The following tax settings for countries and regions are available:

FieldTypeDescription
Taxation settings
use_marketplace_as_intermediaryBooleanSpecifies whether the marketplace acts as a tax intermediary in this country or region.
Taxation settings for physical goods
is_seller_registeredBooleanSpecifies whether the seller is registered for tax purposes in this country or region.
is_physical_tax_enabledBooleanSpecifies whether the service applies tax to physical goods in this country or region.
seller_tax_numberStringThe seller's tax number for this country or region.
tax_obligation_country_code_overrideString

Specifies the country used to determine the seller's tax obligation for physical goods when applicable legislation allows the seller to choose the obligation country or region.

Possible values:
seller_country—The seller's country
ship_from—The country from which the goods originate, or any valid country code, that the service uses directly as the obligation country.

Country subdivision settings

The following subdivision settings for countries and regions are available:

FieldTypeDescription
country_subdivisions.{key}StringThe two-letter country subdivision code. For example, specify CA for California.
Taxation settings
taxation.is_enabledBooleanSpecifies whether taxation is enabled for the country subdivision. Defaults to true.
Taxation settings for digital goods
taxation.digital.use_marketplace_as_intermediaryBooleanSpecifies whether the marketplace acts as a tax intermediary for digital goods in the country subdivision.
Taxation settings for physical goods
taxation.physical.use_marketplace_as_intermediaryBooleanSpecifies whether the marketplace acts as a tax intermediary for physical goods in the country subdivision.

Region settings

A region is a group of one or more countries that share common behavior. For example, many tax rules and rates apply across European Union member states, so that service defines a region for it.

The following region settings are available:

FieldTypeDescription
region.{key}StringThe two-letter ISO code for the region.
Tax number validation settings
tax_number_validationObjectGroups information about tax number validation settings across the region.
tax_number_validation.validation_request_timeout_msNumberThe number of milliseconds to wait before a request to the validation service times out.
tax_number_validation.cache_expiry_timeout_daysNumberThe number of days to retain a verified tax number in the cache. After this period, the validation service must verify the tax number online again, such as through an external validation service.
tax_number_validation.validation_ruleString

Specifies how the service validates tax numbers.

Possible values:
valid-when-syntax-ok—Uses the tax number valid unless the country has a configured tax number pattern that the number does not match.
valid-when-external-service-ok—Uses an external validation service, such as VIES in the EU, to determine whether the tax number is valid.
ignored—Ignores the tax number and processes the transaction as if no tax number was provided.

Defaults to valid-when-external-service-ok.

Taxation settings
taxation.{key}ObjectGroups information about taxation settings across the region.
taxation.digital.is_taxation_enabledBooleanSpecifies whether taxation for digital goods and services is enabled in the region.
Tax settings for services
taxation.service_owner_liability_ruleBooleanSpecifies how the service determines tax liability for services such as shipping and insurance. If you do not provide a value, the service follows the consignment rule. With the service rule, the service applies tax based on the ship-to country's configuration.
Tax settings for physical goods
taxation.physicalObjectGroups information about physical goods across the region.
taxation.physical.use_marketplace_as_intermediaryBooleanSpecifies whether the marketplace acts as a tax intermediary in the region.
taxation.physical.is_seller_located_within_regionBooleanSpecifies whether the seller has a presence in the region.
taxation.physical.ioss_member_state_of_identificationStringThe IOSS Member State of identification.
taxation.physical.ioss_registration_numberStringThe IOSS registration number.
taxation.physical.oss_member_state_of_identificationStringThe OSS Member State of identification.
taxation.physical.oss_registration_numberStringThe IOSS registration number.

Fiscal representative settings

The following fiscal representative settings are available:

FieldTypeDescription
nameStringThe fiscal representative's legal entity name.
addressObjectSee Address Object Fields.
registration_numberStringThe fiscal representative's registration number.

Did this page help you?