Incluir atributos

Algunas operaciones de lectura de la API de Ordering aceptan el parámetro de consulta params para reducir la respuesta a los datos que necesita un cliente. Envía los nombres solicitados como una cadena separada por comas.

Para los campos de un modelo, la API limita los nombres solicitados a los campos que ese modelo expone. Cuando id está disponible, se agrega automáticamente si se seleccionó otro campo válido. Una selección vacía, o una selección sin campos de modelo válidos, puede devolver el conjunto completo de campos del modelo en lugar de un objeto vacío.

GET https://api.ordering.co/v400/en/YOUR_PROJECT/orders/6?params=products,driver_id

En la operación de pedidos, products solicita los productos relacionados y driver_id selecciona ese campo del pedido. Una respuesta reducida puede tener esta forma:

{
  "error": false,
  "result": {
    "id": 6,
    "driver_id": 9,
    "products": []
  }
}

Listas de campos y árboles de relaciones

params es específico de cada operación. Algunas operaciones usan una lista plana para seleccionar solo ciertos campos; otras lo usan para incluir relaciones y pueden admitir una forma anidada como relationship(field,field). Usa únicamente los campos y relaciones documentados para la operación que estás llamando. Que una propiedad esté disponible en un modelo no demuestra que todos los endpoints la acepten en params.

Nota sobre SDK heredado: Los ejemplos históricos usan ordering.orders().select(['products', 'driver_id']).get(). No se ha identificado una versión de SDK compatible con esta sintaxis. Usa el contrato HTTP de params documentado para cada operación.