List of Country - GET

List of Country - GET API Endpoint
StoRegister - Login

List of Country API

The List of Country endpoint provides information about the available Country based on the master configuration of the account.

GET
/v1/common/country
Request Content Type
application/json
Response Content Type
application/json

Request Header

  • Authorization: X-API-Key string required

    X-API-Key is a string of letters and numbers used to authenticate and control access to the API. It can be generated in the StoRegister management application.

Response Payload:

  • succeeded boolean

    Indicates whether the request to retrieve country information was successful.

  • status string

    Describes the status of the request to retrieve country information.

  • data object

    Array containing country information.

  • pagination object

    Details about pagination, including current page number, total number of pages, and overall count of items.

  • errors array

    Holds any error information if applicable.

Country Details

Details about the Country option.

array data

  • id integer

    Id representing the country id.

  • name string

    Name of the Country (e.g., "United Kingdom", "France", "Germany", "Denmark", "Italy", "Spain", "Norway", "Sweden", "United States of America", "Australia", "India"...).

  • iSOCode2 string

    ISOCode2 of the Country (e.g., "GB", "FR", "DE", "DK", "IT", "ES", "NO", "SE", "US", "AU", "IN"...).

  • iSOCode3 string

    ISOCode3 of the Country (e.g., "GBR", "FRA", "DEU", "DNK", "ITA", "ESP", "NOR", "SWE", "USA", "AUS", "IND"...).

  • currencyCode string

    Currency Code of the Country (e.g., "GBP", "EUR", "DKK", "SEK", "USD", "AUD", "INR"...).

  • dialingCode string

    Dialing Code of the Country (e.g., "44", "33", "49", "45", "39", "34", "47", "46", "1", "61", "91"...).

Request Header

Authorization: X-API-Key --api-key--

API Response

{
    "data": [
        {
            "id": 0,
            "name": "France",
            "iSOCode2": "FR",
            "iSOCode3": "FRA",
            "currencyCode": "EUR",
            "dialingCode": "33",
        },
        // ... (Additional Country information)
    ],
    "pagination": {
        "pageNumber": 1,
        "pageCount": 1,
        "totalCount": 1
    },
    "succeeded": true,
    "status": "SUCCESS",
    "errors": null
}

Error Codes

  • NO_RECORDS_FOUND

    NO_RECORDS_FOUND means there is no relevant information found.

  • FAILED

    FAILED refers to an unsuccessful API call.

  • SOMETHING_WENT_WRONG

    SOMETHING_WENT_WRONG refers to technical glitch. Please contact administrator.
API Reference documentation