Files
medusa-store/www/apps/docs/content/references/services/classes/Country.mdx
github-actions[bot] cdd42dbdcd chore(docs): Generated References (#5743)
Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-11-27 18:58:52 +00:00

95 lines
1.9 KiB
Plaintext

---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# Country
Country details
## Constructors
#### constructor
`**new Country**()`
Country details
## Properties
<ParameterTypes parameters={[
{
"name": "display_name",
"type": "`string`",
"description": "The country name appropriate for display.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`number`",
"description": "The country's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "iso_2",
"type": "`string`",
"description": "The 2 character ISO code of the country in lower case",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "iso_3",
"type": "`string`",
"description": "The 2 character ISO code of the country in lower case",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The normalized country name in upper case.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "num_code",
"type": "`number`",
"description": "The numerical ISO code for the country.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "region",
"type": "[Region](Region.mdx)",
"description": "The details of the region the country is associated with.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "region_id",
"type": "`null` \\| `string`",
"description": "The region ID this country is associated with.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />