sales.get

Detalhe da venda. Venda do Atomiks (id uuid) ou pedido de plataforma (id = código do pedido): situação, datas, pagamento, produto e transações. O Atomiks não cobra taxa nem parcela e não guarda garantia: esses campos vêm zerados ou nulos.

• Endpoint: POST https://app.atomiks.com.br/api/v1/sales.get (corpo JSON)
• Quem pode chamar: membro da conta
• Escopo da chave: crm:read
• Grava dados: não
• Pela chave de API: sim
• Ferramenta MCP: sales_get
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId sales.get)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "id"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/sales.get \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000"}'

CLI:

node cli/atomiks.mjs sales.get --json '{"id":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta sales_get com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "externalId": {
      "type": [
        "string",
        "null"
      ]
    },
    "shortenCode": {
      "type": "string"
    },
    "orderStatus": {
      "type": "string",
      "enum": [
        "pending",
        "paid",
        "canceled",
        "refunded",
        "chargedBack",
        "failed"
      ]
    },
    "isSubscriptionInvoice": {
      "type": "boolean"
    },
    "subscriptionId": {
      "type": [
        "string",
        "null"
      ]
    },
    "details": {
      "type": "object",
      "properties": {
        "currency": {
          "type": "string"
        },
        "approvedAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "createdAt": {
          "type": "string"
        },
        "cancelledAt": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "currency",
        "approvedAt",
        "createdAt",
        "cancelledAt"
      ],
      "additionalProperties": false
    },
    "warranty": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "approvalDate": {
              "type": [
                "string",
                "null"
              ]
            },
            "warrantyPeriodDays": {
              "type": "number"
            },
            "warrantyStatus": {
              "type": "string"
            }
          },
          "required": [
            "approvalDate",
            "warrantyPeriodDays",
            "warrantyStatus"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "payment": {
      "type": "object",
      "properties": {
        "method": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "credit",
                "pix",
                "boleto"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "totalPaidByBuyer": {
          "type": "number"
        },
        "passPlatformFee": {
          "type": "boolean"
        },
        "membershipFee": {
          "type": "number"
        },
        "offerPrice": {
          "type": "number"
        },
        "discountAmount": {
          "type": "number"
        },
        "baseValueForCommission": {
          "type": "number"
        },
        "extraServices": {
          "type": "number"
        },
        "installments": {
          "type": [
            "number",
            "null"
          ]
        },
        "installmentValue": {
          "type": [
            "number",
            "null"
          ]
        },
        "clickmaxFee": {
          "type": "number"
        },
        "cxFeePercentage": {
          "type": "number"
        },
        "cxFeeFix": {
          "type": "number"
        },
        "yourCommission": {
          "type": "number"
        },
        "interest": {
          "type": "number"
        }
      },
      "required": [
        "method",
        "totalPaidByBuyer",
        "passPlatformFee",
        "membershipFee",
        "offerPrice",
        "discountAmount",
        "baseValueForCommission",
        "extraServices",
        "installments",
        "installmentValue",
        "clickmaxFee",
        "cxFeePercentage",
        "cxFeeFix",
        "yourCommission",
        "interest"
      ],
      "additionalProperties": false
    },
    "product": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "offer": {
          "type": "string"
        },
        "producer": {
          "type": [
            "string",
            "null"
          ]
        },
        "price": {
          "type": "number"
        },
        "offerTypeIsRecurrent": {
          "type": "boolean"
        },
        "approvalDate": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "name",
        "offer",
        "producer",
        "price",
        "offerTypeIsRecurrent",
        "approvalDate"
      ],
      "additionalProperties": false
    },
    "transactions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "main",
              "bump"
            ]
          },
          "shortenCode": {
            "type": "string"
          },
          "product": {
            "type": "string"
          },
          "offer": {
            "type": "string"
          },
          "value": {
            "type": "number"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "paid",
              "canceled",
              "refunded",
              "chargedBack",
              "failed"
            ]
          },
          "paymentMethod": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "credit",
                  "pix",
                  "boleto"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "createdAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "type",
          "shortenCode",
          "product",
          "offer",
          "value",
          "status",
          "paymentMethod",
          "createdAt"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "externalId",
    "shortenCode",
    "orderStatus",
    "isSubscriptionInvoice",
    "subscriptionId",
    "details",
    "warranty",
    "payment",
    "product",
    "transactions"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).