Atributos adicionales (metafields)

Los metafields permiten adjuntar datos específicos del proyecto a recursos compatibles de Ordering.co sin cambiar el esquema estándar de esos recursos.

Las rutas actuales de la API exponen operaciones de metafields para estas familias de recursos:

• Usuario
• Negocio
• Categoría
• Producto
• Extra
• Opción adicional
• Subopción de una opción adicional
• Menú
• Oferta
• País
• Dirección
• Pedido
• Carrito
• Grupo de repartidores
• Página

La disponibilidad y los permisos varían según el recurso. Usa la operación mostrada en la Referencia de la API para el recurso que modificas.

Estructura de un metafield

Atributo	Tipo	Obligatorio al crear	Descripción
key	cadena	Sí	Nombre del atributo adicional.
value	varía según value_type	Sí	Valor almacenado.
value_type	cadena	Sí	Controla la validación y cómo la API expande el valor almacenado.

Los valores de value_type admitidos son:

• integer
• decimal
• boolean
• text
• json

La API almacena el registro de metafield con campos como id, object_id, model, key, value, value_type, created_at y updated_at.

Leer metafields

Las operaciones heredadas de lista y detalle pueden exponer metafields de dos formas mediante el parámetro de consulta params:

• Incluye metadata para expandir las claves de metafield como atributos en el recurso.
• Incluye metafields para devolver el arreglo metafields.

El soporte depende de cada endpoint. Comprueba el esquema de la operación antes de depender de cualquiera de las proyecciones.

Ejemplo de atributo expandido:

{
  "id": 1292,
  "name": "Example product",
  "custom_label": "Example value"
}

Ejemplo de arreglo de metafields:

{
  "id": 1292,
  "name": "Example product",
  "metafields": [
    {
      "id": 1,
      "object_id": 1292,
      "model": "Product",
      "key": "custom_label",
      "value": "Example value",
      "value_type": "text",
      "created_at": "2026-01-15 10:00:00",
      "updated_at": "2026-01-15 10:00:00"
    }
  ]
}

Cuando no se solicita ninguna de las proyecciones, el comportamiento de la respuesta puede variar según el endpoint. Considera como fuente de autoridad el esquema de la operación actual.