Crear elemento del catálogo
post
/catalogs/{catalog_name}/items/{item_id}
Utilice este punto final para crear un elemento en su catálogo.
Requisitos previos
Para utilizar este punto final, necesitarás una clave de API con el permiso catalogs.create_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
Parámetro | Obligatoria | Tipo de datos | Descripción |
---|---|---|---|
items |
Obligatoria | Matriz | Una matriz que contiene objetos elemento. Los objetos de artículo deben contener todos los campos del catálogo excepto el campo id . Sólo se permite un objeto por solicitud. |
Ejemplo de solicitud
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
curl --location --request POST 'https://rest.iad-03.braze.com/catalogs/restaurants/items/restaurant1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
"items": [
{
"Name": "Restaurant1",
"City": "New York",
"Cuisine": "American",
"Rating": 5,
"Loyalty_Program": true,
"Location": {
"Latitude": 33.6112,
"Longitude": -117.8711
},
"Top_Dishes": [
"Hamburger",
"Deluxe Cheeseburger"
],
"Created_At": "2022-11-01T09:03:19.967+00:00"
}
]
}'
Respuesta
Existen tres respuestas de código de estado para este punto final: 201
, 400
y 404
.
Ejemplo de respuesta positiva
El código de estado 201
podría devolver el siguiente cuerpo de respuesta.
1
2
3
{
"message": "success"
}
Ejemplo de respuesta de error
El código de estado 400
podría devolver el siguiente cuerpo de respuesta. Consulte la sección Solución de problemas para obtener más información sobre los errores que puede encontrar.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"errors": [
{
"id": "invalid-fields",
"message": "Some of the fields given do not exist in the catalog",
"parameters": [
"id"
],
"parameter_values": [
"restaurant1"
]
}
],
"message": "Invalid Request"
}
Solución de problemas
La siguiente tabla enumera los posibles errores devueltos y los pasos asociados para solucionarlos.
Error | Solución de problemas |
---|---|
arbitrary-error |
Se ha producido un error arbitrario. Vuelva a intentarlo o póngase en contacto con el servicio de asistencia. |
catalog-not-found |
Compruebe que el nombre del catálogo es válido. |
filtered-set-field-too-long |
El valor del campo se está utilizando en un conjunto filtrado que supera el límite de caracteres de un elemento. |
id-in-body |
Elimina cualquier ID de artículo en el cuerpo de la solicitud. |
ids-too-large |
El límite de caracteres para cada ID de artículo es de 250 caracteres. |
invalid-ids |
Los caracteres admitidos para los nombres de ID de artículos son letras, números, guiones y guiones bajos. |
invalid-fields |
Confirme que todos los campos que está enviando en la solicitud API ya existen en el catálogo. Esto no está relacionado con el campo ID mencionado en el error. |
invalid-keys-in-value-object |
Las claves de objeto de artículo no pueden incluir . ni $ . |
item-already-exists |
El artículo ya existe en el catálogo. |
item-array-invalid |
items debe ser un array de objetos. |
items-too-large |
El límite de caracteres para cada elemento es de 5000 caracteres. |
request-includes-too-many-items |
Sólo puede crear un elemento de catálogo por solicitud. |
too-deep-nesting-in-value-object |
Los objetos item no pueden tener más de 50 niveles de anidamiento. |
unable-to-coerce-value |
Los tipos de artículo no se pueden convertir. |
New Stuff!