Marketplace Settings Fields

General Marketplace Settings

Field	Details	Description
`country`	Type: String Minimum Length: 2 Maximum Length: 2	Two letter ISO country code.
`settings`	N/A	Settings 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 Minimum Length: 1 Required	Last name of the seller's legal representative.
`first_name`	Type: String Minimum Length: 1 Required	First name of the seller's legal representative.
`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.
`marketplace_description`	Type: String	A human readable description of the marketplace.
`marketplace_code`	Type: String Required	A unique identifier of the marketplace.

Country Setting

Field	Details	Description
`country`	Type: String	Two letter ISO country code.

General Settings

Field	Details	Description
`settings`	Type: Object	Settings object.
`settings.block_transactions_before`	Type: String Pattern: `^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:Z\|[+-](?:2[0-3]\|[01][0-9]):[0-5][0-9])$`	The timestamp before which the transactions targeting the marketplace are not accepted. Format is: `yyyy-MM-dd'T'HH:mm:ssZZZ`.
`settings.timezone`	Type: String	The marketplace'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.

Tax Number Verification Settings

Field	Details	Description
`tax_number_validation`	Type: Object	Settings for tax ID validation that apply to all regions and countries.
`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	This value specifies the amount time a Tax ID’s validation result is stored in the cache before the list is refreshed. For example, if an ID is validated in the last 24 hours and this setting is set to 1, when the ID is checked again, the service returns the stored result. The lower that you set this value, the more it can impact the performance of the service.

Tax Settings

Field	Details	Description
`taxation`	Type: Object	Taxation configuration that applies to all regions and countries.
`taxation.physical`	Type: Object	Taxation settings for physical goods and services.
`taxation.physical.back_to_back_transaction_templates`	Type: Object	Transaction templates for back-to-back transactions for physical goods.A back-to-back transaction is created based on the original transaction. Its fields can be overridden by providing them in those templates.To provide the correct address data for back-to-back (self-billed) invoices, the `billing_address` field for a transaction template needs to be set.
`taxation.physical.back_to_back_transaction_templates.transaction`	Type: String	Specify a custom value for the transaction.
`taxation.physical.back_to_back_transaction_templates.transaction_line`	Type: String	Specify a custom value for the transaction line.
`taxation.physical.back_to_back_transaction_tax_country_code`	Type: String Required	A tax country code used for back-to-back transactions.

Invoice Settings

Field	Details	Description
`settings.invoicing`	Type: Object	Settings for invoicing.
`invoicing.detect_currency_from_tax_country`	Type: Boolean	Specify whether the invoice currency code should be detected based on the code of the country where liability lies.
`invoicing.invoice_email_subject`	Type: String	Specifies the subject line of the mail that is sent when an invoice is generated. You can use `{{invoice_number}}` as a placeholder for the number of the invoice.
`invoicing.refund_note_email_subject`	Type: String	Specifies the subject line of the mail that is sent when a credit note is generated for a refund. You can use `{{refund_note_number}}` as a placeholder for the number of the refund note.
`invoicing.invoice_number_format`	Type: String Min: 1	A format string used when generating an invoice number. You can use any of the following placeholders: `{{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}}`.
`invoicing.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.
`invoicing.is_invoice_delivery_enabled`	Type: Boolean	Whether the invoices/refund notes should be delivered to the buyer's email address specified in the transaction request.
`invoicing.invoice_email_from_address`	Type: String Pattern: `[^@]+@[^@]+`	An email address used in a 'reply to' field when sending an invoice/refund to the buyer.
`invoicing.invoice_footer_text`	Type: String	Custom text added as a footer to generated invoices.
`invoicing.invoice_logo_url`	Type: String Pattern: ^https?://.*	A URL to the image that will appear on invoices.

Country Settings

Field	Details	Description
`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 liable in this country will be considered domestic.
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
`countries.<new_key>.taxation`	Type: Object	Taxation object for the specified country code.
`taxation.services`	Type: Object	Settings for tax on services.
`taxation.services.service_owner_liability_rule`	Type: String	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.
`taxation.physical`	Type: Object	Taxation settings for physical goods and services for a single country.
`taxation.physical.is_seller_registered`	Type: Boolean	Whether seller is configured for taxation in this country.
`taxation.physical.is_physical_tax_enabled`	Type: Boolean	Whether taxation for physical goods is enabled in this country.
`taxation.physical.seller_tax_number`	Type: String	Seller's tax number for this country.

Country Subdivision Settings

Field	Details	Description
`country_subdivisions.<New_Key>`	Type: String	Key should be country subdivision code. For example, CA for California.
`country_subdivisions.<New_Key>.taxation.is_enabled`	Type: Boolean	Whether taxation is enabled for this country subdivision. Defaults to true.

Region Settings

Field	Details	Description
`regions.<New_Key>`	Type: String	Key should be a region code. For example EU or US.
`regions.<New_Key>.tax_number_validation`	Type: Object	Tax number validation settings.
`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 (for example using an online validation service) again.
`regions.<New_Key>.taxation`	Type: Object	Taxation settings for the region.
`regions.New_Key>.taxation.validation_request_timeout_ms`	Type: Number	Number of milliseconds to wait before a request to the VAT number validation service times out.
`regions.New_Key>.taxation.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 (for example using an online validation service) again.
`regions.<New_Key>.taxation.validation_rule`	Type: String	Determines how the tax number validation should be handled: `valid-when-syntax-ok`: A tax number is validated if it passes the syntax check. `valid-when-external-service-ok`: If the number passes the syntax check, an external validation service (for example 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`.
`regions.<New_Key>.taxation.`	Type: Object	Taxation settings for for the whole region.
`regions.<New_Key>.taxation.services`	Type: Object	Taxation settings for services, such as postage or insurance.
`regions.<New_Key>.taxation.services.service_owner_liability_rule`	Type: String	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.
`regions.<New_Key>.taxation.physical`	Type: Object	Tax number for physical goods and services.
`regions.<New_Key>.taxation.physical.is_seller_located_within_region`	Type: Boolean Required	Whether seller has presence in the region.
`regions.<New_Key>.taxation.physical.ioss_member_state_of_identification`	Type: String	Member State of identification of IOSS.
`regions.<New_Key>.taxation.physical.ioss_registration_number`	Type: String	IOSS registration number.
`regions.<New_Key>.taxation.physical.oss_member_state_of_identification`	Type: String	Member State of identification of OSS.
`regions.<New_Key>.taxation.physical.ioss_registration_number`	Type: String	OSS registration number.

Updated 10 months ago