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 Products

      GET
      /physical-products/products/{terminalId}/{categoryId}/{levelId}
      This endpoint returns the list of available products for a given terminal, category, and level. It is typically the final step in a dynamic location-based product selection flow, though some flows may shortcut directly to this point depending on the product type.

      🔍 Description#

      Use this method to:
      Retrieve the products available for the current selection context.
      Display product details such as name, description, and image.
      Prepare the next step in the flow (e.g., cart creation or transaction).
      📌 Unlike previous steps, this response does not include nextPath or nextField. Instead, it provides full product metadata for rendering and selection.

      📥 Request Details#

      Method: GET
      Authentication: Required
      Path Parameters:
      terminalId (integer): ID of the requesting terminal
      categoryId (integer): ID of the selected product category
      levelId (integer): ID of the dynamic flow level (e.g., municipality or delivery zone, as indicated in the previous call)

      📤 Response#

      Returns an array of product objects:
      FieldTypeDescription
      amountToSendX100integerCost of the product, in cents
      productIdintegerUnique identifier of the product
      operatorIdintegerIdentifier of the operator providing the product
      namestringDisplay name of the product
      descriptionstringShort description of the product
      imageUrlstringURL of the product image for UI rendering

      Example#

      [
  {
    "amountToSendX100": 5000,
    "productId": 501,
    "operatorId": 3001,
    "name": "Caja de frutas",
    "description": "Frutas frescas de temporada",
    "imageUrl": "https://cdn.example.com/images/frutas.jpg"
  },
  {
    "amountToSendX100": 1000,
    "productId": 502,
    "operatorId": 3002,
    "name": "Bote de café",
    "description": "Bote de 250 gr. de café tostado",
    "imageUrl": "https://cdn.example.com/images/cafe.jpg"
  }
]

      🧠 Usage Notes#

      This method provides the final product list based on the user’s location and category path.
      Products may vary in pricing model and availability depending on the operator and region.
      The amountToSendX100 can be used to pre-fill transaction amounts or validate minimums.

      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/products///' \
--header 'U;' \
--header 'SH;' \
--header 'ST;'

      Responses

      🟢200OK
      application/json
      OK
      Body
      array of:
      amountToSendX100
      integer 
      required
      productId
      integer 
      required
      operatorId
      integer 
      required
      name
      string 
      required
      description
      string 
      required
      imageUrl
      string 
      required
      Example
      [
    {
        "amountToSendX100": 0,
        "productId": 0,
        "operatorId": 0,
        "name": "string",
        "description": "string",
        "imageUrl": "string"
    }
]
      Modified at 2025-07-07 11:10:59
      Previous
      Get Deliver Locations
      Next
      Create Cart
      Built with