Entrar
Documentação

Desenvolvedores

Vendas e entrega

Consulte pedidos e entregue conteúdo manualmente pela API.

Vendas#

A consulta de vendas exige a permissão PROMISSE_SALES e é somente leitura.

Listar#

Texto
GET /sales
Parâmetro Valores
page A partir de 1
limit Até 100, padrão 25
search Produto, cliente ou e-mail
status Veja a tabela abaixo
order createdAt (padrão), updatedAt, approvedAt ou total. Sempre do maior para o menor.
start, end Data e hora em ISO 8601
coupon Código do cupom
affiliate UUID do afiliado
method pix, card ou free
utm Valor de utm_source
status Significado
s Aprovado
p Pendente
r Reembolso ou contestação
semestoque Pago, sem entrega
expired, cancelled, review, chargeback Os estados com o mesmo nome
Terminal
curl "https://api.promisse.store/api/v1/sales?status=s&order=approvedAt&limit=10" \
  -H "x-api-key: $PROMISSE_KEY"
JSON
{
  "totalItens": 1,
  "totalPaginas": 1,
  "paginaAtual": 1,
  "itens": [{
    "id": "uuid", "numero": 1001, "nome": "Curso", "quantidade": 1, "total": 123.45, "metodo": "pix",
    "status": "s", "status_detalhe": "paid", "createdAt": "...", "email": "cliente@exemplo.com",
    "cupom": null, "cupom_nome": null, "mailstatus": null, "banco": "promissepay", "entregue": true,
    "afiliado": null, "auto_approve": true, "afiliado_id": null, "utm": {}
  }]
}

Detalhe de um pedido#

Texto
GET /sale?id=<uuid>
Terminal
curl "https://api.promisse.store/api/v1/sale?id=UUID_DO_PEDIDO" \
  -H "x-api-key: $PROMISSE_KEY"

Traz tudo do item da lista, mais link, qr, copiaecola, linkPagamento, ip, estado, pais, loja, entrega, cupom_porcentagem, taxa, afiliado_lucro, mailid, approved_at, desconto, address_crypto, utm_source_virtual, cpf, client_name, client_address, client_phone, updatedAt, banido e carrinhos.

JSON
{
  "carrinhos": [{
    "id": "uuid", "icon": "url", "produto": "uuid", "variante": null, "nome": "Curso", "valor": 123.45, "quantidade": 1,
    "estoques": [{ "id": "uuid", "produto": "uuid", "tipo": "stock", "estoque": "CHAVE", "pos": 1, "createdAt": "...", "updatedAt": "..." }],
    "automatic": true, "tipo": "series", "feedback": false, "campos": []
  }]
}

Alguns campos pedem atenção:

  • cpf sai mascarado, como ***.456.789-**. O número completo só aparece no painel.
  • qr, copiaecola e linkPagamento só vêm preenchidos em pedido pendente.
  • link traz o token de acesso do comprador. Trate como dado sensível.
  • mailid, address_crypto e utm_source_virtual são sempre null.
  • Campos internos, como taxa da plataforma, risco, anotações e dados do navegador, não saem na API.

Entrega de estoque#

Para produtos de entrega manual, você envia o conteúdo depois da compra. Exige a permissão PROMISSE_INVENTORY, com limite de 1 requisição a cada 2 segundos por chave, somando POST e PUT.

Rota Efeito stock na resposta
POST /delivery/stock Soma ao que já foi entregue O conteúdo completo do item
PUT /delivery/stock Substitui o que foi entregue. Sem entrega anterior, responde 404. Só o conteúdo novo
Campo Regra
order UUID do pedido
cart O id do item em carrinhos
stock De 1 a 100 itens, com 1 a 5000 caracteres cada
Terminal
curl -X POST "https://api.promisse.store/api/v1/delivery/stock" \
  -H "x-api-key: $PROMISSE_KEY" \
  -H "content-type: application/json" \
  -d '{ "order": "UUID_DO_PEDIDO", "cart": "UUID_DO_ITEM", "stock": ["CHAVE-XYZ"] }'
JSON
{ "success": true, "stock": ["CHAVE-XYZ"] }

O comprador recebe um e-mail avisando da entrega. Pedido ainda não pago responde 409 not_paid.