Skip to main content

​
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

GET /v1/orders
retorna a lista de pedidos pendentes de sincronização. a listagem é paginada usando skip e limit.

​
obter detalhes do pedido

GET /v1/orders/{orderId}
​
orderId
string
required
identificador único do pedido na teceo.

​
sincronizar pedido

POST /v1/orders/{orderId}/sync
​
orderId
string
required
identificador único do pedido na teceo.

​
payload de sucesso

quando a integração for bem-sucedida, envie: 
{
  "status": "SUCCESS",
  "integrationCode": "123456"
}
​
status
string
required
deve ser SUCCESS para indicar sucesso na integração.
​
integrationCode
string
required
código do pedido no seu ERP/sistema.

​
payload de erro

se ocorrer um erro durante a sincronização: 
{
  "status": "ERROR",
  "message": "descrição do erro ocorrido"
}
​
status
string
required
deve ser ERROR para indicar falha na integração.
​
message
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

PATCH /v1/orders/sync/reverse/{externalCode}
​
externalCode
string
required
código do pedido no ERP (enviado anteriormente como integrationCode).

​
payload

{
  "status": "APPROVED"
}
​
status
string
required
novo status do pedido. valores aceitos: APPROVED, CANCELLED, REJECTED, ON_APPROVAL.

​
exemplo de fluxo completo