List Sales

curl --request GET \
  --url https://api.example.com/api/sales

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/sales",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/sales"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/sales")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": [
    {}
  ],
  "total": 123,
  "page": 123,
  "totalPages": 123
}

GET

api

sales

List Sales

curl --request GET \
  --url https://api.example.com/api/sales

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/sales",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/sales"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/sales")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": [
    {}
  ],
  "total": 123,
  "page": 123,
  "totalPages": 123
}

Authentication

This endpoint requires authentication with admin privileges to list all sales. Regular users can only access their own sales via the /api/sales/my-sales endpoint.

Endpoints

List All Sales (Admin)

GET /api/sales Requires admin role.

List My Sales (User)

GET /api/sales/my-sales Returns sales for the authenticated user.

Query Parameters

number

default:"1"

Page number for pagination (admin endpoint only)

number

Filter by month (1-12, admin endpoint only)

number

Filter by year (admin endpoint only)

string

Filter by payment method (admin endpoint only). One of:

MERCADOPAGO
EFECTIVO
VIUMI
TRANSFERENCIA
BINANCE

string

Filter by specific date in format YYYY-MM-DD (admin endpoint only)

Response

All Sales Response (Admin)

boolean

Indicates if the request was successful

array

Array of sale objects

number

Sale ID

string

Sale date (ISO 8601 timestamp)

number

Total amount including shipping

string

Sale status: PENDIENTE_PAGO, PENDIENTE_APROBACION, APROBADO, ENVIADO, ENTREGADO, RECHAZADO, CANCELADO

string

Payment method used

string

Delivery type: ENVIO or RETIRO

number

Shipping cost

number

Customer ID

object

Customer information

array

Array of line items with product details

number

Total number of sales matching the filters

number

Current page number

number

Total number of pages

My Sales Response (User)

boolean

Indicates if the request was successful

array

Array of user’s sale objects (same structure as above)

Example Request (Admin)

GET /api/sales?page=1&month=3&year=2026&paymentMethod=TRANSFERENCIA

Example Request (User)

GET /api/sales/my-sales

Example Response

{
  "success": true,
  "data": [
    {
      "id": 789,
      "fecha": "2026-03-05T10:30:00.000Z",
      "montoTotal": 50000,
      "estado": "APROBADO",
      "medioPago": "TRANSFERENCIA",
      "tipoEntrega": "ENVIO",
      "costoEnvio": 5000,
      "clienteId": 42,
      "direccionEnvio": "Av. Corrientes 1234",
      "ciudadEnvio": "Buenos Aires",
      "provinciaEnvio": "Capital Federal",
      "cpEnvio": "1414",
      "codigoSeguimiento": "AR123456789",
      "cliente": {
        "id": 42,
        "userId": 100,
        "user": {
          "email": "customer@example.com",
          "nombre": "Juan",
          "apellido": "Pérez"
        }
      },
      "lineasVenta": [
        {
          "id": 1,
          "productoId": 123,
          "cantidad": 2,
          "subTotal": 30000,
          "producto": {
            "id": 123,
            "nombre": "Procesador AMD Ryzen 5",
            "precio": 15000,
            "foto": "https://example.com/cpu.jpg"
          }
        },
        {
          "id": 2,
          "productoId": 456,
          "cantidad": 1,
          "subTotal": 15000,
          "producto": {
            "id": 456,
            "nombre": "Memoria RAM 8GB",
            "precio": 15000,
            "foto": "https://example.com/ram.jpg"
          }
        }
      ]
    },
    {
      "id": 790,
      "fecha": "2026-03-04T15:20:00.000Z",
      "montoTotal": 25000,
      "estado": "ENVIADO",
      "medioPago": "MERCADOPAGO",
      "tipoEntrega": "ENVIO",
      "costoEnvio": 5000,
      "clienteId": 42,
      "codigoSeguimiento": "AR987654321",
      "cliente": {
        "id": 42,
        "userId": 100
      },
      "lineasVenta": [
        {
          "id": 3,
          "productoId": 789,
          "cantidad": 1,
          "subTotal": 20000,
          "producto": {
            "id": 789,
            "nombre": "Mouse Gaming",
            "precio": 20000
          }
        }
      ]
    }
  ],
  "total": 50,
  "page": 1,
  "totalPages": 3
}

Error Responses

Unauthorized (401)

{
  "success": false,
  "error": "Unauthorized"
}

Forbidden - Not Admin (403)

{
  "success": false,
  "error": "Admin access required"
}

Notes

The /api/sales endpoint is restricted to admin users only
Results are paginated with 20 items per page
The /api/sales/my-sales endpoint returns all sales for the authenticated user without pagination
Sales include full details of line items and associated products
Filters can be combined to narrow down results

⌘I

Authentication

Products

Cart & Checkout

Sales

Admin

List Sales

Authentication

Endpoints

List All Sales (Admin)

List My Sales (User)

Query Parameters

Response

All Sales Response (Admin)

My Sales Response (User)

Example Request (Admin)

Example Request (User)

Example Response

Error Responses

Unauthorized (401)

Forbidden - Not Admin (403)

Notes

​Authentication

​Endpoints

​List All Sales (Admin)

​List My Sales (User)

​Query Parameters

​Response

​All Sales Response (Admin)

​My Sales Response (User)

​Example Request (Admin)

​Example Request (User)

​Example Response

​Error Responses

​Unauthorized (401)

​Forbidden - Not Admin (403)

​Notes

Authentication

Endpoints

List All Sales (Admin)

List My Sales (User)

Query Parameters

Response

All Sales Response (Admin)

My Sales Response (User)

Example Request (Admin)

Example Request (User)

Example Response

Error Responses

Unauthorized (401)

Forbidden - Not Admin (403)

Notes