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 Labels

      GET
      /physical-products/labels
      This endpoint provides supporting metadata labels that help describe or categorize location-based product flows. These labels are often used to dynamically name UI components or steps in the integration process—such as “Country”, “State”, “Municipality”, “Category”, or “Product Type”.
      This method serves as an initial helper endpoint that allows you to populate the available category list, or to fetch specific field labels associated with a category on demand, but it is not the first step in the dynamic purchase flow.

      🔍 Description#

      Use this method to:
      Retrieve text labels that match the hierarchy or steps required in a product flow
      Display consistent field names for location selection and filtering
      Adjust UI and user experience according to product configuration
      📌 Labels may vary depending on the operator, product type, or geographic model used by the system.

      📥 Request Details#

      Method: GET
      Authentication: Required (via standard headers)
      Parameters: None

      📤 Response#

      Returns an object containing key-value pairs where:
      Each field corresponds to an internal reference (e.g., countryId, categoryId)
      Each label contains the display name or label (e.g., Country, Category)

      Example Response#

      [
        {
          "field": "countryId",
          "labels": {
            "en": "Country",
            "es": "País"
          }
        },
        {
          "field": "categoryId",
          "labels": {
            "en": "Category",
            "es": "Categoría"
          }
        }
      ]

      🧠 Usage Notes#

      Use this endpoint as a first step in configuring multi-language interfaces for physical product flows.
      Labels returned depend on the product and operator configuration, ensuring consistency across dynamic UI flows.
      These values do not influence transaction logic—they are purely for display.

      Request

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

      Responses

      🟢200OK
      application/json
      OK
      Body
      array of:
      field
      string 
      required
      labels
      object 
      required
      Additional properties
      string 
      optional
      Example
      [
          {
              "field": "countryId",
              "labels": {
                  "en": "Country",
                  "es": "Pais"
              }
          },
          {
              "field": "categoryId",
              "labels": {
                  "en": "Category",
                  "es": "Categoria"
              }
          }
      ]
      Modified at 2025-07-09 08:42:52
      Next
      Get Countries
      Built with