Saltar al contenido
API v1 · https://bentho.org/api
GET/api/mod/comercial/{espacio}/config

La configuración comercial

Las reglas de pago con las que se calcula el envío, el peso de los pedidos y los beneficios del espacio.

  • PERMISOlee (vale cualquier clave)
  • CRÉDITOSno gasta
  • AUTENTICACIÓNBearer bth_…

PARÁMETROS

CAMPOTIPOREQUERIDOQUÉ ES
espaciostringSÍEl id del espacio (sale en GET /api/companies). Tiene que tener el módulo Comercial.

RESPUESTA 200

CAMPOTIPOQUÉ ES
name · monedastringUn nombre y la moneda (COP).
reglas_pagoobjectCómo se calcula el envío según el método: ver reglas_pago.
peso_default_pedido_kgstringEl peso de un pedido cuando no hay otro dato, en kilos. De fábrica, 2.
peso_sku{ sku: gramos }El peso de cada producto, en gramos enteros, por su SKU.
beneficios[]arrayBienvenida, envío gratis, pago anticipado…: ver beneficios.

REGLAS_PAGO

CAMPOTIPOQUÉ ES
umbral_aseguradostringDesde este subtotal, la contraentrega va asegurada: IVA y comisión de recaudo en vez de cargo fijo. De fábrica, 250 mil.
cargo_fijo_contrastringEl cargo fijo de contraentrega por debajo del umbral. De fábrica, 5900.
iva_pctstringEl IVA del envío asegurado, como fracción. De fábrica, 0.19.
comision_recaudo_pctstringLa comisión de recaudo sobre subtotal + envío + IVA, como fracción. De fábrica, 0.02.
seguro_declarado_*boolean · string · stringUna regla de valor declarado (_activo, _base_cubierta, _exceso_pct). Se guarda, pero hoy la cotización no la aplica.

BENEFICIOS[]

CAMPOTIPOQUÉ ES
codigo · nombrestringUn código estable y un nombre para reconocerlo.
efecto_tipo"descuento_pct" | "descuento_fijo" | "envio_gratis"Qué hace.
efecto_valorstringEn descuento_pct, la fracción del subtotal (0.1 = 10 %); en descuento_fijo, el monto, sin pasar del subtotal. envio_gratis no lo usa.
activobooleanPor defecto true. Apagado no aplica nunca.
solo_primera_comprabooleanSolo para clientes nuevos. Por defecto false.
subtotal_minstring | nullSubtotal mínimo para aplicar.
metodos_pagostring[]Para qué métodos aplica: contra, transferencia, mixto. Vacío (por defecto): todos.
prosastringLa frase corta que se le dice al cliente, con la voz de tu marca.

ERRORES DE ESTA RUTA · SIEMPRE {"detail": …}

STATUSCUÁNDODETAIL LITERAL
403El espacio no tiene el módulo Comercialmódulo no habilitado para este espacio.

Y los de cualquier ruta —clave inválida, cuenta no al día, IP, límites—, en Errores, límites y créditos.

CONVIENE SABER

  • La primera vez que se lee, se crea con los valores de fábrica y sin beneficios.
  • Las cifras van como texto decimal. La tabla de tarifas no está aquí: ver tarifa activa.