Introdução

A Suitable API é uma API REST para integrações de terceiros com dados de lojas administradas no ecossistema Suitable. Ela permite que sistemas autorizados consultem informações da loja, clientes e pedidos sem precisar acessar diretamente os sistemas internos da Suitable.

O que você pode consultar

• Loja: identidade, contatos, endereço, horários de funcionamento, formas de pagamento e tipos de pedido habilitados.
• Clientes: dados cadastrais, telefones, endereços e informações de relacionamento disponíveis para a loja.
• Pedidos: listagens filtráveis, resumo dos pedidos e detalhes de um pedido, incluindo itens, pagamentos e movimentações de fidelidade.

A API disponibiliza operações de consulta para esses recursos. No momento, a referência publicada não oferece operações para criar, editar ou excluir lojas, clientes ou pedidos.

Para quem é

A API atende equipes e fornecedores que desenvolvem integrações autorizadas com a Suitable, como sincronizações com outros sistemas e consultas de dados operacionais. Também pode ser usada por entusiastas de tecnologia — inclusive donos de restaurantes — que queiram criar integrações próprias com o apoio de ferramentas de inteligência artificial. A Referência da API descreve os endpoints e os dados disponíveis para orientar esse desenvolvimento e a validação das chamadas.

Cada credencial é vinculada a uma loja e a um ambiente específicos.

Como funciona uma integração

1. Uma pessoa autorizada gera uma chave de API no painel da Suitable.
2. A integração troca client_id e client_secret por um token de acesso.
3. As chamadas autenticadas consultam os endpoints usando o token.
4. O token identifica a loja e o ambiente de destino.

Comece pelo guia de Primeiros passos. A lista completa de recursos e modelos está na Referência da API.

Formato dos dados

• As respostas usam JSON.
• Valores monetários são decimais em reais (BRL), com duas casas decimais.
• Datas e horários são apresentados como horário local da loja, sem informação de fuso horário. Consulte timezone_offset em /api/store/info/ para interpretar esses valores.
• Erros usam um objeto com detail e code; os códigos HTTP e os esquemas completos estão descritos na Referência da API.