Skip to main content

Crear una venta

POST https://backend.qrupones.com/sale

Seguridad

Esta api utiliza clientSecret, user y password como método de autenticación.

  • Name: X-QRAPI-SECRET
  • Name: X-QRAPI-USER
  • Name: X-QRAPI-PASS
  • In: headers

Consulta cómo obtener las Credenciales

Parámetros de solicitud

NombreDescripciónRequeridoTipo
esRecompraIndica si es compra o recompra/canjeRequeridoboolean
MontoMontoRequeridonumber
SucursalVentaIDID de Sucursal de VentaRequeridonumber
CodigoPaisCódigo de País. Ejemplo: 591 para Bolivia Requeridonumber
MarcasCadena de texto con 0, una o mas marcas separadas por coma. revisa los ejemplos de solicitud para mas detallesRequeridostring
CuponOrigenIDID de Cupón de Origen. Este campo es opcional cuando es venta normal pero es requerido cuando existe un canje de cupónAtenciónnumber
CelularNúmero de TeléfonoOpcionalstring
ClienteNombreNombre del ClienteOpcionalstring
NitNúmero de Identificación TributariaOpcionalstring

Ejemplo de solicitud sin marcas, ni datos de cliente

{
"esRecompra": true,
"Monto": 120,
"SucursalVentaID": 10,
"CodigoPais": 591,
"Marcas": ""
}

Ejemplo de solicitud con una marca + canje de cupón

{
"esRecompra": true,
"Monto": 120,
"SucursalVentaID": 10,
"CodigoPais": 591,
"CuponOrigenID": 1000,
"Marcas": "45",
"Celular": "7777777",
"ClienteNombre": "Pepe QUintana",
"Nit": "5849941"
}

Ejemplo de solicitud con multiples marcas

{
"esRecompra": true,
"Monto": 120,
"SucursalVentaID": 10,
"CodigoPais": 591,
"Marcas": "82,12,10",
"Celular": "7777777",
"ClienteNombre": "Pepe QUintana",
"Nit": "5849941"
}

Respuesta

CodeDescription
200Retorna los datos de la venta
400Retorna los posibles errores de la solicitud
401Unauthorized

Uso 📝

create-sale.js
const headers = new Headers()
headers.append('X-QRAPI-SECRET', 'yourClientSecret')
headers.append('X-QRAPI-USER', 'yourUser')
headers.append('X-QRAPI-PASS', 'yourPassword')

const requestOptions = {
method: 'POST',
headers: headers,
body: JSON.stringify({
esRecompra: true,
Monto: 100.0,
SucursalVentaID: 123,
CodigoPais: 591,
Marcas: 'Marca1,Marca2',
CuponOrigenID: 456,
Celular: '1234567890',
ClienteNombre: 'Nombre del Cliente',
Nit: 'NIT123456789'
}),
redirect: 'follow'
}

fetch('https://backend.qrupones.com/sale', requestOptions)
.then((response) => response.json())
.then((result) => console.log(result))
.catch((error) => console.error('error', error))

Respuesta exitosa ✅

{
"data": {
"Celular": "Número de Celular",
"ClienteNombre": "Nombre del Cliente",
"esRecompra": true,
"Monto": 100,
"SucursalVentaID": 5,
"Marcas": "Marca1, Marca2",
"CuponOrigenID": 2000,
"CodigoPais": 123,
"Nit": "Número de Identificación"
}
}

Respuesta con error 📛

{
"errors": [
{
"type": "field",
"msg": "esRecompra debe ser true o false",
"path": "esRecompra",
"location": "body"
},
{
"type": "field",
"msg": "Monto es obligatorio y debe ser un numero",
"path": "Monto",
"location": "body"
},
...
]
}

Respuesta error de seguridad ⚠️

{
"errors": [
{
"msg": "No existen los parametros de seguridad en la solicitud"
}
]
}