fluxo principal
o fluxo de integração envolve as seguintes etapas:1
buscar pedidos pendentes
busque pedidos prontos para integração: aprovados (
status = APPROVED) e que ainda não foram integrados ou tiveram erro anterior (synchronizedStatus = NOT_SYNCHRONIZED).2
detalhar pedido
obtenha informações detalhadas de cada pedido para enviar ao seu sistema.
3
sincronizar pedido
após processar o pedido no seu sistema, envie a confirmação de sucesso ou erro para a teceo.
endpoints
listar pedidos pendentes
skip e limit.
obter detalhes do pedido
string
required
identificador único do pedido na teceo.
sincronizar pedido
string
required
identificador único do pedido na teceo.
payload de sucesso
quando a integração for bem-sucedida, envie:string
required
deve ser
SUCCESS para indicar sucesso na integração.string
required
código do pedido no seu ERP/sistema.
payload de erro
se ocorrer um erro durante a sincronização:string
required
deve ser
ERROR para indicar falha na integração.string
required
descrição do problema ocorrido.
integração reversa
a API também permite a sincronização reversa de pedidos já integrados usando o código do pedido no ERP (externalCode).
a sincronização reversa permite que os pedidos já integrados no sistema sejam atualizados com um novo status diretamente no ERP, sem a necessidade de reprocessar o pedido completo.
atualizar status do pedido
string
required
código do pedido no ERP (enviado anteriormente como
integrationCode).payload
string
required
novo status do pedido. valores aceitos:
APPROVED, CANCELLED, REJECTED, ON_APPROVAL.