Modificadores del producto

Qué grupos de modificadores tiene un producto, en orden, con su regla de elección y los recargos de opciones por variante.

Cargando el índice de búsqueda…

Modificadores del producto

Objetos

ProductModifierGroups

  • product_idintegerobligatorio

    ID del producto. Los grupos se versionan en su ficha: ETag e If-Match llevan la versión del producto.

  • versionintegerobligatorio

    Versión del registro: crece con cada cambio. Para cambiar el registro, envíela como ETag en If-Match.

  • groupsarray de objectobligatorio

    Los grupos de modificadores del producto en orden de exhibición. Al escribir, el conjunto completo.

    Campos · 2
    • group_idintegerobligatorio

      ID del grupo de modificadores (/v1/modifier-groups).

    • selection_ruleobject o nullobligatorio

      Regla de elección en este producto en lugar de la regla del grupo; null — la regla del grupo.

      Campos · 2
      • min_selectintegerobligatorio

        Cuántas opciones hay que elegir en este producto.

      • max_selectinteger o nullobligatorio

        Cuántas opciones se pueden elegir en este producto; null — sin límite.

  • option_pricesarray de objectobligatorio

    Recargo y disponibilidad de opciones en las variantes del producto en lugar del recargo de la opción. Al escribir, reemplaza los ajustes completos; sin el campo quedan los anteriores, salvo los de grupos quitados.

    Campos · 4
    • option_idintegerobligatorio

      ID de una opción de los grupos del producto.

    • variant_idintegerobligatorio

      ID de la variante del producto.

    • is_availablebooleanobligatorio

      false — la opción no se ofrece en esta variante; esa fila no tiene recargo.

    • price_deltainteger o nullobligatorio

      Recargo de la opción en esta variante, entero en unidades menores de la moneda de la tienda; null solo en una opción no disponible.

Endpoints

Obtener los grupos de modificadores del producto y los recargos de sus opciones por variante

get/products/{product}/modifier-groups

Scope: catalog:read

Parámetros

Ruta

  • productintegerobligatorio

    ID del producto.

Respuestas

200Éxito

Encabezados

  • ETagstringobligatorio

    Versión del registro. Mandala en If-Match para cambiar el registro.

    Ejemplo:
    "7"

application/json

Devuelve ProductModifierGroups

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema 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-Authenticatestring

    Esquema 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-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos 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

Ejemplo de solicitud
curl "https://api.saleya.app/v1/products/{product}/modifier-groups" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "product_id": 0,
  "version": 0,
  "groups": [
    {
      "group_id": 0,
      "selection_rule": {
        "min_select": 0,
        "max_select": 0
      }
    }
  ],
  "option_prices": [
    {
      "option_id": 0,
      "variant_id": 0,
      "is_available": true,
      "price_delta": 0
    }
  ]
}

Reemplazar los grupos de modificadores del producto y los recargos de sus opciones por variante

put/products/{product}/modifier-groups

Scope: catalog:write

Parámetros

Ruta

  • productintegerobligatorio

    ID del producto.

Encabezado

  • Idempotency-Keystring

    Clave ú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-Matchstringobligatorio

    ETag 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

  • groupsarray de objectobligatorio

    Los grupos de modificadores del producto en orden de exhibición. Al escribir, el conjunto completo.

    Máximo de elementos:
    50
    Sin repetidos
    Campos · 2
    • group_idintegerobligatorio

      ID del grupo de modificadores (/v1/modifier-groups).

    • selection_ruleobject o null

      Regla de elección en este producto en lugar de la regla del grupo; null — la regla del grupo.

      Campos · 2
      • min_selectinteger

        Cuántas opciones hay que elegir en este producto.

        Mínimo:
        0
        Máximo:
        99
      • max_selectinteger o null

        Cuántas opciones se pueden elegir en este producto; null — sin límite.

        Mínimo:
        1
        Máximo:
        99
  • option_pricesarray de object

    Recargo y disponibilidad de opciones en las variantes del producto en lugar del recargo de la opción. Al escribir, reemplaza los ajustes completos; sin el campo quedan los anteriores, salvo los de grupos quitados.

    Máximo de elementos:
    2000
    Campos · 4
    • option_idintegerobligatorio

      ID de una opción de los grupos del producto.

    • is_availablebooleanobligatorio

      false — la opción no se ofrece en esta variante; esa fila no tiene recargo.

    • price_deltainteger o null

      Recargo de la opción en esta variante, entero en unidades menores de la moneda de la tienda; null solo en una opción no disponible.

      Mínimo:
      -100000000
      Máximo:
      100000000
    • variant_idintegerobligatorio

      ID de la variante del producto.

Respuestas

200Éxito

Encabezados

  • Idempotent-Replayedstring

    true cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.

    Valores:
    true
  • ETagstringobligatorio

    Versión del registro. Mandala en If-Match para cambiar el registro.

    Ejemplo:
    "7"

application/json

Devuelve ProductModifierGroups

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema 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-Authenticatestring

    Esquema 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-Afterinteger

    Segundos 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-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos 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

Ejemplo de solicitud
curl -X PUT "https://api.saleya.app/v1/products/{product}/modifier-groups" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"' \
  -H "Content-Type: application/json" \
  -d @body.json
Cuerpo de la solicitud — body.json
{
  "groups": [
    {
      "group_id": 0,
      "selection_rule": {
        "min_select": 0,
        "max_select": 1
      }
    }
  ],
  "option_prices": [
    {
      "option_id": 0,
      "is_available": true,
      "price_delta": 0,
      "variant_id": 0
    }
  ]
}
Ejemplo de respuesta · 200
{
  "product_id": 0,
  "version": 0,
  "groups": [
    {
      "group_id": 0,
      "selection_rule": {
        "min_select": 0,
        "max_select": 0
      }
    }
  ],
  "option_prices": [
    {
      "option_id": 0,
      "variant_id": 0,
      "is_available": true,
      "price_delta": 0
    }
  ]
}