Country Data Type

Country reference data used in addresses and shipping zones. Contains the ISO 3166-1 alpha-2 code and localized country name.

Available Since
1.3.0
Properties
Name Type Description
id number Unique numeric identifier for the Country.
code string The two-letter code (ISO 3166-1 format) for the country.
name string The name of the country.
standardVat VatRate Standard vat rate for the country.
reducedVat VatRate Reduced vat rate for the country. For example shipping vat rate...
currency Currency The currency for the country and the currency that the customer will use when they will pay for their order.
pricePrecision number
priceFractionalDigits number
default boolean Whether this country is the default selling country for the Shirtplatform account.
Used in
GET /accounts/{accountId}/countries/{countryId} response
Country (JSON) 
{
  "country" : {
    "id" : 12345,
    "code" : "UK",
    "name" : "United Kingdom",
    "standardVat" : {
      "id" : 12345,
      "percentValue" : 19.0
    },
    "reducedVat" : {
      "id" : 12345,
      "percentValue" : 19.0
    },
    "currency" : {
      "id" : 12345,
      "code" : "EUR",
      "symbol" : "€",
      "name" : "Euro"
    },
    "pricePrecision" : 2,
    "priceFractionalDigits" : 2,
    "default" : true
  }
}
Country Data Type

Country reference data used in addresses and shipping zones. Contains the ISO 3166-1 alpha-2 code and localized country name.

Available Since
1.3.0
Properties
Name Type Description
code string The two-letter code (ISO 3166-1 format) for the country.
currency Currency The currency for the country and the currency that the customer will use when they will pay for their order.
default boolean Whether this country is the default selling country for the Shirtplatform account.
id int Unique numeric identifier for the Country.
name string The name of the country.
priceFractionalDigits byte  
pricePrecision byte  
reducedVat VatRate Reduced vat rate for the country. For example shipping vat rate...
standardVat VatRate Standard vat rate for the country.
Used in
GET /accounts/{accountId}/countries/{countryId} response
Country (XML) 
<country>
  <id>...</id>
  <code>UK</code>
  <name>United Kingdom</name>
  <standardVat>
    <id>...</id>
    <percentValue>19</percentValue>
  </standardVat>
  <reducedVat>
    <id>...</id>
    <percentValue>19</percentValue>
  </reducedVat>
  <currency>
    <id>...</id>
    <code>EUR</code>
    <symbol>€</symbol>
    <name>Euro</name>
  </currency>
  <pricePrecision>2</pricePrecision>
  <priceFractionalDigits>2</priceFractionalDigits>
  <default>...</default>
</country>