CSQ Docs
    CSQ Docs
    CSQ API Doc
    • CSQ API Doc
    • Dummy Product Usage Guide
    • Back to home
    • Location-based Products
    • Get Labels
      GET
    • Get Countries
      GET
    • Get Categories
      GET
    • Get States
      GET
    • Get Municipalities
      GET
    • Get Deliver Locations
      GET
    • Get Products
      GET
    • Create Cart
      POST
    • Purchase
      POST
    • Get Orders
      GET
    • Get Order Status
      GET

      Get Municipalities

      GET
      /physical-products/municipalities/{terminalId}/{categoryId}/{levelId}
      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:
      FieldTypeDescription
      municipalityIdintegerUnique identifier of the municipality
      namestringDisplay name of the municipality
      nextPathstringPath to the next endpoint in the flow
      nextFieldstringField 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.

      Request

      Path Params
      terminalId
      integer <int32>
      required
      categoryId
      integer <int32>
      required
      levelId
      integer <int32>
      required
      Header Params
      U
      string 
      required
      Default:
      {{U}}
      SH
      string 
      required
      Default:
      {{SH}}
      ST
      string 
      required
      Default:
      {{ST}}

      Request samples

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --request GET 'https://evsb.csqworld.com/physical-products/municipalities///' \
--header 'U;' \
--header 'SH;' \
--header 'ST;'

      Responses

      🟢200OK
      application/json
      OK
      Body
      array of:
      municipalityId
      integer 
      required
      name
      string 
      required
      name
      nextPath
      string 
      required
      nextField
      string 
      required
      Example
      [
    {
        "municipalityId": 4,
        "name": "municipality",
        "nextPath": "/physical-products/{{nextPath}}/{{terminalId}}/{{levelId}}",
        "nextField": "{nextField}"
    }
]
      Modified at 2025-07-07 11:03:34
      Previous
      Get States
      Next
      Get Deliver Locations
      Built with