Listar ventas
Sales
GET /v1/ecommerce/sales
List sales, filtered by status, payment status, contact, or date range.
GET
Listar ventas
Returns a paginated list of sales. Each one carries its line items and the full amount breakdown, so a reporting job rarely needs a second call.
Results cover the whole company, not just the project your token belongs to.
Endpoint
Required scope
ecommerce:sales:read
Headers
Query parameters
Example request
Response
200 OK
400 Bad Request
Astatus or payment_status outside the allowed set, a malformed date, limit above 200, or an unknown query parameter.
401 Unauthorized
Missing, invalid, revoked, or expired token.403 Forbidden
The token does not have theecommerce:sales:read scope.
502 Bad Gateway
The ecommerce service could not answer.Operational notes
statusandpayment_statusare independent. Acompletedsale can bepartially_paid, and acancelledone can still bepaidif the money arrived before the cancellation. Filter on the one you actually mean.sale_numberis the human-readable correlative, unique and sequential per company. It is what appears on receipts — use it when talking to the customer, and_idwhen talking to the API.- Amounts are integers in the currency’s minor unit, and
net_subtotalis after discounts but before tax.totalis the number the customer paid. chat_user_idlinks the sale to a contact, present when the sale came from a conversation. Sales rung up at the counter usually have only the embedded customer details.- Polling this endpoint is the wrong shape for reacting to sales. Subscribe to
ecommerce.sale.paidinstead — same data, no daily quota burned.
Authorizations
Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.
Query Parameters
Required range:
1 <= x <= 200Required range:
x >= 0Available options:
completed, cancelled, refunded Available options:
pending, paid, partially_paid, refunded Filtrar por contacto
Fecha ISO 8601, inclusive
Fecha ISO 8601, inclusive
Búsqueda libre sobre la venta