# List Countries ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/settings/countries: get: summary: List Countries deprecated: false description: >- The endpoint returns all countries' names, codes, and IDs, and is not specific to any particular store's operations or merchant's activated countries. `countries_cities.read` - Countries & Cities Read operationId: get-settings-countries?page_size=10&page=1 tags: - Default module/Apps/Merchant APIs/Countries and Cities - Countries and Cities parameters: - name: Accept in: header description: >- Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format. required: true example: application/json schema: type: string default: application/json - name: Authorization in: header description: >- The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API. required: true example: '{{Autherization}}' schema: type: string - name: Accept-Language in: header description: >- Preferred language for the response. Defaults to `en` if not specified. required: false example: en schema: type: string enum: - en - ar examples: - en responses: '200': description: OK content: application/json: schema: type: object x-examples: Example 1: status: object countries: - id: 184 name: السعودية code: SA country_code: SAU flag: https://media.zid.store/static/sa.svg - id: 221 name: الإمارات العربية المتحدة code: AE country_code: ARE flag: https://media.zid.store/static/ae.svg - id: 114 name: الكويت code: KW country_code: KWT flag: https://media.zid.store/static/kw.svg - id: 161 name: عمان code: OM country_code: OMN flag: https://media.zid.store/static/om.svg - id: 17 name: البحرين code: BH country_code: BHR flag: https://media.zid.store/static/bh.svg - id: 63 name: مصر code: EG country_code: EGY flag: https://media.zid.store/static/eg.svg - id: 173 name: قطر code: QA country_code: QAT flag: https://media.zid.store/static/qa.svg - id: 108 name: الأردن code: JO country_code: JOR flag: https://media.zid.store/static/jo.svg - id: 118 name: لبنان code: LB country_code: LBN flag: https://media.zid.store/static/lb.svg - id: 214 name: تونس code: TN country_code: TUN flag: https://media.zid.store/static/tn.svg - id: 144 name: المغرب code: MA country_code: MAR flag: https://media.zid.store/static/ma.svg - id: 121 name: ليبيا code: LY country_code: LBY flag: https://media.zid.store/static/ly.svg - id: 1 name: أفغانستان code: AF country_code: AFG flag: https://media.zid.store/static/af.svg - id: 2 name: ألبانيا code: AL country_code: ALB flag: https://media.zid.store/static/al.svg - id: 3 name: الجزائر code: DZ country_code: DZA flag: https://media.zid.store/static/dz.svg - id: 4 name: ساموا الأمريكي code: AS country_code: ASM flag: https://media.zid.store/static/as.svg - id: 5 name: أندورا code: AD country_code: AND flag: https://media.zid.store/static/ad.svg - id: 6 name: أنغولا code: AO country_code: AGO flag: https://media.zid.store/static/ao.svg - id: 7 name: أنغويلا code: AI country_code: AIA flag: https://media.zid.store/static/ai.svg - id: 10 name: الأرجنتين code: AR country_code: ARG flag: https://media.zid.store/static/ar.svg - id: 11 name: أرمينيا code: AM country_code: ARM flag: https://media.zid.store/static/am.svg - id: 12 name: أروبا code: AW country_code: ABW flag: https://media.zid.store/static/aw.svg - id: 13 name: أستراليا code: AU country_code: AUS flag: https://media.zid.store/static/au.svg - id: 14 name: النمسا code: AT country_code: AUT flag: https://media.zid.store/static/at.svg - id: 15 name: أذربيجان code: AZ country_code: AZE flag: https://media.zid.store/static/az.svg - id: 16 name: الباهاماس code: BS country_code: BHS flag: https://media.zid.store/static/bs.svg - id: 19 name: بربادوس code: BB country_code: BRB flag: https://media.zid.store/static/bb.svg - id: 20 name: روسيا البيضاء code: BY country_code: BLR flag: https://media.zid.store/static/by.svg - id: 21 name: بلجيكا code: BE country_code: BEL flag: https://media.zid.store/static/be.svg - id: 22 name: بيليز code: BZ country_code: BLZ flag: https://media.zid.store/static/bz.svg - id: 24 name: جزر برمود code: BM country_code: BMU flag: https://media.zid.store/static/bm.svg - id: 26 name: بوليفيا code: BO country_code: BOL flag: https://media.zid.store/static/bo.svg - id: 30 name: البرازيل code: BR country_code: BRA flag: https://media.zid.store/static/br.svg - id: 33 name: بلغاريا code: BG country_code: BGR flag: https://media.zid.store/static/bg.svg - id: 34 name: بوركينا فاسو code: BF country_code: BFA flag: https://media.zid.store/static/bf.svg - id: 37 name: كاميرون code: CM country_code: CMR flag: https://media.zid.store/static/cm.svg - id: 38 name: كندا code: CA country_code: CAN flag: https://media.zid.store/static/ca.svg - id: 39 name: الرأس الأخضر code: CV country_code: CPV flag: https://media.zid.store/static/cv.svg - id: 42 name: تشاد code: TD country_code: TCD flag: https://media.zid.store/static/td.svg - id: 43 name: تشيلي code: CL country_code: CHL flag: https://media.zid.store/static/cl.svg - id: 44 name: الصين code: CN country_code: CHN flag: https://media.zid.store/static/cn.svg - id: 47 name: كولومبيا code: CO country_code: COL flag: https://media.zid.store/static/co.svg - id: 48 name: جزر القمر code: KM country_code: COM flag: https://media.zid.store/static/km.svg - id: 51 name: كوستاريكا code: CR country_code: CRI flag: https://media.zid.store/static/cr.svg - id: 53 name: كرواتيا code: HR country_code: HRV flag: https://media.zid.store/static/hr.svg - id: 55 name: قبرص code: CY country_code: CYP flag: https://media.zid.store/static/cy.svg - id: 56 name: الجمهورية التشيكية code: CZ country_code: CZE flag: https://media.zid.store/static/cz.svg - id: 57 name: الدانمارك code: DK country_code: DNK flag: https://media.zid.store/static/dk.svg - id: 58 name: جيبوتي code: DJ country_code: DJI flag: https://media.zid.store/static/dj.svg - id: 59 name: دومينيكا code: DM country_code: DMA flag: https://media.zid.store/static/dm.svg - id: 61 name: تيمور الشرقية code: TL country_code: TLS flag: https://media.zid.store/static/tl.svg - id: 62 name: إكوادور code: EC country_code: ECU flag: https://media.zid.store/static/ec.svg - id: 64 name: إلسلفادور code: SV country_code: SLV flag: https://media.zid.store/static/sv.svg - id: 67 name: استونيا code: EE country_code: EST flag: https://media.zid.store/static/ee.svg - id: 68 name: أثيوبيا code: ET country_code: ETH flag: https://media.zid.store/static/et.svg - id: 71 name: فيجي code: FJ country_code: FJI flag: https://media.zid.store/static/fj.svg - id: 72 name: فنلندا code: FI country_code: FIN flag: https://media.zid.store/static/fi.svg - id: 74 name: فرنسا code: FR country_code: FRA flag: https://media.zid.store/static/fr.svg - id: 76 name: بولينيزيا الفرنسية code: PF country_code: PYF flag: https://media.zid.store/static/pf.svg - id: 79 name: غامبيا code: GM country_code: GMB flag: https://media.zid.store/static/gm.svg - id: 80 name: جيورجيا code: GE country_code: GEO flag: https://media.zid.store/static/ge.svg - id: 81 name: ألمانيا code: DE country_code: DEU flag: https://media.zid.store/static/de.svg - id: 82 name: غانا code: GH country_code: GHA flag: https://media.zid.store/static/gh.svg - id: 84 name: اليونان code: GR country_code: GRC flag: https://media.zid.store/static/gr.svg - id: 85 name: جرينلاند code: GL country_code: GRL flag: https://media.zid.store/static/gl.svg - id: 86 name: غرينادا code: GD country_code: GRD flag: https://media.zid.store/static/gd.svg - id: 87 name: جزر جوادلوب code: GP country_code: GLP flag: https://media.zid.store/static/gp.svg - id: 88 name: جوام code: GU country_code: GUM flag: https://media.zid.store/static/gu.svg - id: 89 name: غواتيمال code: GT country_code: GTM flag: https://media.zid.store/static/gt.svg - id: 90 name: غينيا code: GN country_code: GIN flag: https://media.zid.store/static/gn.svg - id: 92 name: غيانا code: GY country_code: GUY flag: https://media.zid.store/static/gy.svg - id: 93 name: هايتي code: HT country_code: HTI flag: https://media.zid.store/static/ht.svg - id: 95 name: هندوراس code: HN country_code: HND flag: https://media.zid.store/static/hn.svg - id: 96 name: هونغ كونغ code: HK country_code: HKG flag: https://media.zid.store/static/hk.svg - id: 97 name: المجر code: HU country_code: HUN flag: https://media.zid.store/static/hu.svg - id: 98 name: آيسلندا code: IS country_code: ISL flag: https://media.zid.store/static/is.svg - id: 99 name: الهند code: IN country_code: IND flag: https://media.zid.store/static/in.svg - id: 100 name: أندونيسيا code: ID country_code: IDN flag: https://media.zid.store/static/id.svg - id: 102 name: العراق code: IQ country_code: IRQ flag: https://media.zid.store/static/iq.svg - id: 103 name: جمهورية أيرلندا code: IE country_code: IRL flag: https://media.zid.store/static/ie.svg - id: 105 name: إيطاليا code: IT country_code: ITA flag: https://media.zid.store/static/it.svg - id: 106 name: جمايكا code: JM country_code: JAM flag: https://media.zid.store/static/jm.svg - id: 107 name: اليابان code: JP country_code: JPN flag: https://media.zid.store/static/jp.svg - id: 109 name: كازاخستان code: KZ country_code: KAZ flag: https://media.zid.store/static/kz.svg - id: 110 name: كينيا code: KE country_code: KEN flag: https://media.zid.store/static/ke.svg - id: 111 name: كيريباتي code: KI country_code: KIR flag: https://media.zid.store/static/ki.svg - id: 117 name: لاتفيا code: LV country_code: LVA flag: https://media.zid.store/static/lv.svg - id: 122 name: ليختنشتين code: LI country_code: LIE flag: https://media.zid.store/static/li.svg - id: 123 name: لتوانيا code: LT country_code: LTU flag: https://media.zid.store/static/lt.svg - id: 124 name: لوكسمبورغ code: LU country_code: LUX flag: https://media.zid.store/static/lu.svg - id: 125 name: ماكاو code: MO country_code: MAC flag: https://media.zid.store/static/mo.svg - id: 129 name: ماليزيا code: MY country_code: MYS flag: https://media.zid.store/static/my.svg - id: 130 name: المالديف code: MV country_code: MDV flag: https://media.zid.store/static/mv.svg - id: 131 name: مالي code: ML country_code: MLI flag: https://media.zid.store/static/ml.svg - id: 132 name: مالطا code: MT country_code: MLT flag: https://media.zid.store/static/mt.svg - id: 134 name: مارتينيك code: MQ country_code: MTQ flag: https://media.zid.store/static/mq.svg - id: 135 name: موريتانيا code: MR country_code: MRT flag: https://media.zid.store/static/mr.svg - id: 137 name: مايوت code: YT country_code: MYT flag: https://media.zid.store/static/yt.svg - id: 138 name: المكسيك code: MX country_code: MEX flag: https://media.zid.store/static/mx.svg - id: 141 name: موناكو code: MC country_code: MCO flag: https://media.zid.store/static/mc.svg - id: 142 name: منغوليا code: MN country_code: MNG flag: https://media.zid.store/static/mn.svg - id: 143 name: مونتسيرات code: MS country_code: MSR flag: https://media.zid.store/static/ms.svg - id: 146 name: ميانمار code: MM country_code: MMR flag: https://media.zid.store/static/mm.svg - id: 148 name: ناورو code: NR country_code: NRU flag: https://media.zid.store/static/nr.svg - id: 149 name: نيبال code: NP country_code: NPL flag: https://media.zid.store/static/np.svg - id: 150 name: هولندا code: NL country_code: NLD flag: https://media.zid.store/static/nl.svg - id: 152 name: كاليدونيا الجديدة code: NC country_code: NCL flag: https://media.zid.store/static/nc.svg - id: 153 name: نيوزيلندا code: NZ country_code: NZL flag: https://media.zid.store/static/nz.svg - id: 154 name: نيكاراجوا code: NI country_code: NIC flag: https://media.zid.store/static/ni.svg - id: 155 name: النيجر code: NE country_code: NER flag: https://media.zid.store/static/ne.svg - id: 156 name: نيجيريا code: NG country_code: NGA flag: https://media.zid.store/static/ng.svg - id: 158 name: جزيرة نورفولك code: NF country_code: NFK flag: https://media.zid.store/static/nf.svg - id: 160 name: النرويج code: 'NO' country_code: NOR flag: https://media.zid.store/static/no.svg - id: 162 name: باكستان code: PK country_code: PAK flag: https://media.zid.store/static/pk.svg - id: 163 name: بالاو code: PW country_code: PLW flag: https://media.zid.store/static/pw.svg - id: 164 name: بنما code: PA country_code: PAN flag: https://media.zid.store/static/pa.svg - id: 166 name: باراغواي code: PY country_code: PRY flag: https://media.zid.store/static/py.svg - id: 167 name: بيرو code: PE country_code: PER flag: https://media.zid.store/static/pe.svg - id: 168 name: الفليبين code: PH country_code: PHL flag: https://media.zid.store/static/ph.svg - id: 170 name: بولندا code: PL country_code: POL flag: https://media.zid.store/static/pl.svg - id: 171 name: البرتغال code: PT country_code: PRT flag: https://media.zid.store/static/pt.svg - id: 172 name: بورتوريكو code: PR country_code: PRI flag: https://media.zid.store/static/pr.svg - id: 175 name: رومانيا code: RO country_code: ROM flag: https://media.zid.store/static/ro.svg - id: 177 name: رواندا code: RW country_code: RWA flag: https://media.zid.store/static/rw.svg - id: 181 name: ساموا code: WS country_code: WSM flag: https://media.zid.store/static/ws.svg - id: 182 name: سان مارينو code: SM country_code: SMR flag: https://media.zid.store/static/sm.svg - id: 185 name: السنغال code: SN country_code: SEN flag: https://media.zid.store/static/sn.svg - id: 188 name: سنغافورة code: SG country_code: SGP flag: https://media.zid.store/static/sg.svg - id: 190 name: سلوفينيا code: SI country_code: SVN flag: https://media.zid.store/static/si.svg - id: 192 name: الصومال code: SO country_code: SOM flag: https://media.zid.store/static/so.svg - id: 193 name: جنوب أفريقيا code: ZA country_code: ZAF flag: https://media.zid.store/static/za.svg - id: 195 name: إسبانيا code: ES country_code: ESP flag: https://media.zid.store/static/es.svg - id: 196 name: سريلانكا code: LK country_code: LKA flag: https://media.zid.store/static/lk.svg - id: 199 name: السودان code: SD country_code: SDN flag: https://media.zid.store/static/sd.svg - id: 200 name: سورينام code: SR country_code: SUR flag: https://media.zid.store/static/sr.svg - id: 203 name: السويد code: SE country_code: SWE flag: https://media.zid.store/static/se.svg - id: 204 name: سويسرا code: CH country_code: CHE flag: https://media.zid.store/static/ch.svg - id: 205 name: سوريا code: SY country_code: SYR flag: https://media.zid.store/static/sy.svg - id: 206 name: تايوان code: TW country_code: TWN flag: https://media.zid.store/static/tw.svg - id: 207 name: طاجيكستان code: TJ country_code: TJK flag: https://media.zid.store/static/tj.svg - id: 209 name: تايلندا code: TH country_code: THA flag: https://media.zid.store/static/th.svg - id: 212 name: تونغا code: TO country_code: TON flag: https://media.zid.store/static/to.svg - id: 215 name: تركيا code: TR country_code: TUR flag: https://media.zid.store/static/tr.svg - id: 216 name: تركمانستان code: TM country_code: TKM flag: https://media.zid.store/static/tm.svg - id: 218 name: توفالو code: TV country_code: TUV flag: https://media.zid.store/static/tv.svg - id: 219 name: أوغندا code: UG country_code: UGA flag: https://media.zid.store/static/ug.svg - id: 220 name: أوكرانيا code: UA country_code: UKR flag: https://media.zid.store/static/ua.svg - id: 222 name: المملكة المتحدة code: GB country_code: GBR flag: https://media.zid.store/static/gb.svg - id: 223 name: الولايات المتحدة code: US country_code: USA flag: https://media.zid.store/static/us.svg - id: 225 name: أورغواي code: UY country_code: URY flag: https://media.zid.store/static/uy.svg - id: 226 name: أوزباكستان code: UZ country_code: UZB flag: https://media.zid.store/static/uz.svg - id: 227 name: فانواتو code: VU country_code: VUT flag: https://media.zid.store/static/vu.svg - id: 229 name: فنزويلا code: VE country_code: VEN flag: https://media.zid.store/static/ve.svg - id: 230 name: فيتنام code: VN country_code: VNM flag: https://media.zid.store/static/vn.svg - id: 235 name: اليمن code: YE country_code: YEM flag: https://media.zid.store/static/ye.svg - id: 239 name: زمبابوي code: ZW country_code: ZWE flag: https://media.zid.store/static/zw.svg - id: 242 name: الجبل الأسو code: ME country_code: MNE flag: https://media.zid.store/static/me.svg - id: 243 name: جمهورية صربيا code: RS country_code: SRB flag: https://media.zid.store/static/rs.svg - id: 247 name: فلسطين code: PS country_code: PSE flag: https://media.zid.store/static/ps.svg - id: 248 name: جنوب السودان code: SS country_code: SSD flag: https://media.zid.store/static/ss.svg - id: 254 name: جزيرة مان code: IM country_code: IMN flag: https://media.zid.store/static/im.svg message: type: object code: null name: null description: null properties: status: type: string description: >- This parameter represents the overall status of the API response. It generally includes details about whether the request was successful or if there were any issues. countries: type: array description: >- This array contains a list of country objects. Each object provides detailed information about a specific country. items: type: object properties: id: type: integer description: >- The unique identifier for each country within the system. This ID is used to reference a specific country in other parts of the API. examples: - 184 name: type: string description: >- The official name of the country in Arabic. This name is displayed in Arabic script. examples: - السعودية code: type: string description: >- The two-letter ISO 3166-1 alpha-2 country code. This code is commonly used for short identification of the country. examples: - SA country_code: type: string description: >- The three-letter ISO 3166-1 alpha-3 country code. This code provides a more specific identification of the country. examples: - SAU flag: type: string description: >- The URL to the SVG image of the country's flag. This link can be used to display the flag in user interfaces. examples: - https://media.zid.store/static/sa.svg x-apidog-orders: - id - name - code - country_code - flag x-apidog-ignore-properties: [] message: &ref_0 description: >- This parameter is used to convey any messages related to the API request, such as errors or success confirmations. It can include details like code, name, and description. $ref: '#/components/schemas/ResponseEnvelopMessage' x-apidog-orders: - status - countries - message x-apidog-ignore-properties: [] headers: {} x-apidog-name: OK '401': description: '' content: application/json: schema: type: object description: >- Response returned when the request cannot be authenticated because the required credentials are missing, invalid, or expired. properties: status: type: string description: Indicates the overall status of the API response. examples: - error message: type: object description: >- Contains structured details explaining why the request could not be authenticated. properties: type: type: string description: Indicates the category of the response message. examples: - error code: type: string description: >- A machine-readable code identifying the authentication error. Returns null when no specific code is available. examples: - UNAUTHORIZED nullable: true name: type: string description: >- A short, human-readable title describing the authentication error. Returns null when no title is available. examples: - Unauthorized nullable: true description: type: string description: >- A human-readable explanation of why the request could not be authenticated. Returns null when no detailed explanation is available. examples: - >- Authentication credentials are missing, invalid, or expired. nullable: true required: - type - code - name - description x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] required: - status - message x-apidog-orders: - status - message examples: - status: error message: type: error code: UNAUTHORIZED name: Unauthorized description: >- Authentication credentials are missing, invalid, or expired. x-apidog-ignore-properties: [] examples: '1': summary: Example 1 value: status: error message: type: error code: ERROR_SESSION_MISSING name: Sorry description: Please login first. '2': summary: Example 2 value: status: error message: type: error code: ERROR_SESSION_INVALID name: Sorry description: Login session expired. Please login again. '3': summary: Example 3 value: status: error message: type: error code: ERROR_SESSION_INVALID name: Sorry description: Invalid authentication headers: {} x-apidog-name: Unauthorized '500': description: '' content: application/json: schema: type: object properties: status: type: string description: Status of the error. message: *ref_0 required: - status - message x-apidog-orders: - status - message x-apidog-ignore-properties: [] example: status: error message: type: error code: MSG_HIDDEN name: Error description: Internal Server Error headers: {} x-apidog-name: Internal Server error security: [] x-apidog-folder: Default module/Apps/Merchant APIs/Countries and Cities x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/613905/apis/api-8951696-run components: schemas: ResponseEnvelopMessage: type: object properties: type: type: string description: Type of response message returned by the API. examples: - success code: type: string description: Response code returned by the API, if available. examples: - MSG_POPUP_OK nullable: true name: type: string description: Name or title of the response message, if available. examples: - Coupons nullable: true description: type: string description: Detailed description of the response message, if available. examples: - Coupons created successfully nullable: true required: - type - code - name - description description: Additional response metadata. x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: {} servers: - url: https://api.zid.sa/ description: Prod Env security: [] ```