Country
Type: schema
TypeScript Definition
typescript
Country: {{
id?: $Read<number>;
name?: string;
country_code?: string;
iso_code?: string;
currency_code?: string;
currency_symbol?: string;
currency_name?: string;
flag_icon_url?: string;
region?: string;
alias?: string;
/** @default true */
active: boolean;
/** @default true */
all_states: boolean;
states?: components["schemas"]["CountryState"][];
/** @description Total number of states or provinces defined for the country in Commerce Engine. */
total_states?: $Read<number>;
/** @description Number of states or provinces included in this shipping zone country entry. */
states_count?: $Read<number>;
};
/** CountryState */
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["CountryState"] | CountryState |
OpenAPI Schema
json
{
"title": "Country",
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string"
},
"country_code": {
"type": "string"
},
"iso_code": {
"type": "string"
},
"currency_code": {
"type": "string"
},
"currency_symbol": {
"type": "string"
},
"currency_name": {
"type": "string"
},
"flag_icon_url": {
"type": "string"
},
"region": {
"type": "string"
},
"alias": {
"type": "string"
},
"active": {
"type": "boolean",
"default": true
},
"all_states": {
"type": "boolean",
"default": true
},
"states": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryState"
}
},
"total_states": {
"description": "Total number of states or provinces defined for the country in Commerce Engine.",
"type": "integer",
"readOnly": true
},
"states_count": {
"description": "Number of states or provinces included in this shipping zone country entry.",
"type": "integer",
"readOnly": true
}
},
"x-tags": [
"Store"
]
}Auto-generated from OpenAPI spec and TypeScript definitions