TRANSACCIÓN

Endpoints

Buscar transacciones

GET /transaction

Descripción: Devuelve transacciones según los filtros proporcionados. Si no se proporciona ningún filtro de fecha, la búsqueda por defecto es devolver datos de los últimos 30 días utilizando la fecha de la transacción como referencia.

curl 'https://api.solucx.com.br/public/transaction?date_from=2024-01-01&date_to=2024-01-31&limit=500' \
  -H 'x-solucx-api-key: YOUR_API_KEY' \
  -H 'x-solucx-user-token: YOUR_USER_TOKEN'

const response = await fetch(
  'https://api.solucx.com.br/public/transaction?date_from=2024-01-01&date_to=2024-01-31&limit=500',
  {
    headers: {
      'x-solucx-api-key': 'YOUR_API_KEY',
      'x-solucx-user-token': 'YOUR_USER_TOKEN'
    }
  }
);
const data = await response.json();

import requests

response = requests.get(
    'https://api.solucx.com.br/public/transaction',
    params={
        'date_from': '2024-01-01',
        'date_to': '2024-01-31',
        'limit': 500
    },
    headers={
        'x-solucx-api-key': 'YOUR_API_KEY',
        'x-solucx-user-token': 'YOUR_USER_TOKEN'
    }
)
data = response.json()

Respuestas:

• 200 OK: Devuelve una lista de transacciones.
• 201 Created: Devuelve un objeto que contiene el enlace al archivo CSV.
• 400 Bad Request: Parámetros inválidos.
• 404 Not Found: No se encontraron transacciones.

Objeto de Retorno:

Crear transacción

POST /transaction

Descripción: Crea una nueva transacción. Es necesario haber registrado previamente la unidad y el colaborador.

POST /public/transaction HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 261

{
  "amount": 1,
  "store_id": 1,
  "employee_id": 1,
  "customer_id": 1,
  "register_date": "text",
  "journey": "text",
  "transaction_id": "text",
  "rating_items": [
    {
      "class_id": 2312,
      "score": 10
    },
    {
      "class": "teste",
      "score": 10
    }
  ],
  "param_{key}": "text",
  "param_{key2}": "text",
  "param_{key3}": "text"
}

Respuestas:

• 201 Created: Transacción creada con éxito.
• 422 Unprocessable Entity: Error de validación.

Buscar transacción por id

GET /transaction/{id}

Descripción: Devuelve una transacción según el id proporcionado.

GET /public/transaction/{id} HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Accept: */*

Respuestas:

• 200 OK: Devuelve la transacción.
• 400 Bad Request: ID inválido.
• 404 Not Found: Transacción no encontrada.

Revertir transacción por id

DELETE /transaction/{id}

Descripción: Revierte una transacción, eliminándola de los informes, pero manteniéndola en el sistema.

DELETE /public/transaction/{id} HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Accept: */*

Respuestas:

• 200 OK: Transacción revertida con éxito.
• 400 Bad Request: Transacción no encontrada.

Usando transactionId para consultas precisas:

Para la infraestructura actual, las consultas que suman transacciones en períodos largos son grandes ofensores, ya que sobrecargan nuestros servidores y generan lentitud tanto en la consulta en cuestión como en las siguientes, por lo tanto se recomienda:

• Consultas que realizan un barrido cuantitativo (count) o búsqueda dentro de un intervalo de tiempo, que se utilice como parámetro de búsqueda el transactionId:

curl --request GET \
--url 'https://api.solucx.com.br/public/transaction?token=1&date_to=2024-04-31&date_from=2024-04-01&transactionId=123' \
--header 'Content-Type: application/json' \
--header 'x-solucx-api-key:x-solucx-api-key'