API Checkout API

Conheça a plataforma

O que integrar com Checkout API

Descrição técnica preservada da especificação de origem. A versão do contrato ajuda a identificar a API; confirme a disponibilidade atual no fornecedor.

>ℹ️ Check the new Checkout onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about the Checkout and is organized by focusing on the developer's journey. The Checkout API allows you to obtain and configure information about the shopping cart and its attachments, personalization of custom fields, orderForm structure, fulfillment data, order management, and identification of the sellers delivery region. >ℹ️ Data modification operations (POST, PATCH, PUT or DELETE endpoints) shall not be performed in parallel in the Checkout APIs. They need to be enqueued by the client/requester. Otherwise, old values ​​can be overwritten incorrectly or competition errors may occur. >⚠️ All endpoints that consult or edit the orderForm can change the authentication depending on the customer context. If you are handling information from a customer with a complete profile on the store, authentication will be required. You can only access or modify the customer data for these profiles with an authenticated request. Shopping cart Allows merchants to simulate, configure and customize shopping cart information. - POST - Cart Simulation - GET - Get current or create a new cart - GET - Get cart information by ID - POST - Remove all items - GET - Remove all personal data - POST - Update cart items - POST - Add cart items - PUT - Change price - PATCH - Ignore profile data - GET - Cart installments - POST - Add coupons to the cart Cart attachments Allows merchants to obtain client profiles and add information to a given shopping cart. - GET - Get client profile by email - POST - Add client profile - POST - Add shipping address and select delivery option - POST - Add client preferences - POST - Add marketing data - POST - Add payment data - POST - Add merchant context data Custom data Allows merchants to manage custom fields that were created by an app in their account. - PUT - Set multiple custom field values - PUT - Set single custom field value - DELETE - Remove single custom field value Configuration Allows merchants to configure orderForm in the account and seller exchange on a given order. - GET - Get orderForm configuration - POST - Update orderForm configuration - GET - Get window to change seller - POST - Update window to change seller - POST - Clear orderForm messages Fulfillment Allows merchants to obtain pickup points and address information. - GET - List pickup points by location - GET - Get address by postal code Order placement Allows merchants to place and process orders by creating a new cart or using an existing cart. - POST - Place order from an existing cart - PUT - Place order - POST - Process order Region Allows merchants to obtain a list of sellers serving a specific delivery region. - GET - Get sellers by region or address

Do planejamento à produção

Checklist para integrar Checkout API

1. Defina o fluxo. Identifique quais dados precisam circular, o sistema de origem e o resultado esperado.
2. Leia os requisitos oficiais. Verifique acesso à API, plano necessário, versão e ambiente de testes.
3. Configure o acesso com segurança. Guarde credenciais secretas no servidor e conceda apenas as permissões necessárias. Restrinja chaves públicas conforme a documentação do fornecedor.
4. Teste a primeira requisição. Valide os campos, a paginação e o formato de resposta com dados de teste.
5. Prepare o tratamento de falhas. Considere limites de requisição, retentativas com espera e prevenção de operações duplicadas.
6. Acompanhe a integração. Registre erros sem expor dados sensíveis e monitore alterações na API.