> ## Documentation Index
> Fetch the complete documentation index at: https://docs.salesive.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get country by short name

> Retrieve country information including states and cities by its short name.

## Request

```http theme={null}
GET /country?shortName=NG
x-shop-id: {{shopId}}
```

## Headers

| Header      | Type   | Description                |
| ----------- | ------ | -------------------------- |
| `x-shop-id` | string | Identify the shop context. |

## Query parameters

| Parameter   | Type   | Description                                                    |
| ----------- | ------ | -------------------------------------------------------------- |
| `shortName` | string | Country short name (e.g., `NG`, `US`, `GB`). Defaults to `NG`. |

## Request examples

### Get Nigeria (default)

```http theme={null}
GET /country
```

### Get United States

```http theme={null}
GET /country?shortName=US
```

### Get United Kingdom

```http theme={null}
GET /country?shortName=GB
```

## Successful response

```json theme={null}
{
    "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

```json theme={null}
{
    "status": 404,
    "success": false,
    "message": "Country not found",
    "data": {}
}
```


## OpenAPI

````yaml GET /country
openapi: 3.1.0
info:
  title: Salesive Store API
  description: >-
    REST interface for querying products, categories, and merchandising banners
    exposed by Salesive storefronts.
  version: 1.0.0
servers:
  - description: Production
    url: https://store.salesive.com/api/v1
security:
  - BearerAuth: []
    ShopIdHeader: []
paths:
  /country:
    get:
      summary: Get country by short name
      description: Retrieve country information by its short name.
      parameters:
        - $ref: '#/components/parameters/XShopIdHeader'
        - name: shortName
          in: query
          required: false
          description: >-
            Country short name (e.g., NG, US, GB). Defaults to NG if not
            provided.
          schema:
            type: string
            default: NG
      responses:
        '200':
          description: Country retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    example: 200
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Country retrieved
                  data:
                    type: object
                    properties:
                      name:
                        type: string
                        example: Nigeria
                      shortName:
                        type: string
                        example: NG
                      phone:
                        type: string
                        example: '234'
                      currency:
                        type: string
                        example: NGN
        '404':
          description: Country not found.
components:
  parameters:
    XShopIdHeader:
      name: x-shop-id
      in: header
      description: >-
        Optional identifier that scopes responses to a specific storefront when
        the referer cannot be inferred.
      required: false
      schema:
        type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT issued by the Salesive Store API for authenticated shoppers.
    ShopIdHeader:
      type: apiKey
      in: header
      name: x-shop-id
      description: >-
        Optional storefront identifier sent as a header to scope responses to a
        specific shop. Try It requests remember this value once provided.

````