API de Integração
Vendas

Consultar vendas pelo externalSaleId

Consulta vendas pelo ID do seu sistema (`externalSaleId`). Como o mesmo ID pode estar em mais de uma venda, a resposta é uma lista de até 50 vendas (as 50 criadas mais recentemente), sem garantia de ordem entre os itens. Nenhuma venda com esse ID responde 400 com `SALE-001` e mensagem `Sale not found`. Atenção: na resposta os produtos vêm com `productSKU` e `variantSKU` (SKU em maiúsculo), diferente do corpo de criação.

GET
/sales/external-purchase/{externalSaleId}

Autorização

apiToken
Api-Token<token>

Token do parceiro. Gere no painel do parceiro: Configurações > Integrações > API Token (perfil Admin ou Superadmin). Envie só este header: se Authorization também for enviado, ele tem prioridade e a requisição é recusada com 401.

Local: header

Parâmetros de Path

externalSaleId*string

ID da venda no seu sistema, informado na criação.

Corpo da Resposta

application/json

application/json

application/json

curl -X GET "https://example.com/sales/external-purchase/string"
[  {    "checkoutUrl": "https://pay-staging.principia.net/checkout/web-development-school?classes=44099&saleId=31397dea-d328-4135-9619-a6ed4ca7713f",    "externalSaleId": "aef2828a-e9eb-4714-b0b5-aa3edf15f31d",    "status": "Efetivado",    "saleId": 1582050,    "cpf": "48096807544",    "checkoutPriceInCents": 100000,    "products": [      {        "productSKU": "01946620-fba3-74c7-8473-38337b3f08b1",        "productName": "Light Saber 101",        "variantSKU": "01946621-1706-7cc4-8e7e-67dbd3d9ab6e",        "variantName": "Light Saber 101",        "variantPriceInCents": 100000      }    ],    "buyer": {      "name": "Darth Vader",      "phone": "71999999999",      "email": "darth.vader@empire.com",      "zipCode": "04548004",      "street": "Av. Dr. Cardoso de Melo",      "number": "1340",      "district": "Vila Olimpia",      "city": "São Paulo",      "complement": "Cj 11"    }  }]