o que é um caso
o caso criado pela API nasce no primeiro status de situaçãonew do tipo de caso, pela ordem configurada na marca, e recebe um code sequencial gerado pela teceo. o externalCode que você envia é o que amarra o caso ao registro do seu sistema, e é único dentro da marca.
cada caso tem dois status. o statusBase é a situação padronizada (new, open, pending ou closed), boa para automações. o status é o nome que a marca deu ao status, e muda de marca para marca.
fluxo principal
1
abrir o caso
envie o
externalCode, o tipo de caso, o cliente e o assunto. casos de devolução levam também a nota e os produtos em customData.2
guardar o número da teceo
o
code sequencial do caso aparece na listagem. filtre pelo seu externalCode para encontrar o caso e guardar os dois números juntos.3
acompanhar o andamento
use os webhooks de casos para ser avisado a cada mudança de situação do caso, ou consulte o caso pelo
externalCode.endpoints
os campos de cada rota, com tipo, obrigatoriedade e exemplo, estão na página da própria rota, no menu ao lado. a listagem é paginada por cursor, como descrito em paginação.
regras de negócio
identificando o cliente
o caso pede o cliente porcustomerId ou por customerCpfCnpj. envie só um dos dois.
tipo de caso e campos da marca
otypeCode precisa ser de um tipo de caso já configurado na marca. o defectCode e o reasonCode dos produtos apontam para defeitos e motivos cadastrados na marca, e os dois precisam ir em todo item. os campos aceitos dentro de customData acompanham a configuração de casos de cada marca. confirme com o time da teceo quais valem para a sua.
caso de devolução
casos de devolução usamcustomData para levar dois blocos. o caseDevolution traz a nota de devolução, o código de rastreio e os arquivos da nota. o caseProducts traz cada peça devolvida, com quantidade, valor, defeito, motivo e fotos. a peça é identificada pela combinação do código do produto, do código da cor e do tamanho.
cada bloco só é gravado quando o tipo de caso tem a seção correspondente, que é a de notas fiscais de devolução para o caseDevolution e a de produtos para o caseProducts. sem a seção, o bloco é ignorado sem erro e não volta na resposta. quando gravados, os blocos voltam na resposta com os mesmos dados, e cada item de caseProducts ganha um id gerado pela teceo.
listagem
a listagem vem ordenada por data de criação, da mais antiga para a mais nova, mesmo quando você filtra por data de alteração. pare de paginar quando a página vier vazia ou quando onextCursor vier nulo.
erros
trate os erros de casos pelo status HTTP da resposta.