TRANSAÇÃO V2

Endpoints

Criar transação V2

POST /v2/transactions

Descrição: Interface assíncrona para criar uma transação.

Regras de obrigatoriedade:

  • É obrigatório informar store.id ou store.externalId
  • É obrigatório informar employee.id ou employee.externalId
  • É obrigatório informar customer.id ou customer.externalId
  • É obrigatório informar transaction.journeyId ou transaction.journeySlug

Detalhes de negócio:

  • As classes de ratingItems devem estar disponíveis para a jornada da transação, caso contrário a transação não será criada
  • O valor de ratingItems.score deve ser suportado pelo indicador da classe
  • O valor de rating.score deve ser suportado pelo indicador da jornada, caso contrário o rating será nulo
  • Não serão disparadas pesquisas se a transação já estiver avaliada (rating informado)
  • Caso store.externalId, employee.externalId ou customer.externalId não existam, os respectivos recursos serão criados
  • Caso store.id ou employee.id não existam, será utilizado o padrão (id = 1)
  • O estabelecimento informado deve estar ativo
  • O telefone do cliente pode conter código de país, caso não informado será assumido +55 (BR)
POST /v2/transactions HTTP/1.1
Host: api.solucx.com.br
x-solucx-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*

Respostas:

  • 201 Created: Transação agendada para criação assíncrona. Retorna o objeto enviado.
  • 400 Bad Request: Alguma propriedade do payload é inválida.

Health Check

GET /health

Descrição: Endpoint para verificação de saúde da API.

GET /health HTTP/1.1
Host: api.solucx.com.br
Accept: */*

Parâmetros

Nenhum parâmetro.

Respostas:

  • 200 OK: API está operacional.

Criar transação (Legacy)

POST /public/transaction

Descrição: Interface síncrona (legada) para criar uma transação.

Regras de obrigatoriedade:

  • É obrigatório informar store_id ou store_integration
  • É obrigatório informar employee_id ou employee_integration
  • É obrigatório informar customer_id ou customer_integration
  • É obrigatório informar journey_id ou journey (deve ser válido)

Detalhes de negócio:

  • As classes de rating_items devem estar disponíveis para a jornada da transação, caso contrário a transação não será criada
  • O valor de rating_items.score deve ser suportado pelo indicador da classe
  • O valor de score deve ser suportado pelo indicador da jornada, caso contrário o rating será nulo
  • Não serão disparadas pesquisas se a transação já estiver avaliada (score informado)
  • Caso store_integration, employee_integration ou customer_integration não existam, os respectivos recursos serão criados
  • Caso store_id ou employee_id não existam, será utilizado o padrão (id = 1)
  • O estabelecimento informado deve estar ativo

Respostas:

  • 201 Created: Transação criada com sucesso.
  • 422 Unprocessable Entity: Erro de validação.
Transação
Unidade