Get salesid — api-kiwify

v1

latestOpenAPI 3.1.02026-07-26223346.1 KB

Vendas

get/sales/{id}

Path parameters

idstring required

Response

Response description

idstring

referencestring

typestring

created_atstring

updated_atstring

statusstring

payment_methodstring

net_amountnumber

approved_datestring

{"stackTrail":"components:schemas:SaleDetails:properties:boleto_url","oasType":"schema","type":"unknown"}

card_last_digitsstring

{"stackTrail":"components:schemas:SaleDetails:properties:card_rejection_reason","oasType":"schema","type":"unknown"}

card_typestring

installmentsnumber

is_one_clickboolean

{"stackTrail":"components:schemas:SaleDetails:properties:parent_order_id","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:SaleDetails:properties:refunded_at","oasType":"schema","type":"unknown"}

sale_typestring

two_cardsboolean

Example response

{
  "id": "588aa8f4-fb61-4d26-bf61-ad4cd6de42cd",
  "reference": "9dAQA5a",
  "type": "product",
  "created_at": "2023-10-31T16:53:05.119Z",
  "updated_at": "2023-10-31T16:53:05.119Z",
  "product": {
    "id": "2e1d37f7-3c68-4712-907f-a14368302e69",
    "name": "Meu Produto"
  },
  "status": "paid",
  "payment_method": "credit_card",
  "customer": {
    "id": "3319e377-912c-405c-9d98-34ac241da46b",
    "name": "Meu Cliente",
    "email": "meucliente@mail.com",
    "cpf": "99999999999",
    "mobile": "+5599999999999"
  },
  "approved_date": "2023-10-31T16:34:35.491Z",
  "card_last_digits": "1115",
  "card_type": "mastercard",
  "installments": 12,
  "is_one_click": true,
  "payment": {
    "charge_amount": 12048,
    "fee": 1348,
    "net_amount": 8652,
    "product_base_price": 10000
  },
  "sale_type": "producer",
  "affiliate_commission": {
    "name": "My Affiliate",
    "document": "123456789",
    "email": "myaffiliate@email.com"
  }
}