APIs Autoatendimento

Requisitos técnicos

Parâmetros de entrada

Headers

Key	Value
X-Auth-Token	Token de autenticação
Content-Type	Define o tipo de conteúdo da página e o tipo de codificação de caracteres. No caso, “application/json”

Listar Entrega

Retorna entregas do pedido;

- Meio de pagamento;

- Dados do cliente;

- Rastreio; - Itens;

- Matriz de classificação disponível para o pedido de acordo com o ponto / status do mesmo. Ao abrir a tela para cancelamento, as opções de atendimento devem ser apresentadas, para que o cliente opte por reembolso, vale ou troca do item.

Caso o pagamento tenha sido boleto ou débito em conta, a tela deverá habilitar o preenchimento dos dados da conta bancária do cliente. Neste caso, o CPF para reembolso deverá ser o mesmo do cliente, sem opção de alteração. O valor do reembolso também não poderá ser alterado, para ambos os casos.

URL do método GET

Produção: http://api.bseller.com.br/sac/atendimento/entregas/{idPedido}

Teste: http://backstg.bseller.com.br/api/sac/atendimento/entregas/{idPedido}

Link Documentação Swagger

http://api.bseller.com.br/swagger-ui.html#!/sac/ListarEntregaUsingGET

Response:

{
"quantidadeEntregas": 2,
"entregas": [
{
"idEntrega": "28695568",
"idFilial": 1,
"idMeioPagamentoPrincipal": 51,
"clienteEntrega": { ... }
},
"rastreio": { ... },
"itens": [
{ ... }
],
"matrizClassificacao": [ {...}

]
},
{
"idEntrega": "28695736",
"idFilial": 1,
"idMeioPagamentoPrincipal": 3,
"clienteEntrega": {
"id": 5713561500,
"nome": "Nome do Cliente de Faturamento 2",
"endereco": { ... }
},
"rastreio": { ... }

"itens": [
{ ... }
],
"matrizClassificacao": [
{ ... }
]
}
]
}

Validar Entrega

Recebe informações do pedido e a lista de motivos do cancelamento; oriundos do primeiro endpoint de Listar Entregas. Ao clicar em cancelar, o sistema realizará uma última validação do status do pedido.

URL do método POST

Produção: http://api.bseller.com.br/api/sac/atendimento/entregas/validar
Teste: http://backstg.bseller.com.br/api/sac/atendimento/entregas/validar

Link Documentação Swagger

http://api.bseller.com.br/swagger-ui.html#!/sac/validaEntregaUsingPOST

-- envio
{
"entregas":
[
{
"idAssunto": 1,
"idCategoria": "CAN",
"idEntrega": 7777777,
"idMotivo": 8,
"itens": [
{
"idItem": 1796555,
"quantidade": 3,
"sequencial": 1
}
]
}
]
}

Response:

[
{
"idEntrega": 7777777,
"valorInstancia": 90.0,
"reembolso": [
{
"idMeioPagamento": 1,
"nomeMeioPagamento": "Estorno no cartão",
"sequenciaPagamento": 0,
"valorEstorno": 90.0,
"tipoEstorno": { ... }

},
{
"idMeioPagamento": 4,
"nomeMeioPagamento": "Vale",
"sequenciaPagamento": 0,
"valorEstorno": 90.0,
"tipoEstorno": { ... }
},
{
"idMeioPagamento": 10,
"nomeMeioPagamento": "Crédito em conta",
"sequenciaPagamento": 0,
"valorEstorno": 90.0,
"tipoEstorno": {
"cartao": false,
"credito": false,
"vale": false

}
}
],
"reposicao": [
{
"sequencial": 1,
"idItem": 1796555,
"permiteReposicao": false
}
],
"devolucao": {
"coleta": false,
"postagem": false
}
}
]


Gerar Instancia / Tarefas

Após preenchimento dos dados retorna:

- Entrega

- Tipo de atendimento (devolução ou cancelamento)

- Matriz (assunto, categoria, motivo)

- Itens

- Forma de ressarcimento (reembolso, reenvio, etc.)

- Dados bancários - Dados da reposição

Em seguida o sistema abrirá a solicitação de troca / cancelamento: Instância, e as tarefas pertinentes a cada tipo de solicitação.


URL do método POST

Produção: http://api.bseller.com.br/api/sac/atendimento/entregas/instancia-tarefa

Teste: http://backstg.bseller.com.br/api/sac/atendimento/entregas/instancia-tarefa

Link Documentação Swagger:

http://api.bseller.com.br/swagger-ui.html#!/sac/geraInstanciaTarefaUsingPOST

Response:

{

"entregas": [

{

"devolucao": null,

"idAssunto": 1,

"idCategoria": "CAN",

"idEntrega": 777777,

"idMotivo": 8,

"itens": [

{

"idItem": 1796555,

"quantidade": 3,

"sequencial": 1

}

],

"reembolso": [

{ "dadosBancarios": {

"codigoAgencia": null,

"codigoBanco": null,

"digitoAgencia":null,

"digitoConta": null,

"numeroConta": null,

"tipoConta": null

},

"idMeioPagamento":1,

"sequenciaPagamento":0,

"tipoEstorno": "C",

"valorEstorno": 90.00

}

],

"reposicao": [

{

"idItem": null,

"quantidadeReposicao": null,

"sequencial": null

}

],

"valorInstancia": 90.00

}

]

}