TRANSACCIÓN V2

Endpoints

Crear transacción V2

POST /v2/transactions

Descripción: Interfaz asíncrona para crear una transacción.

Reglas de obligatoriedad:

  • Es obligatorio informar store.id o store.externalId
  • Es obligatorio informar employee.id o employee.externalId
  • Es obligatorio informar customer.id o customer.externalId
  • Es obligatorio informar transaction.journeyId o transaction.journeySlug

Detalles de negocio:

  • Las clases de ratingItems deben estar disponibles para la jornada de la transacción, de lo contrario la transacción no será creada
  • El valor de ratingItems.score debe ser soportado por el indicador de la clase
  • El valor de rating.score debe ser soportado por el indicador de la jornada, de lo contrario el rating será nulo
  • No se enviarán encuestas si la transacción ya está evaluada (rating informado)
  • Si store.externalId, employee.externalId o customer.externalId no existen, los respectivos recursos serán creados
  • Si store.id o employee.id no existen, se utilizará el valor por defecto (id = 1)
  • El establecimiento informado debe estar activo
  • El teléfono del cliente puede contener código de país, si no se informa se asumirá +55 (BR)
POST /v2/transactions HTTP/1.1
Host: public-api.gke-prd.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*

Respuestas:

  • 201 Created: Transacción programada para creación asíncrona. Devuelve el objeto enviado.
  • 400 Bad Request: Alguna propiedad del payload es inválida.

Health Check

GET /health

Descripción: Endpoint para verificación de salud de la API.

GET /health HTTP/1.1
Host: public-api.gke-prd.solucx.com.br
Accept: */*

Parámetros

Ningún parámetro.

Respuestas:

  • 200 OK: API está operativa.

Crear transacción (Legacy)

POST /public/transaction

Descripción: Interfaz síncrona (legada) para crear una transacción.

Reglas de obligatoriedad:

  • Es obligatorio informar store_id o store_integration
  • Es obligatorio informar employee_id o employee_integration
  • Es obligatorio informar customer_id o customer_integration
  • Es obligatorio informar journey_id o journey (debe ser válido)

Detalles de negocio:

  • Las clases de rating_items deben estar disponibles para la jornada de la transacción, de lo contrario la transacción no será creada
  • El valor de rating_items.score debe ser soportado por el indicador de la clase
  • El valor de score debe ser soportado por el indicador de la jornada, de lo contrario el rating será nulo
  • No se enviarán encuestas si la transacción ya está evaluada (score informado)
  • Si store_integration, employee_integration o customer_integration no existen, los respectivos recursos serán creados
  • Si store_id o employee_id no existen, se utilizará el valor por defecto (id = 1)
  • El establecimiento informado debe estar activo

Respuestas:

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