Seller Settings Fields

You can use settings to adjust how the system works.

Settings can be set for the marketplace or seller and for specific regions, countries and so on.

General Settings

FieldDetailsDescription
country

Type:String


Min: 2


Max: 2

Two letter ISO country code.
settingsSettings object.
business_name

Type:String


Required

Name of the seller's business. Will appear on invoices.
email

Type:String


Required

Email of the seller's legal representative
postal_address_line3

Type:String

Third address line of the seller. Will appear on invoices whenever the seller is liable.
postal_address_line2

Type:String

Second address line of the seller. Will appear on invoices whenever the seller is liable.
last_name

Type:String


Min: 1


Required

Last name of the seller's legal representative.
first_name

Type:String


Min: 1


Required

First name of the seller's legal representative.
seller_code

Type:String


Min: 1


Max: 50

Code used by the Marketplace to identify to which seller any given transaction line belongs to. Whenever required, it should be passed in the request body in the 'seller_code' field.
postal_address_line1

Type:String


Required

First address line of the seller. Will appear on invoices whenever the seller is liable.
middle_name

Type:String

Middle name of the seller's legal representative.

Timezone Settings

FieldDetailsDescription
timezone

Type:String

The seller's time zone that is used for all time-based operations. For example, if a tax is configured to be applied at a given date, the date that is used is based in this time zone.

Invoicing Settings

FieldDetailsDescription

generate_optional_invoices

Type: Boolean

The tax rule selected for the transaction line might indicate whether to generate an invoice or not. If the tax rule does not specify that, an invoice will be generated only if this setting is enabled.

invoice_footer_text

Type: String

Custom text added as a footer to generated invoices.

invoice_email_from_address

Type: String
Pattern: [^@]+@[^@]+

An email address used in a 'reply to' field when sending an invoice/refund to the buyer

invoice_number_format

Type: String
Min: 1

A format string used when generating an invoice number.

Several placeholders can be used:

  • {{territory}} - a country code
  • {{year}}
  • {{month}}
  • {{day}}
  • {{index}} - a number greater by 1 than on the previous invoice.

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

invoice_logo_url

Type: String


Pattern: ^https?:\/\/.*

A URL to the image that will appear on invoices.
detect_currency_from_tax_country

Type: Boolean

Whether the invoice currency code should be detected based on the code of the country where liability lies.

Country Settings

FieldDetailsDescription
countries.<New_Key>

Type: String

Key should be a two-letter country code, for example IE or AU.
is_domestic

Type: Boolean

If true, transactions for digital goods that are liable in this country will be considered domestic
Taxation Object

Type: Object

See the Tax Settings for Countries section of this document.
Country Subdivisions Object

Type: Object

See the Country Subdivision Settings section of this document.

Tax Settings for Countries

Field

Details

Description

Taxation Object - Services

Taxation settings for non-digital services, such as postage or insurance.

use_marketplace_as_intermediary

Type: Boolean

Whether the Marketplace will act as an intermediary for taxes in this region.

Taxation Object - Physical

is_seller_registered

Type: Boolean
Required

Whether seller is configured for taxation in this country.

is_physical_tax_enabled

Type: Boolean
Required

Whether taxation for physical goods is enabled in this country.

seller_tax_number

Type: String

Seller's tax number for this country.

tax_obligation_country_code_override

Type: String

This setting enables to switch the physical goods tax obligation country for the sellers that can do so according to the legislation.

Possible values:

  • seller_country: The country of the seller
  • ship_from: The country of the goods origin
  • Any valid country code: The given code used directly when establishing obligation country.

Country Subdivision Settings

FieldDetailDescription
objectType: StringKey should be country subdivision code, e.g. CA for California.
Taxation Object
taxation.is_enabledType: BooleanWhether taxation is enabled for this country subdivision. Defaults to true.
Taxation Object - Digital
taxation.digital.use_marketplace_as_intermediaryType: BooleanWhether the Marketplace will act as an intermediary for taxes in the country subdivision.
Taxation Object - Physical
taxation.physical.use_marketplace_as_intermediaryType: BooleanWhether the Marketplace will act as an intermediary for taxes in the country subdivision.

Region Settings

A region is a group of 1 or more countries that share common behavior. For example, many tax rules are common for all European Union countries, hence there is an "EU" region.

Field

Detail

Description

region.<new_key>

Type: String

Key should be a region code, e.g. EU or US.

Tax Number Validation Settings

tax_number_validation

Type: Object

Settings regarding the VAT number validation for a whole region.

tax_number_validation.validation_request_timeout_ms

Type: Number

Number of milliseconds to wait before a request to the VAT number validation service times out.

tax_number_validation.cache_expiry_timeout_days

Type: Number

A number of days to keep the verified VAT number in the cache. After this time passes, VAT number will have to be verified online (e.g. using an online validation service) again.

tax_number_validation.validation_rule

Type: String

Determines how the tax number validation should be handled:

  • valid-when-syntax-ok - tax number will be considered valid unless a tax number pattern is configured for a country and tax number does not match this pattern.
  • valid-when-external-service-ok - external validation service (e.g. VIES in the EU) will be used to determine tax number validity.
  • ignored - tax number will be ignored - transaction will be processed as if the tax number was not provided at all.

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

Taxation Object
taxation.Type: ObjectTaxation settings for a region.
taxation.digital.is_taxation_enabledType: BooleanWhether taxation for digital goods/services is enabled for this region.
taxation.digital.is_tax numberType: String
Tax Settings for Services
taxation.service_owner_liability_ruleType: BooleanConfigure the logic for determining how the liability assignment for services (shipping, insurance) should be applied.
If not provided, the default is to follow the 'consignment' rule.
In case of the 'service' rule, the tax will be applied using the ship to country setup/configuration.
Tax Settings for Physical Goods
taxation.physicalTaxation settings for physical goods and services for a whole region.
taxation.physical.use_marketplace_as_intermediaryType: BooleanWhether the Marketplace will act as an intermediary for taxes in this region.
taxation.physical.is_seller_located_within_regionType: BooleanWhether seller has presence in the region.
taxation.physical.ioss_member_state_of_identificationType: StringMember State of identification of IOSS.
taxation.physical.ioss_registration_numberType: StringIOSS registration number.
taxation.physical.oss_member_state_of_identificationType: StringMember State of identification of OSS.
taxation.physical.oss_registration_numberType: StringOSS registration number.

Fiscal Representative Settings

Fiscal representative for given country (if appointed).

FieldDetailsDescription
nameType: StringLegal entity name of the fiscal representative.
addressType: ObjectFor more information, see Address Object Fields.
registration_numberType: String
Max: 256
Registration number of the fiscal representative.