GET
/
sales
/
{id}
cURL
curl --request GET \
  --url https://public-api.kiwify.com/v1/sales/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-kiwify-account-id: <api-key>'
{
"id": "fc96cec5-1ff1-49b3-aa22-0e131f353b62",
"reference": "iYJwhMP",
"type": "product",
"created_at": "2023-10-31T16:34:35.491Z",
"updated_at": "2023-10-31T16:36:02.005Z",
"product": {
"id": "aaa86f40-d7ae-11ed-acc6-e1c45591a30e",
"name": "My Product"
},
"shipping": {
"id": "255f7ae0-8694-40f9-b905-7507fe6bc58f",
"name": "Entrega Grátis",
"price": 0
},
"status": "paid",
"payment_method": "credit_card",
"net_amount": 8853,
"currency": "USD",
"customer": {
"id": "b17dd04e-5acc-41ae-a4b2-cba0d2436406",
"name": "my customer",
"email": "mycustomer@mail.com",
"cpf": "99999999999",
"mobile": "+5599999999999",
"instagram": "y_instagram",
"country": "BR",
"address": {
"street": "Rua Danilo",
"number": "407",
"complement": "Apt. 123",
"neighborhood": "Jardim dos Jardineiros",
"city": "Paulista",
"state": "SE",
"zipcode": "46121-175"
}
},
"approved_date": "2023-10-31T16:34:35.491Z",
"boleto_url": null,
"card_last_digits": "1115",
"card_rejection_reason": null,
"card_type": "mastercard",
"installments": 12,
"is_one_click": true,
"parent_order_id": null,
"payment": {
"charge_amount": 10388,
"charge_currency": "BRL",
"net_amount": 8853,
"product_base_price": 60037,
"product_base_currency": "BRL",
"settlement_amount": 8853,
"settlement_currency": "USD",
"fee": 984,
"fee_currency": "USD",
"sale_tax_rate": 5.6,
"sale_tax_amount": 551
},
"refunded_at": null,
"sale_type": "producer",
"tracking": {
"sck": null,
"src": null,
"utm_campaign": null,
"utm_content": null,
"utm_medium": null,
"utm_source": null,
"utm_term": null,
"s1": null,
"s2": null,
"s3": null
},
"two_cards": false,
"revenue_partners": [
{
"account_id": "RpL2PsVt7gEN50Q",
"legal_name": "My Coproducer",
"document_id": "12345678910",
"percentage": 50,
"net_amount_split": 4426,
"charge_amount_split": 5000
}
],
"affiliate_commission": {
"name": "My affiliate",
"document": "123456789",
"email": "myaffiliate@email.com",
"amount": 2849
}
}

Authorizations

x-kiwify-account-id
string
header
required
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string
required

Response

Response description

id
string
Example:

"588aa8f4-fb61-4d26-bf61-ad4cd6de42cd"

reference
string
Example:

"9dAQA5a"

type
string
Example:

"product"

created_at
string
Example:

"2023-10-31T16:53:05.119Z"

updated_at
string
Example:

"2023-10-31T16:53:05.119Z"

product
object
status
string
Example:

"paid"

payment_method
string
Example:

"credit_card"

net_amount
number
Example:

0

customer
object
approved_date
string
Example:

"2023-10-31T16:34:35.491Z"

boleto_url
any
card_last_digits
string
Example:

"1115"

card_rejection_reason
any
card_type
string
Example:

"mastercard"

installments
number
Example:

12

is_one_click
boolean
Example:

true

parent_order_id
any
payment
object
refunded_at
any
sale_type
string
Example:

"producer"

tracking
object
two_cards
boolean
Example:

false

revenue_partners
any[]
affiliate_commission
object