Get Municipalities

This endpoint returns the list of available municipalities for a given terminal, category, and location level. It is part of the dynamic flow and may be skipped depending on the product type, as indicated in the previous performed call.

🔍 Description

Use this method to:

Retrieve municipalities relevant to the selected state or region

Continue the location-based flow toward product or delivery selection

Dynamically determine the next step using nextPath and nextField

📥 Request Details

Method: GET

Authentication: Required

Path Parameters:

terminalId (integer)

categoryId (integer)

levelId (integer)

📤 Response

Returns an array of municipality objects:

Field	Type	Description
`municipalityId`	integer	Unique identifier of the municipality
`name`	string	Display name of the municipality
`nextPath`	string	Path to the next endpoint in the flow
`nextField`	string	Field name required in the next step, as defined in Get Labels

Example

[
  {
    "municipalityId": 301,
    "name": "Barcelona",
    "nextPath": "/physical-products/deliver-locations/{terminalId}/101/301",
    "nextField": "locationId"
  }
]

🧠 Usage Notes

This step may be skipped for virtual products or simplified flows, always according to the nextPathon the previous call.

Use nextPath and nextField to determine the next endpoint and required parameter.

The municipalityId is used to retrieve delivery locations or available products.

application/json

Body

Example

[
    {
        "municipalityId": 4,
        "name": "municipality",
        "nextPath": "/physical-products/{{nextPath}}/{{terminalId}}/{{levelId}}",
        "nextField": "{nextField}"
    }
]

Get Municipalities

🔍 Description

📥 Request Details

📤 Response

Example

🧠 Usage Notes

Request

Request Code Samples

Responses

Get Municipalities

🔍 Description#

📥 Request Details#

📤 Response#

Example#

🧠 Usage Notes#

Request

Request Code Samples

Responses

🔍 Description

📥 Request Details

📤 Response

Example

🧠 Usage Notes