Sign in

v1

latestOpenAPI 3.0.32026-07-2647114182.1 KB
products

Public API for managing checkouts, inherits from CheckoutRetrieveAPI, adds OAuth2 authentication and config validation.

get/public_api/products/{product_pk}/checkouts/{id}/

Path parameters

idstring required
product_pkstring required

Response

idinteger required
namestring required

Nome do checkout

{"stackTrail":"components:schemas:CheckoutPublicRetrieve:properties:config","oasType":"schema","type":"unknown","title":"Configuração","description":"Configuração personalizada do checkout em formato JSON","example":{"mobile":{"rows":[{"id":"369db380-d652-4b4f-bf0e-31710f1cfc03","type":"row","layout":[12],"columns":[{"id":"e0253c14-37ea-47f7-b77a-e260cb814a6f","type":"column","components":[{"id":"cff7c565-5957-4330-be70-b804878827dd","type":"checkout","attributes":{}}]}]}],"extra":{"chat":{"id":"8f5c57d5-1548-4474-a5fd-fa91d408cdd1","type":"chat","attributes":{"enabled":false,"provider":"whatsapp","accountId":""}},"exitPopup":{"id":"9f8d9444-d0f5-429d-9c06-fd2fa22d8adc","type":"exitPopup","attributes":{"enabled":false,"title":"Temos uma oferta especial para você!"}},"notification":{"id":"26c584c9-6006-4d46-b7a6-e69197f1db8f","type":"notification","attributes":{"enabled":false}}},"settings":{"font":{"family":"Roboto"},"payButton":{"text":{"text":"PAGAR AGORA","color":"#ffffff"},"color":"#0B6856"},"background":{"color":"#f1f1f1"}}}},"nullable":true}
offersstring required
defaultboolean

Define se este é o checkout padrão do produto

updatedAtstring date-time required

Data e hora da última atualização

createdAtstring date-time required

Data e hora de criação

visitsinteger

Quantidade de visitas ao checkout

Example response

{
  "config": {
    "mobile": {
      "rows": [
        {
          "id": "369db380-d652-4b4f-bf0e-31710f1cfc03",
          "type": "row",
          "layout": [
            12
          ],
          "columns": [
            {
              "id": "e0253c14-37ea-47f7-b77a-e260cb814a6f",
              "type": "column",
              "components": [
                {
                  "id": "cff7c565-5957-4330-be70-b804878827dd",
                  "type": "checkout",
                  "attributes": {}
                }
              ]
            }
          ]
        }
      ],
      "extra": {
        "chat": {
          "id": "8f5c57d5-1548-4474-a5fd-fa91d408cdd1",
          "type": "chat",
          "attributes": {
            "enabled": false,
            "provider": "whatsapp",
            "accountId": ""
          }
        },
        "exitPopup": {
          "id": "9f8d9444-d0f5-429d-9c06-fd2fa22d8adc",
          "type": "exitPopup",
          "attributes": {
            "enabled": false,
            "title": "Temos uma oferta especial para você!"
          }
        },
        "notification": {
          "id": "26c584c9-6006-4d46-b7a6-e69197f1db8f",
          "type": "notification",
          "attributes": {
            "enabled": false
          }
        }
      },
      "settings": {
        "font": {
          "family": "Roboto"
        },
        "payButton": {
          "text": {
            "text": "PAGAR AGORA",
            "color": "#ffffff"
          },
          "color": "#0B6856"
        },
        "background": {
          "color": "#f1f1f1"
        }
      }
    }
  }
}
All 47 operations