Enumerar múltiples detalles de elementos del catálogo

Usa este punto de conexión para devolver varios elementos del catálogo y su contenido.

Requisitos previos

Para utilizar este punto de conexión, necesitarás una clave de API con el permiso catalogs.get_items.

Límite de velocidad

Este punto de conexión tiene un límite de velocidad compartido de 50 solicitudes por minuto entre todos los puntos finales de elementos de catálogo síncronos, como se documenta en Límites de velocidad de la API.

Parámetros de ruta

Parámetros de consulta

Ten en cuenta que cada llamada a este punto de conexión devolverá 50 elementos. Para un catálogo con más de 50 elementos, utiliza el encabezado Link para recuperar los datos en la página siguiente, como se muestra en el siguiente ejemplo de respuesta.

Parámetros de la solicitud

No hay cuerpo de solicitud para este punto de conexión.

Ejemplos de solicitudes

Sin cursor

1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/catalogs/restaurants/items' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Con cursor

1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/catalogs/restaurants/items?cursor=c2tpcDow' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Respuesta

Existen tres respuestas de código de estado para este punto de conexión: 200, 400 y 404.

Ejemplo de respuesta correcta

El código de estado 200 podría devolver el siguiente encabezado y cuerpo de respuesta.

Nota

El encabezado Link no existirá si el catálogo tiene 50 elementos o menos. En las llamadas sin cursor, prev no se mostrará. Al consultar la última página de elementos, next no se mostrará.

1
Link: </catalogs/all_restaurants/items?cursor=c2tpcDow>; rel="prev",</catalogs/all_restaurants/items?cursor=c2tpcDoxMDA=>; rel="next"

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "items": [
    {
      "id": "restaurant1",
      "Name": "Restaurant1",
      "City": "New York",
      "Cuisine": "American",
      "Rating": 5,
      "Loyalty_Program": true,
      "Open_Time": "2022-11-02T09:03:19.967Z"
    },
    {
      "id": "restaurant2",
      "Name": "Restaurant2",
      "City": "New York",
      "Cuisine": "American",
      "Rating": 10,
      "Loyalty_Program": true,
      "Open_Time": "2022-11-02T09:03:19.967Z"
    },
    {
      "id": "restaurant3",
      "Name": "Restaurant3",
      "City": "New York",
      "Cuisine": "American",
      "Rating": 5,
      "Loyalty_Program": false,
      "Open_Time": "2022-11-02T09:03:19.967Z"
    }
  ],
  "message": "success"
}

Ejemplo de respuesta de error

El código de estado 400 podría devolver el siguiente cuerpo de respuesta. Consulta la sección Solución de problemas para obtener más información sobre los errores que puedes encontrar.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "errors": [
    {
      "id": "invalid-cursor",
      "message": "'cursor' is not valid",
      "parameters": [
        "cursor"
      ],
      "parameter_values": [
        "bad-cursor"
      ]
    }
  ],
  "message": "Invalid Request"
}

Solución de problemas

La siguiente tabla enumera los posibles errores devueltos y sus pasos asociados para la solución de problemas.