OAuth 2.1

Scopes OAuth

Los 17 scopes disponibles y qué acceso otorga cada uno.

Los scopes definen los permisos que tu app solicita al comerciante en el momento del consentimiento. Siempre solicita el mínimo de scopes que tu integración necesita.

Tabla de scopes

ScopeAcceso que otorga
read:productsListar y leer productos, variantes, imágenes y metadatos
write:productsCrear, actualizar y eliminar productos y variantes
read:categoriesListar y leer categorías del catálogo
write:categoriesCrear, actualizar y eliminar categorías
read:inventoryLeer niveles de inventario por variante y ubicación
write:inventoryActualizar cantidades de inventario
read:discountsListar y leer descuentos, cupones y promociones
write:discountsCrear, actualizar y eliminar descuentos
read:ordersListar y leer pedidos, líneas de pedido y envíos
write:ordersActualizar estado de pedidos, añadir notas, procesar devoluciones
read:customersListar y leer clientes, direcciones y historial de pedidos
write:customersCrear y actualizar clientes y direcciones
read:storeLeer información general de la tienda (nombre, moneda, idioma, etc.)
write:storeActualizar configuración general de la tienda
read:analyticsAcceder a métricas de ventas, visitas y conversión
read:webhooksListar webhooks configurados en la tienda
write:webhooksCrear, actualizar y eliminar webhooks

Cómo se muestran al usuario

En la pantalla de consentimiento, los scopes se agrupan en categorías legibles que describen el área de la tienda afectada:

  • Tu catálogoread:products, write:products, read:categories, write:categories, read:inventory, write:inventory, read:discounts, write:discounts
  • Tus ventasread:orders, write:orders
  • Tus clientesread:customers, write:customers
  • Configuración de tu tiendaread:store, write:store
  • Tus reportesread:analytics
  • Automatizacionesread:webhooks, write:webhooks

Buenas prácticas

  1. Mínimo privilegio — solo solicita los scopes que tu integración usa activamente. Los scopes adicionales generan desconfianza en el usuario.
  2. Scopes de lectura vs. escritura — si tu app solo consulta datos, no solicites los scopes write:*.
  3. Ampliar scopes — si más adelante necesitas scopes adicionales, inicia un nuevo flujo de autorización. El usuario deberá volver a consentir.
  4. Scopes en el registro — declara en el campo scope del registro del cliente el conjunto máximo de scopes que tu app puede solicitar.

Scopes en el access token

El campo scope de la respuesta del token endpoint y de introspección refleja exactamente qué scopes fueron concedidos por el usuario — que puede ser un subconjunto de lo que solicitaste si el usuario denegó alguno.

{
  "active": true,
  "scope": "read:products read:orders",
  ...
}

Valida siempre que el token incluye el scope requerido antes de intentar la operación.

On this page