Get Fields

This endpoint returns the list of dynamic fields required for cart creation in a given terminal and category context. It is typically used before calling Create Cart, so the client knows exactly what data must be provided to complete the transaction.

⸻

🔍 Description

Use this method to:

Retrieve the fields that must be filled in order to create a cart.

Display localized field labels (English and Spanish) for the UI.

Identify the data types and allowed values for each field.

📌 This endpoint does not return products or categories. Instead, it describes the form structure (fields, labels, and possible values) needed to continue the flow.

⸻

📥 Request Details

Method: GET

Authentication: Required

Path Parameters:

terminalId (integer): ID of the requesting terminal

categoryId (integer): ID of the selected product category

⸻

📤 Response

Returns an array of field objects:

Field	Type	Description
field	string	Field identifier (used when sending values to Create Cart)
type	string	Field type (e.g., string, number, select)
labels	object	Contains localized labels for the field (en, es)
values	array	Possible values for the field (if applicable, e.g., dropdown options)
path	string	Path reference to the dynamic flow configuration (if present)

Example

[
  {
    "field": "nationality",
    "type": "select",
    "labels": {
      "en": "Nationality",
      "es": "Nacionalidad"
    },
    "values": ["Colombiana", "Venezolana", "Argentina"],
    "path": "/physical-products/nationalities"
  },
  {
    "field": "documentNumber",
    "type": "string",
    "labels": {
      "en": "Document Number",
      "es": "Número de Documento"
    },
    "values": [],
    "path": ""
  }
]

🧠 Usage Notes

This method is always called before Create Cart to know what data must be sent.

The labels object ensures multilingual UI support.

values will be populated when the field has predefined options (e.g., nationality, operator).

Fields without values or path are meant to be filled directly by the user (e.g., free text or numbers).

*/*

Body

Example

[
    {
        "field": "string",
        "type": "string",
        "labels": {
            "en": "string",
            "es": "string"
        },
        "values": [
            "string"
        ],
        "path": "string"
    }
]

Request

Request Code Samples

Responses