Skip to main content
GET
/
country
Get country by short name
curl --request GET \
  --url https://store.salesive.com/api/v1/country \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'
{
  "status": 200,
  "success": true,
  "message": "Country retrieved",
  "data": {
    "name": "Nigeria",
    "shortName": "NG",
    "phone": "234",
    "currency": "NGN"
  }
}

Request

GET /country?shortName=NG
x-shop-id: {{shopId}}

Headers

HeaderTypeDescription
x-shop-idstringIdentify the shop context.

Query parameters

ParameterTypeDescription
shortNamestringCountry short name (e.g., NG, US, GB). Defaults to NG.

Request examples

Get Nigeria (default)

GET /country

Get United States

GET /country?shortName=US

Get United Kingdom

GET /country?shortName=GB

Successful response

{
    "status": 200,
    "success": true,
    "message": "Country retrieved",
    "data": {
        "name": "Nigeria",
        "native": "Nigeria",
        "phone": "234",
        "continent": "AF",
        "capital": "Abuja",
        "currency": "NGN",
        "languages": ["en"],
        "emoji": "🇳🇬",
        "emojiU": "U+1F1F3 U+1F1EC",
        "states": {
            "Abia": [
                {
                    "id": "30691",
                    "name": "Aba",
                    "state_id": "2647"
                }
            ],
            "Lagos": [
                {
                    "id": "30001",
                    "name": "Ikeja",
                    "state_id": "2339"
                }
            ]
        }
    }
}

Error response

{
    "status": 404,
    "success": false,
    "message": "Country not found",
    "data": {}
}

Authorizations

Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Query Parameters

shortName
string
default:NG

Country short name (e.g., NG, US, GB). Defaults to NG if not provided.

Response

Country retrieved successfully.

status
integer
Example:

200

success
boolean
Example:

true

message
string
Example:

"Country retrieved"

data
object