Skip to main content
GET
Get purchase

Authorizations

Authorization
string
header
required

API key created in the organization settings.

Path Parameters

purchase_id
string
required

Public purchase ID.

Pattern: ^pur_[A-Za-z0-9_-]+$

Response

Purchase found.

object
string
required
Allowed value: "purchase"
id
string
required
Pattern: ^pur_[A-Za-z0-9_-]+$
customer_id
string
required
Pattern: ^cus_[A-Za-z0-9_-]+$
purchase_value_in_cents
integer
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
order_id_on_integration_platform
string
order_number
string
platform
string
status
string
payment_status
string
shipping_status
string
currency
string
Example:

"BRL"

subtotal_amount_in_cents
integer
total_amount_in_cents
integer
discount_in_cents
integer
shipping_cost_customer_in_cents
integer
coupons
object[]
attributed_flow_ids
string[]
Pattern: ^flw_[A-Za-z0-9_-]+$