list-country-pincodes

Method: GET
Path: /common/countries/{country_iso_code}/pincodes

Tags: Common

Summary

Retrieve pincodes

Description

Retrieve pincodes

Storefront SDK Usage

SDK Method: sdk.helpers.listCountryPincodes()

Example:

const { data, error } = await sdk.helpers.listCountryPincodes({
  country_iso_code: "IN"
});

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

console.log("Pincodes found:", data.pincodes?.length || 0);

data.pincodes?.forEach(pincode => {
  console.log(`Pincode: ${pincode.pincode} - ${pincode.city}, ${pincode.state}`);
  console.log("District:", pincode.district);
  console.log("Area:", pincode.area);
});

// Get pincodes for different country
const { data: usPincodes, error: usError } = await sdk.helpers.listCountryPincodes({
  country_iso_code: "US"
});

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

console.log("US Pincodes:", usPincodes.pincodes?.map(p => p.pincode).join(", "));

TypeScript Definition

"list-country-pincodes": {
        parameters: {
            query?: {
                /** @description no of rows per page */
                limit?: number;
                /** @description page number of pagination list */
                page?: number;
                /** @description pincode. atleast 3 initial chars require to use this param */
                pincode?: string;
            };
            header?: never;
            path: {
                /** @description Country iso code with 2 chars. ex. IN for india */
                country_iso_code: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            pincodes?: components["schemas"]["Pincode"][];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

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

Parameters

• country_iso_code (path): Country iso code with 2 chars. ex. IN for india
• limit (query): no of rows per page
• page (query): page number of pagination list
• pincode (query): pincode. atleast 3 initial chars require to use this param

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-country-pincodes",
  "summary": "Retrieve pincodes",
  "description": "Retrieve pincodes",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/list-country-pincodes",
    "description": "API reference for the list-country-pincodes operation"
  },
  "parameters": [
    {
      "name": "country_iso_code",
      "in": "path",
      "description": "Country iso code with 2 chars. ex. IN for india",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "no of rows per page",
      "schema": {
        "type": "integer"
      }
    },
    {
      "name": "page",
      "in": "query",
      "description": "page number of pagination list",
      "schema": {
        "type": "integer"
      }
    },
    {
      "name": "pincode",
      "in": "query",
      "description": "pincode. atleast 3 initial chars require to use this param",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "pincodes": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/Pincode"
                    }
                  }
                },
                "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": false,
  "x-speakeasy-name-override": "listCountryPincodes"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions