Propósito

• El parámetro $orderby permite especificar el orden de los resultados devueltos en función de una o varias propiedades.

Puntos clave

• Puedes especificar el orden de clasificación, ascendente o descendente, de una propiedad del recurso.
• La ordenación solo es compatible con propiedades del recurso raíz.
• De forma predeterminada, el orden es ASC por fecha de creación.

Sintaxis de la expresión $orderby

• La expresión sigue este formato:

NOMBRE_PROPIEDAD (asc)|desc

• Ejemplo

cat_ref asc

Propiedades admitidas

• La lista de propiedades disponibles para el recurso Product se puede encontrar en el esquema JSON devuelto por los endpoints /$metadata.
• Ejemplo: al realizar una solicitud a /Products/$metadata, obtendrás un esquema con todas las propiedades disponibles, como prod_title, prod_ref, etc.

Cómo usar $orderby en una solicitud

• Al construir tu solicitud a la API, añade el parámetro $orderby para indicar cómo quieres ordenar los resultados.

http://api2.saleslayer.com/rest/Catalog/Products?$select=prod_ref,cat_ref,prod_description&$orderby=prod_ref asc

Formato de la respuesta

• Cuando construyas tu solicitud a la API, añade el parámetro $orderby para indicar cómo deben ordenarse los resultados. La respuesta incluirá los resultados ordenados según el criterio especificado.

{
    "value": [
        {
            "prod_ref": "Atrius",
            "cat_ref": "OMA",
            "prod_description": {
                "en": "Atrius"
            }
        },
        {
            "prod_ref": "Zatrius",
            "cat_ref": "OMA",
            "prod_description": {
                "en": "Zatrius"
            }
        }
    ],
    "@count": 2,
    "@readLink": "http://api2.saleslayer.com/rest/Catalog/Products?$select=prod_ref,cat_ref,prod_description&$orderby=prod_ref asc"
}