Grupos de modificadores
Elecciones para un ítem: salsas, extras, tamaño de porción. El grupo fija los límites de la elección; las opciones, el recargo y la composición.
Grupos de modificadores
Objetos
ModifierGroup
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
external_idstring o nullobligatorioID externo: el ID del registro en tu sistema; null si la aplicación no lo fijó. Cada aplicación ve solo sus propios ID.
versionintegerobligatorioVersión del registro: crece con cada cambio. Para cambiar el registro, envíela como ETag en If-Match.
namemapa de stringobligatorioNombre por idioma: un objeto con los idiomas completados, por ejemplo {"es": "Café", "en": "Coffee"}.
min_selectintegerobligatorioCuántas opciones debe elegir el cliente: 0 — el grupo es opcional. Un producto puede fijar su propia regla (selection_rule).
max_selectinteger o nullobligatorioCuántas opciones se pueden elegir en total, con repeticiones; null — sin límite.
is_activebooleanobligatoriofalse — el grupo está apagado y no se ofrece en los productos.
adds_ingredientsbooleanobligatorioSi las opciones del grupo cambian la composición del plato; con true, una opción sin composición propia deja desconocida la composición del ítem (alérgenos).
optionsarray de objectobligatorioOpciones en orden de exhibición. Al escribir, el conjunto completo: una fila encuentra su opción por id o external_id, a la encontrada se le escriben los campos enviados, una fila sin opción es nueva y lleva name; una opción que falta en el conjunto se archiva y se quita de los borradores de pedido abiertos.
Campos · 12
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
external_idstring o nullobligatorioID externo: el ID del registro en tu sistema; null si la aplicación no lo fijó. Cada aplicación ve solo sus propios ID.
nameobjectobligatorioNombre por idioma: un objeto con los idiomas completados, por ejemplo {"es": "Café", "en": "Coffee"}.
price_deltaintegerobligatorioRecargo sobre el precio del ítem por porción de la opción, entero en unidades menores de la moneda de la tienda; negativo — un descuento. Un producto puede fijar su propio recargo por variante.
max_quantityinteger o nullobligatorioCuántas veces se puede tomar la opción en un ítem; null — sin límite propio, rige solo el max_select del grupo.
duration_minutesinteger o nullobligatorioCuántos minutos suma la opción a un servicio con turno, múltiplo de 5; null — ninguno. No aplica a otros tipos de ítems.
is_activebooleanobligatoriofalse — la opción está apagada y no se ofrece.
is_defaultbooleanobligatorioLa opción viene preseleccionada: la tienda y el POS la marcan de entrada, y el servidor completa con ella un grupo obligatorio vacío.
adds_ingredientsboolean o nullobligatorioSi esta opción cambia la composición; null — como el grupo (adds_ingredients).
recipe_per_variantbooleanobligatorioEl consumo depende del plato: sin composición general, la cantidad la fija la receta de cada variante (option_recipes); sin ella la opción no se ofrece en esa variante.
nutritionobject o nullobligatorioValor nutricional de un uso de la opción declarado por la tienda: los cuatro números o null — entonces lo calcula la composición de la opción.
Campos · 4
kcalintegerobligatorioEnergía, kcal.
protein_mgintegerobligatorioProteínas, mg.
fat_mgintegerobligatorioGrasas, mg.
carbs_mgintegerobligatorioCarbohidratos, mg.
recipearray de objectobligatorioComposición general de la opción — lo que consume en cualquier plato: insumos y preelaborados con su cantidad. Vacía en una opción por plato. Al escribir, la lista completa, una vacía la limpia; sin el campo la composición queda como está.
Campos · 2
variant_idintegerobligatorioID de la variante del producto.
quantitystring o nullobligatorioCantidad del componente por un uso de la opción, como texto decimal en la unidad del componente; null — a gusto: en la composición pero sin consumo.
created_atstring (date-time)obligatorioCuándo se creó el registro.
updated_atstring (date-time)obligatorioCuándo cambió el registro por última vez.
deleted_atstring (date-time) o nullobligatorioCuándo se archivó el registro; null en un registro vigente.
Endpoints
Listar los grupos de modificadores con opciones cambiados desde el momento indicado
get/modifier-groups
Scope: catalog:read
Parámetros
Query
limitintegerTamaño de página: hasta 250 registros; 50 por defecto.
- Mínimo:
- 1
- Máximo:
- 250
cursorstringCursor opaco: next_cursor de la página anterior, o sync_cursor de la última página guardado por la sincronización anterior. El listado va en orden de confirmación, así que el cursor de sincronización devuelve luego solo lo que cambió después de él.
- Largo máximo:
- 4096
updated_sincestring (date-time)Solo los registros cambiados después de este momento, ISO 8601 con zona horaria. Un filtro de la primera sincronización; después se sigue con el cursor.
- Patrón:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
include_deletedbooleantrue — devolver también los registros eliminados: los archivados con deleted_at y los borrados de la base como marcas de eliminación {id, deleted_at} en la continuación por el cursor de sincronización. Activalo para sincronizar.
Respuestas
200Éxito
application/json
Registros de la página.
deletedarray de objectobligatorioRegistros borrados de la base desde el cursor, como marcas de eliminación: solo con include_deleted=true en la continuación por el cursor de sincronización.
Campos · 2
idintegerobligatorioID del registro borrado.
deleted_atstring (date-time)obligatorioCuándo se borró el registro.
next_cursorstring o nullobligatorioCursor de la página siguiente; null en la última.
has_morebooleanobligatoriotrue si hay una página siguiente.
sync_cursorstring o nullobligatorioEn la última página — el cursor desde el que continuar más tarde: con él llega solo lo que cambió después de esta página. null en las demás.
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
410El cursor de sincronización supera el plazo de conservación de eliminaciones o se emitió antes de restaurar la base de datos
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl "https://api.saleya.app/v1/modifier-groups" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"external_id": "string",
"version": 0,
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 0,
"is_active": true,
"adds_ingredients": true,
"options": [
{
"id": 0,
"external_id": "string",
"name": {},
"price_delta": 0,
"max_quantity": 0,
"duration_minutes": 0,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"deleted": [
{
"id": 0,
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"next_cursor": "string",
"has_more": true,
"sync_cursor": "string"
}Crear un grupo de modificadores con opciones
post/modifier-groups
Scope: catalog:write
Parámetros
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
Cuerpo de la solicitud application/json
namemapa de string o nullobligatorioNombre por idioma: un objeto con los idiomas completados, por ejemplo {"es": "Café", "en": "Coffee"}.
- Largo máximo:
- 255
min_selectintegerCuántas opciones debe elegir el cliente: 0 — el grupo es opcional. Un producto puede fijar su propia regla (selection_rule).
- Mínimo:
- 0
- Máximo:
- 99
max_selectinteger o nullCuántas opciones se pueden elegir en total, con repeticiones; null — sin límite.
- Mínimo:
- 1
- Máximo:
- 99
is_activebooleanfalse — el grupo está apagado y no se ofrece en los productos.
adds_ingredientsbooleanSi las opciones del grupo cambian la composición del plato; con true, una opción sin composición propia deja desconocida la composición del ítem (alérgenos).
optionsarray de objectobligatorioOpciones en orden de exhibición. Al escribir, el conjunto completo: una fila encuentra su opción por id o external_id, a la encontrada se le escriben los campos enviados, una fila sin opción es nueva y lleva name; una opción que falta en el conjunto se archiva y se quita de los borradores de pedido abiertos.
- Mínimo de elementos:
- 1
- Máximo de elementos:
- 100
- Sin repetidos
Campos · 11
external_idstring o nullID externo: el ID del registro en tu sistema; null si la aplicación no lo fijó. Cada aplicación ve solo sus propios ID.
namemapa de string o nullNombre por idioma: un objeto con los idiomas completados, por ejemplo {"es": "Café", "en": "Coffee"}.
- Largo máximo:
- 255
price_deltaintegerRecargo sobre el precio del ítem por porción de la opción, entero en unidades menores de la moneda de la tienda; negativo — un descuento. Un producto puede fijar su propio recargo por variante.
- Mínimo:
- -100000000
- Máximo:
- 100000000
max_quantityinteger o nullCuántas veces se puede tomar la opción en un ítem; null — sin límite propio, rige solo el max_select del grupo.
- Mínimo:
- 1
- Máximo:
- 99
duration_minutesinteger o nullCuántos minutos suma la opción a un servicio con turno, múltiplo de 5; null — ninguno. No aplica a otros tipos de ítems.
- Mínimo:
- 5
- Máximo:
- 120
is_activebooleanfalse — la opción está apagada y no se ofrece.
is_defaultbooleanLa opción viene preseleccionada: la tienda y el POS la marcan de entrada, y el servidor completa con ella un grupo obligatorio vacío.
adds_ingredientsboolean o nullSi esta opción cambia la composición; null — como el grupo (adds_ingredients).
recipe_per_variantbooleanEl consumo depende del plato: sin composición general, la cantidad la fija la receta de cada variante (option_recipes); sin ella la opción no se ofrece en esa variante.
nutritionobject o nullValor nutricional de un uso de la opción declarado por la tienda: los cuatro números o null — entonces lo calcula la composición de la opción.
Campos · 4
kcalintegerEnergía, kcal.
- Mínimo:
- 0
- Máximo:
- 1000000
protein_mgintegerProteínas, mg.
- Mínimo:
- 0
- Máximo:
- 100000000
fat_mgintegerGrasas, mg.
- Mínimo:
- 0
- Máximo:
- 100000000
carbs_mgintegerCarbohidratos, mg.
- Mínimo:
- 0
- Máximo:
- 100000000
recipearray de objectComposición general de la opción — lo que consume en cualquier plato: insumos y preelaborados con su cantidad. Vacía en una opción por plato. Al escribir, la lista completa, una vacía la limpia; sin el campo la composición queda como está.
- Máximo de elementos:
- 100
Campos · 2
variant_idintegerobligatorioID de la variante del producto.
quantitystring o nullobligatorioCantidad del componente por un uso de la opción, como texto decimal en la unidad del componente; null — a gusto: en la composición pero sin consumo.
- Largo máximo:
- 32
external_idstring o nullID externo: el ID del registro en tu sistema; null si la aplicación no lo fijó. Cada aplicación ve solo sus propios ID.
Respuestas
201Creado
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
Locationstring (uri)obligatorioDirección del registro creado; en una solicitud aceptada (202), la dirección donde seguir su resultado.
application/json
Devuelve ModifierGroup
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
external_id_archivedEl registro con este ID externo está archivado - 409
external_id_in_useEl ID externo está en uso - 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
record_limit_reachedSe alcanzó el tope de registros - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X POST "https://api.saleya.app/v1/modifier-groups" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 1,
"is_active": true,
"adds_ingredients": true,
"options": [
{
"external_id": "string",
"name": {
"key": "string"
},
"price_delta": 0,
"max_quantity": 1,
"duration_minutes": 5,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"external_id": "string"
}{
"id": 0,
"external_id": "string",
"version": 0,
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 0,
"is_active": true,
"adds_ingredients": true,
"options": [
{
"id": 0,
"external_id": "string",
"name": {},
"price_delta": 0,
"max_quantity": 0,
"duration_minutes": 0,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Obtener un grupo de modificadores con sus opciones
get/modifier-groups/{group}
Scope: catalog:read
Parámetros
Ruta
groupintegerobligatorioID del grupo de modificadores.
Respuestas
200Éxito
Encabezados
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve ModifierGroup
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl "https://api.saleya.app/v1/modifier-groups/{group}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"external_id": "string",
"version": 0,
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 0,
"is_active": true,
"adds_ingredients": true,
"options": [
{
"id": 0,
"external_id": "string",
"name": {},
"price_delta": 0,
"max_quantity": 0,
"duration_minutes": 0,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Modificar un grupo de modificadores y su conjunto de opciones
patch/modifier-groups/{group}
Scope: catalog:write
Parámetros
Ruta
groupintegerobligatorioID del grupo de modificadores.
Query
consentobjectConsentimientos a las consecuencias del cambio, por tipo: consent[<consent_kind>]=<consent_token> de una respuesta 409 consent_required. Conservá los consentimientos ya dados cuando se pide el tipo siguiente.
Campos · 1
modifier_product_minimumstringLos productos con su propia regla de elección pasan a tener un mínimo igual a la cantidad de opciones activas del grupo; si no, no se podrían comprar.
- Largo mínimo:
- 64
- Largo máximo:
- 64
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringobligatorioETag del registro de la última lectura, por ejemplo "7". El cambio se aplica solo si nadie cambió el registro desde entonces; si no, 412. Sin él, 428.
- Ejemplo:
"7"
Cuerpo de la solicitud application/json
optionsarray de objectOpciones en orden de exhibición. Al escribir, el conjunto completo: una fila encuentra su opción por id o external_id, a la encontrada se le escriben los campos enviados, una fila sin opción es nueva y lleva name; una opción que falta en el conjunto se archiva y se quita de los borradores de pedido abiertos.
- Mínimo de elementos:
- 1
- Máximo de elementos:
- 100
- Sin repetidos
Campos · 12
idintegerID del registro, único entre los registros de su tipo en la tienda.
external_idstring o nullID externo: el ID del registro en tu sistema; null si la aplicación no lo fijó. Cada aplicación ve solo sus propios ID.
namemapa de string o nullNombre por idioma: un objeto con los idiomas completados, por ejemplo {"es": "Café", "en": "Coffee"}.
- Largo máximo:
- 255
price_deltaintegerRecargo sobre el precio del ítem por porción de la opción, entero en unidades menores de la moneda de la tienda; negativo — un descuento. Un producto puede fijar su propio recargo por variante.
- Mínimo:
- -100000000
- Máximo:
- 100000000
max_quantityinteger o nullCuántas veces se puede tomar la opción en un ítem; null — sin límite propio, rige solo el max_select del grupo.
- Mínimo:
- 1
- Máximo:
- 99
duration_minutesinteger o nullCuántos minutos suma la opción a un servicio con turno, múltiplo de 5; null — ninguno. No aplica a otros tipos de ítems.
- Mínimo:
- 5
- Máximo:
- 120
is_activebooleanfalse — la opción está apagada y no se ofrece.
is_defaultbooleanLa opción viene preseleccionada: la tienda y el POS la marcan de entrada, y el servidor completa con ella un grupo obligatorio vacío.
adds_ingredientsboolean o nullSi esta opción cambia la composición; null — como el grupo (adds_ingredients).
recipe_per_variantbooleanEl consumo depende del plato: sin composición general, la cantidad la fija la receta de cada variante (option_recipes); sin ella la opción no se ofrece en esa variante.
nutritionobject o nullValor nutricional de un uso de la opción declarado por la tienda: los cuatro números o null — entonces lo calcula la composición de la opción.
Campos · 4
kcalintegerEnergía, kcal.
- Mínimo:
- 0
- Máximo:
- 1000000
protein_mgintegerProteínas, mg.
- Mínimo:
- 0
- Máximo:
- 100000000
fat_mgintegerGrasas, mg.
- Mínimo:
- 0
- Máximo:
- 100000000
carbs_mgintegerCarbohidratos, mg.
- Mínimo:
- 0
- Máximo:
- 100000000
recipearray de objectComposición general de la opción — lo que consume en cualquier plato: insumos y preelaborados con su cantidad. Vacía en una opción por plato. Al escribir, la lista completa, una vacía la limpia; sin el campo la composición queda como está.
- Máximo de elementos:
- 100
Campos · 2
variant_idintegerobligatorioID de la variante del producto.
quantitystring o nullobligatorioCantidad del componente por un uso de la opción, como texto decimal en la unidad del componente; null — a gusto: en la composición pero sin consumo.
- Largo máximo:
- 32
namemapa de string o nullNombre por idioma: un objeto con los idiomas completados, por ejemplo {"es": "Café", "en": "Coffee"}.
- Largo máximo:
- 255
min_selectintegerCuántas opciones debe elegir el cliente: 0 — el grupo es opcional. Un producto puede fijar su propia regla (selection_rule).
- Mínimo:
- 0
- Máximo:
- 99
max_selectinteger o nullCuántas opciones se pueden elegir en total, con repeticiones; null — sin límite.
- Mínimo:
- 1
- Máximo:
- 99
is_activebooleanfalse — el grupo está apagado y no se ofrece en los productos.
adds_ingredientsbooleanSi las opciones del grupo cambian la composición del plato; con true, una opción sin composición propia deja desconocida la composición del ítem (alérgenos).
external_idstring o nullID externo: el ID del registro en tu sistema; null si la aplicación no lo fijó. Cada aplicación ve solo sus propios ID.
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve ModifierGroup
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
412El registro cambió después de leerlo: la versión de If-Match no es la actual
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
428La solicitud necesita If-Match con el ETag del registro
application/problem+json
Devuelve Problem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
consent_requiredHace falta consentir las consecuencias - 409
external_id_archivedEl registro con este ID externo está archivado - 409
external_id_in_useEl ID externo está en uso - 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 412
precondition_failedEl registro cambió - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida - 428
precondition_requiredFalta If-Match
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X PATCH "https://api.saleya.app/v1/modifier-groups/{group}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"' \
-H "Content-Type: application/json" \
-d @body.json{
"options": [
{
"id": 0,
"external_id": "string",
"name": {
"key": "string"
},
"price_delta": 0,
"max_quantity": 1,
"duration_minutes": 5,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 1,
"is_active": true,
"adds_ingredients": true,
"external_id": "string"
}{
"id": 0,
"external_id": "string",
"version": 0,
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 0,
"is_active": true,
"adds_ingredients": true,
"options": [
{
"id": 0,
"external_id": "string",
"name": {},
"price_delta": 0,
"max_quantity": 0,
"duration_minutes": 0,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Archivar un grupo de modificadores
delete/modifier-groups/{group}
Scope: catalog:write
Parámetros
Ruta
groupintegerobligatorioID del grupo de modificadores.
Query
consentobjectConsentimientos a las consecuencias del cambio, por tipo: consent[<consent_kind>]=<consent_token> de una respuesta 409 consent_required. Conservá los consentimientos ya dados cuando se pide el tipo siguiente.
Campos · 1
modifier_group_archivestringArchivar el grupo lo quita de los productos, rompe la elección en los carritos de los clientes y quita sus opciones de los borradores de pedido abiertos.
- Largo mínimo:
- 64
- Largo máximo:
- 64
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringobligatorioETag del registro de la última lectura, por ejemplo "7". El cambio se aplica solo si nadie cambió el registro desde entonces; si no, 412. Sin él, 428.
- Ejemplo:
"7"
Respuestas
204Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
Sin cuerpo
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
412El registro cambió después de leerlo: la versión de If-Match no es la actual
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
428La solicitud necesita If-Match con el ETag del registro
application/problem+json
Devuelve Problem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
consent_requiredHace falta consentir las consecuencias - 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
in_use_conflictRegistro en uso - 412
precondition_failedEl registro cambió - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida - 428
precondition_requiredFalta If-Match
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X DELETE "https://api.saleya.app/v1/modifier-groups/{group}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H 'If-Match: "7"'Obtener un grupo de modificadores por ID externo
get/modifier-groups/by-external-id/{external_id}
Scope: catalog:read
Parámetros
Ruta
external_idstringobligatorioID externo: el ID del registro en tu sistema.
Respuestas
200Éxito
Encabezados
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve ModifierGroup
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
404El objeto no existe o no está disponible para la aplicación
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl "https://api.saleya.app/v1/modifier-groups/by-external-id/{external_id}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"external_id": "string",
"version": 0,
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 0,
"is_active": true,
"adds_ingredients": true,
"options": [
{
"id": 0,
"external_id": "string",
"name": {},
"price_delta": 0,
"max_quantity": 0,
"duration_minutes": 0,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}Crear o modificar un grupo de modificadores por ID externo
patch/modifier-groups/by-external-id/{external_id}
Scope: catalog:write
Parámetros
Ruta
external_idstringobligatorioID externo: el ID del registro en tu sistema.
Query
consentobjectConsentimientos a las consecuencias del cambio, por tipo: consent[<consent_kind>]=<consent_token> de una respuesta 409 consent_required. Conservá los consentimientos ya dados cuando se pide el tipo siguiente.
Campos · 1
modifier_product_minimumstringLos productos con su propia regla de elección pasan a tener un mínimo igual a la cantidad de opciones activas del grupo; si no, no se podrían comprar.
- Largo mínimo:
- 64
- Largo máximo:
- 64
Encabezado
Idempotency-KeystringClave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.
- Largo mínimo:
- 1
- Largo máximo:
- 255
- Ejemplo:
8e03978e-40d5-43e8-bc93-6894a57f9324
If-MatchstringETag del registro de la última lectura. Es obligatorio si ya existe un registro con este ID externo (si no, 428) y no tiene que estar si no existe.
- Ejemplo:
"7"
If-None-Matchstring* — solo crear: si ya existe un registro con este ID externo, la solicitud recibe 412.
- Valores:
*
Cuerpo de la solicitud application/json
optionsarray de objectOpciones en orden de exhibición. Al escribir, el conjunto completo: una fila encuentra su opción por id o external_id, a la encontrada se le escriben los campos enviados, una fila sin opción es nueva y lleva name; una opción que falta en el conjunto se archiva y se quita de los borradores de pedido abiertos.
- Mínimo de elementos:
- 1
- Máximo de elementos:
- 100
- Sin repetidos
Campos · 12
idintegerID del registro, único entre los registros de su tipo en la tienda.
external_idstring o nullID externo: el ID del registro en tu sistema; null si la aplicación no lo fijó. Cada aplicación ve solo sus propios ID.
namemapa de string o nullNombre por idioma: un objeto con los idiomas completados, por ejemplo {"es": "Café", "en": "Coffee"}.
- Largo máximo:
- 255
price_deltaintegerRecargo sobre el precio del ítem por porción de la opción, entero en unidades menores de la moneda de la tienda; negativo — un descuento. Un producto puede fijar su propio recargo por variante.
- Mínimo:
- -100000000
- Máximo:
- 100000000
max_quantityinteger o nullCuántas veces se puede tomar la opción en un ítem; null — sin límite propio, rige solo el max_select del grupo.
- Mínimo:
- 1
- Máximo:
- 99
duration_minutesinteger o nullCuántos minutos suma la opción a un servicio con turno, múltiplo de 5; null — ninguno. No aplica a otros tipos de ítems.
- Mínimo:
- 5
- Máximo:
- 120
is_activebooleanfalse — la opción está apagada y no se ofrece.
is_defaultbooleanLa opción viene preseleccionada: la tienda y el POS la marcan de entrada, y el servidor completa con ella un grupo obligatorio vacío.
adds_ingredientsboolean o nullSi esta opción cambia la composición; null — como el grupo (adds_ingredients).
recipe_per_variantbooleanEl consumo depende del plato: sin composición general, la cantidad la fija la receta de cada variante (option_recipes); sin ella la opción no se ofrece en esa variante.
nutritionobject o nullValor nutricional de un uso de la opción declarado por la tienda: los cuatro números o null — entonces lo calcula la composición de la opción.
Campos · 4
kcalintegerEnergía, kcal.
- Mínimo:
- 0
- Máximo:
- 1000000
protein_mgintegerProteínas, mg.
- Mínimo:
- 0
- Máximo:
- 100000000
fat_mgintegerGrasas, mg.
- Mínimo:
- 0
- Máximo:
- 100000000
carbs_mgintegerCarbohidratos, mg.
- Mínimo:
- 0
- Máximo:
- 100000000
recipearray de objectComposición general de la opción — lo que consume en cualquier plato: insumos y preelaborados con su cantidad. Vacía en una opción por plato. Al escribir, la lista completa, una vacía la limpia; sin el campo la composición queda como está.
- Máximo de elementos:
- 100
Campos · 2
variant_idintegerobligatorioID de la variante del producto.
quantitystring o nullobligatorioCantidad del componente por un uso de la opción, como texto decimal en la unidad del componente; null — a gusto: en la composición pero sin consumo.
- Largo máximo:
- 32
namemapa de string o nullNombre por idioma: un objeto con los idiomas completados, por ejemplo {"es": "Café", "en": "Coffee"}.
- Largo máximo:
- 255
min_selectintegerCuántas opciones debe elegir el cliente: 0 — el grupo es opcional. Un producto puede fijar su propia regla (selection_rule).
- Mínimo:
- 0
- Máximo:
- 99
max_selectinteger o nullCuántas opciones se pueden elegir en total, con repeticiones; null — sin límite.
- Mínimo:
- 1
- Máximo:
- 99
is_activebooleanfalse — el grupo está apagado y no se ofrece en los productos.
adds_ingredientsbooleanSi las opciones del grupo cambian la composición del plato; con true, una opción sin composición propia deja desconocida la composición del ítem (alérgenos).
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
application/json
Devuelve ModifierGroup
201Creado
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersión del registro. Mandala en If-Match para cambiar el registro.
- Ejemplo:
"7"
Locationstring (uri)obligatorioDirección del registro creado; en una solicitud aceptada (202), la dirección donde seguir su resultado.
application/json
Devuelve ModifierGroup
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve ConflictProblem
412El registro cambió después de leerlo: la versión de If-Match no es la actual
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
428La solicitud necesita If-Match con el ETag del registro
application/problem+json
Devuelve Problem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
consent_requiredHace falta consentir las consecuencias - 409
external_id_archivedEl registro con este ID externo está archivado - 409
external_id_in_useEl ID externo está en uso - 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 409
record_limit_reachedSe alcanzó el tope de registros - 412
precondition_failedEl registro cambió - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida - 428
precondition_requiredFalta If-Match
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl -X PATCH "https://api.saleya.app/v1/modifier-groups/by-external-id/{external_id}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN" \
-H "Content-Type: application/json" \
-d @body.json{
"options": [
{
"id": 0,
"external_id": "string",
"name": {
"key": "string"
},
"price_delta": 0,
"max_quantity": 1,
"duration_minutes": 5,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 1,
"is_active": true,
"adds_ingredients": true
}{
"id": 0,
"external_id": "string",
"version": 0,
"name": {
"key": "string"
},
"min_select": 0,
"max_select": 0,
"is_active": true,
"adds_ingredients": true,
"options": [
{
"id": 0,
"external_id": "string",
"name": {},
"price_delta": 0,
"max_quantity": 0,
"duration_minutes": 0,
"is_active": true,
"is_default": true,
"adds_ingredients": true,
"recipe_per_variant": true,
"nutrition": {
"kcal": 0,
"protein_mg": 0,
"fat_mg": 0,
"carbs_mg": 0
},
"recipe": [
{
"variant_id": 0,
"quantity": "string"
}
]
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}