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:
| Field | Type | Description |
|---|---|---|
country | String | The two-letter ISO country code. |
settings | Object | Groups information about settings. |
business_name | String | The seller's business name. The service displays this value on invoices. |
email | String | The email address of the seller's legal representative. |
postal_address_line1 | String | The seller's first address line. The service displays this value on invoices when the seller is liable. |
postal_address_line2 | String | The seller's second address line. The service displays this value on invoices when the seller is liable. |
postal_address_line3 | String | The seller's third address line. The service displays this value on invoices when the seller is liable. |
first_name | String | The first name of the seller's legal representative. |
middle_name | String | The middle name of the seller's legal representative. |
last_name | String | The last name of the seller's legal representative. |
seller_code | String | The 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:
| Field | Type | Description |
|---|---|---|
timezone | String | The 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:
| Field | Type | Pattern | Description |
|---|---|---|---|
generate_optional_invoices | Boolean | — | Specifies 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_text | String | — | The custom text that the service adds to the footer of generated invoices. |
invoice_email_from_address | String | [^@]+@[^@]+ | The email address used in the "reply-to" field when the service sends an invoice or refund note to the buyer. |
invoice_number_format | String | — | The format string used to generate invoice numbers. You can use the following placeholders: The default value is |
invoice_logo_url | String | ^https?:\/\/.\* | The URL of the image to display on invoices. |
detect_currency_from_tax_country | Boolean | — | Specifies whether to determine the invoice currency code from the country where the tax liability lies. |
Country settings
The following country settings are available:
| Field | Type | Description |
|---|---|---|
countries.{key} | String | The two-letter ISO country code. |
is_domestic | Boolean | If 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:
| Field | Type | Description |
|---|---|---|
| Taxation settings | — | — |
use_marketplace_as_intermediary | Boolean | Specifies whether the marketplace acts as a tax intermediary in this country or region. |
| Taxation settings for physical goods | — | — |
is_seller_registered | Boolean | Specifies whether the seller is registered for tax purposes in this country or region. |
is_physical_tax_enabled | Boolean | Specifies whether the service applies tax to physical goods in this country or region. |
seller_tax_number | String | The seller's tax number for this country or region. |
tax_obligation_country_code_override | String | 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: |
Country subdivision settings
The following subdivision settings for countries and regions are available:
| Field | Type | Description |
|---|---|---|
country_subdivisions.{key} | String | The two-letter country subdivision code. For example, specify CA for California. |
| Taxation settings | — | — |
taxation.is_enabled | Boolean | Specifies whether taxation is enabled for the country subdivision. Defaults to true. |
| Taxation settings for digital goods | — | — |
taxation.digital.use_marketplace_as_intermediary | Boolean | Specifies 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_intermediary | Boolean | Specifies 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:
| Field | Type | Description |
|---|---|---|
region.{key} | String | The two-letter ISO code for the region. |
| Tax number validation settings | — | — |
tax_number_validation | Object | Groups information about tax number validation settings across the region. |
tax_number_validation.validation_request_timeout_ms | Number | The number of milliseconds to wait before a request to the validation service times out. |
tax_number_validation.cache_expiry_timeout_days | Number | The 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_rule | String | Specifies how the service validates tax numbers. Possible values: Defaults to |
| Taxation settings | — | — |
taxation.{key} | Object | Groups information about taxation settings across the region. |
taxation.digital.is_taxation_enabled | Boolean | Specifies whether taxation for digital goods and services is enabled in the region. |
| Tax settings for services | — | — |
taxation.service_owner_liability_rule | Boolean | Specifies 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.physical | Object | Groups information about physical goods across the region. |
taxation.physical.use_marketplace_as_intermediary | Boolean | Specifies whether the marketplace acts as a tax intermediary in the region. |
taxation.physical.is_seller_located_within_region | Boolean | Specifies whether the seller has a presence in the region. |
taxation.physical.ioss_member_state_of_identification | String | The IOSS Member State of identification. |
taxation.physical.ioss_registration_number | String | The IOSS registration number. |
taxation.physical.oss_member_state_of_identification | String | The OSS Member State of identification. |
taxation.physical.oss_registration_number | String | The IOSS registration number. |
Fiscal representative settings
The following fiscal representative settings are available:
| Field | Type | Description |
|---|---|---|
name | String | The fiscal representative's legal entity name. |
address | Object | See Address Object Fields. |
registration_number | String | The fiscal representative's registration number. |
Updated 14 days ago
