Skip to content

docs: document Melhor Envio freight integration - #1

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/9618a7a2
Open

mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/9618a7a2

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown

Summary

Documents the new per-merchant Melhor Envio integration that powers live freight quoting on payment link checkouts.

Changes

  • New guias/melhor-envio.mdx guide covering OAuth setup (Client ID/Secret, callback URL, shipping-calculate scope), origin CEP + enabledServices configuration, the public POST /v1/payment-links/:id/freight/quote endpoint, server-side re-quote anti-fraud (freightServiceId validation), persistence of freight_amount / freight_details on the charge, BRL-only restriction, and the hasActiveFreightTool availability flag.
  • api-reference/openapi.yaml: adds /v1/melhor-envio/* endpoints (credentials, OAuth authorize/callback, status, services, settings, disconnect), POST /v1/payment-links/{id}/freight/quote, and GET /v1/payment-links/freight-availability under new Melhor Envio and Payment Links tags.
  • docs.json: new Integrações nav group with the Melhor Envio guide.

Context

Triggered by fastsoftbrasil/global-whitelabel-payment-gateway#626 ("feat: integração Melhor Envio (cálculo de frete ao vivo no checkout)").

@mintlify
mintlify Bot requested a review from basniak June 23, 2026 12:13
@mintlify

mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown
Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
fastpay 🟢 Ready View Preview Jun 23, 2026, 12:22 PM

This branch was successfully deployed

1 active deployment
staging 84155fe5 Deployed Jun 23, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants