Seller Settings Reference Guide

General Settings

Field	Details	Description
`country`	Type:: String Min: 2 Max**: 2	Two letter ISO country code.
`settings`	N/A	Settings object. For more information, see Seller Settings .
`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 Minimum Length: 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

Field	Details	Description
`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

Field	Details	Description
`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

Field	Details	Description
`countries.<New_Key>`	Type: String	Key should be a two-letter country code, e.g. IE or AU.
Taxation Object	Type: Object	For more information, see the Tax Settings for Countries section.
Country Subdivisions Object	Type: Object	For more information, see the Country Subdivision Settings section.

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

Field	Detail	Description
`object`	Type: String	Key should be country subdivision code, for example CA for California.
Taxation Object
Taxation Object - Physical
taxation.physical.use_marketplace_as_intermediary	Type: Boolean	Whether 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: Object	Taxation settings for a region.
Tax Settings for Services
`taxation.service_owner_liability_rule`	Type: Boolean	Configure 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.physical`		Taxation settings for physical goods and services for a whole region.
`taxation.physical.use_marketplace_as_intermediary`	Type: Boolean	Whether the Marketplace will act as an intermediary for taxes in this region.
`taxation.physical.is_seller_located_within_region`	Type: Boolean	Whether seller has presence in the region.
`taxation.physical.ioss_member_state_of_identification`	Type: String	Member State of identification of IOSS.
`taxation.physical.ioss_registration_number`	Type: String	IOSS registration number.
`taxation.physical.oss_member_state_of_identification`	Type: String	Member State of identification of OSS.
`taxation.physical.oss_registration_number`	Type: String	OSS registration number.

Fiscal Representative Settings

Fiscal representative for given country (if appointed).

Field	Details	Description
`name`	Type: String	Legal entity name of the fiscal representative.
`address`	Type: Object	For more information, see Address Object Fields.
`registration_number`	Type: String Max: 256	Registration number of the fiscal representative.

Updated over 1 year ago