Description
This API endpoint retrieves a list of countries with options to filter by country code and active status.
This API endpoint is primarily used to fetch country information for display or for form field options that require country information. It can also be used to get country-specific settings like default shipping costs and VAT thresholds. The 'OnlyActive' parameter filters countries that have a connected customer address. Countries can also be filtered by their country code using 'CntCode'.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
CntCode |
string |
0 |
D |
Filter: Country code |
2 |
OnlyActive |
boolean |
0 |
0 or 1 |
Switch: Return only countries that have a connected customer address |
Request body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
<soapenv:Header/>
<soapenv:Body>
<dem:pixiGetCountries>
<dem:CntCode>D</dem:CntCode>
<dem:OnlyActive>0 or 1</dem:OnlyActive>
</dem:pixiGetCountries>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Countries list
# |
Name |
Type |
Description |
1 |
CntCode |
string |
Country Code |
2 |
CntName |
string |
Country Name |
3 |
DefShipCost |
number |
Default shipping costs |
4 |
DateFormat |
string |
Date format |
5 |
LangCode |
string |
Countries language code |
6 |
LocationID |
string |
Location ID |
7 |
CntCodeISO2 |
string |
Country ISO2 Code |
8 |
CntCodeISO3 |
string |
Country ISO3 Code |
9 |
ChargeVAT |
string |
The flag that marks if the VAT should be charged |
10 |
CntNames |
string |
Country name |
11 |
VATLimit |
integer |
VAT treshold |
12 |
IsEU |
boolean |
Is country a member of EU |
Additional Notes