Enumerar los detalles del elemento del catálogo
get
/catalogs/{catalog_name}/items/{item_id}
Utiliza este punto final para devolver un elemento del catálogo y su contenido.
Requisitos previos
Para utilizar este punto final, necesitarás una clave de API con el permiso catalogs.get_item
.
Límite de velocidad
Parámetros de la ruta
Parámetro | Obligatoria | Tipo de datos | Descripción |
---|---|---|---|
catalog_name |
Obligatoria | Cadena | Nombre del catálogo. |
item_id |
Obligatoria | Cadena | El ID del elemento del catálogo. |
Parámetros de la solicitud
No hay cuerpo de petición para este punto final.
Ejemplo de solicitud
1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/catalogs/restaurants/items/restaurant1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
Respuesta
Hay dos respuestas de código de estado para este punto final: 200
y 404
.
Ejemplo de respuesta satisfactoria
El código de estado 200
podría devolver el siguiente cuerpo de respuesta.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"items": [
{
"id": "restaurant3",
"Name": "Restaurant1",
"City": "New York",
"Cuisine": "American",
"Rating": 5,
"Loyalty_Program": true,
"Open_Time": "2022-11-01T09:03:19.967Z"
}
],
"message": "success"
}
Ejemplo de respuesta de error
El código de estado 404
podría devolver la siguiente respuesta. Consulta la sección Solución de problemas para obtener más información sobre los errores que puedas encontrar.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"errors": [
{
"id": "item-not-found",
"message": "Could not find item",
"parameters": [
"item_id"
],
"parameter_values": [
"restaurant34"
]
}
],
"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, si procede.
Error | Solución de problemas |
---|---|
catalog-not-found |
Compruebe que el nombre del catálogo es válido. |
item-not-found |
Compruebe que el artículo está en el catálogo. |
New Stuff!