Informações

O módulo Informações reúne endpoints de consulta que retornam listas de apoio da sua loja: os status de pedidos disponíveis na plataforma, as formas de entrega ativas e as formas de pagamento ativas.

Esses códigos são úteis, por exemplo, para saber qual Codigo de status usar ao alterar o status de um pedido, ou para identificar as formas de entrega e pagamento que aparecem nos pedidos.

Todos os endpoints deste módulo são GET e retornam listas simples — não são paginados.

A referência completa de cada campo está no simulador online:

Swagger UIapi.toplojas.com.br

📋 Status de Pedidos

Retorna a lista de status de pedidos disponíveis na plataforma, com o Codigo de cada status.

GET /informacoes/status/

Use o Codigo retornado aqui para saber qual valor informar ao alterar o status de um pedido:

Alterar Status

📥 Exemplo de requisição

curl -X GET "https://api.toplojas.com.br/informacoes/status/" \
  -H "Authorization: Bearer [Token]" \
  -H "Loja: [Identificador de Sua Loja]"

📤 Exemplo de resposta

[
  {
    "Codigo": 3,
    "NomeStaff": "Aguardando Pagamento"
  }
]

🚚 Formas de Entrega

Retorna a lista de formas de entrega ativas na loja, com o Codigo e o Nome de cada uma.

GET /informacoes/formas-entrega/

📥 Exemplo de requisição

curl -X GET "https://api.toplojas.com.br/informacoes/formas-entrega/" \
  -H "Authorization: Bearer [Token]" \
  -H "Loja: [Identificador de Sua Loja]"

📤 Exemplo de resposta

[
  {
    "Codigo": 1747,
    "Nome": "Sedex"
  }
]

💳 Formas de Pagamento

Retorna a lista de formas de pagamento ativas na loja. Cada item traz o Codigo, o Grupo (tipo de pagamento, ex.: Cartão de Crédito, Boleto Bancário), o Gateway atrelado (ex.: Cielo, Stone, Rede) e o Nome exibido na loja.

GET /informacoes/formas-pagamento/

📥 Exemplo de requisição

curl -X GET "https://api.toplojas.com.br/informacoes/formas-pagamento/" \
  -H "Authorization: Bearer [Token]" \
  -H "Loja: [Identificador de Sua Loja]"

📤 Exemplo de resposta

[
  {
    "Codigo": 35876,
    "Grupo": "Cartão de Crédito",
    "Gateway": "CIELO - Webservice 3.0",
    "Nome": "Visa"
  }
]