Aprende como ampliar la respuesta de la API sin solicitudes extra
Nuestra API permite que, en una misma solicitud, recibas datos de más de un objeto. Esta funcionalidad es similar a la consulta de objetos relacionados de GraphQL pero en una API RESTful, evitando tener que realizar solicitudes innecesarias para completar una operación.
Distintos objetos te permiten ampliar la respuesta enviada por la API utilizando el parámetro de solicitud de expansión (expand) el que puedes agregar como query param en solicitudes GET.
En muchos casos, un objeto contiene el ID de otro objeto relacionado a este. Por ejemplo, un checkout puede tener un ID de customer asociado con el atributo customer_id. En este caso, puedes obtener en la misma respuesta de checkout el detalle del customer asociado, sin necesidad de consultar la API de customer de forma independiente, utilizando el parámetro expand. En este ejemplo, debieras agregar el valor customer al parámetro expand de la forma expand[]=customer.
Los atributos que se pueden expandir en objetos se indican en la documentación con la etiqueta _expandible_.
El parámetro de expansión (expand) es un array que acepta un listado de strings como items. El valor de cada item corresponde al nombre del atributo mencionado en la documentación, por ejemplo expand[]=customer.