Get States

This endpoint returns the list of available states or provinces for a given terminal, category, and location level. It is part of the dynamic flow and may be skipped depending on the product type.

🔍 Description

Use this method to:

Retrieve the list of states relevant to the selected category and location

Continue the location-based flow toward product selection or delivery configuration

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 state objects:

Field	Type	Description
`stateId`	integer	Unique identifier of the state
`name`	string	Display name of the state
`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

[
  {
    "stateId": 201,
    "name": "Comunidad de Madrid",
    "nextPath": "/physical-products/municipalities/{terminalId}/101/201",
    "nextField": "municipalityId"
  }
]

🧠 Usage Notes

This step may be omitted for certain categories (e.g., digital products).

Always follow the nextPath and nextField to maintain flow continuity.

The stateId is used in the next step to retrieve municipalities or delivery zones.

Responses

🟢200OK

application/json

Body

array of:

stateId

integer

required

name

string

required

name

nextPath

string

required

nextField

string

required

Example

[
    {
        "stateId": 3,
        "name": "state",
        "nextPath": "/physical-products/{{nextPath}}/{{terminalId}}/{{categoryId}}/{{levelId}}",
        "nextField": "{nextField}"
    }
]

🔍 Description#

📥 Request Details#

📤 Response#

Example#

🧠 Usage Notes#

Request

Request samples

Responses

🔍 Description

📥 Request Details

📤 Response

Example

🧠 Usage Notes