list-countries

Method: GET
Path: /common/countries

Tags: Common

Summary

Retrieve all countries

Description

Retrieve all countries

Storefront SDK Usage

SDK Method: sdk.helpers.listCountries()

Example:

const { data, error } = await sdk.helpers.listCountries();

if (error) {
  console.error("Failed to get countries:", error);
  return;
}

console.log("Countries found:", data.countries?.length || 0);

data.countries?.forEach(country => {
  console.log(`Country: ${country.name} (${country.iso_code})`);
  console.log("Phone code:", country.phone_code);
  console.log("Currency:", country.currency?.code);
});

TypeScript Definition

"list-countries": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            countries?: components["schemas"]["Country"][];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["schemas"]["Country"]	Country
components["responses"]["BadRequest"]	BadRequest
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Responses

200

OK

400

Bad request

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "Common"
  ],
  "operationId": "list-countries",
  "summary": "Retrieve all countries",
  "description": "Retrieve all countries",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/list-countries",
    "description": "API reference for the list-countries operation"
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "countries": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/Country"
                    }
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "common",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "listCountries"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions