Saltar al contenido principal
GET
/
returns
Listar devoluciones de ventas
curl --request GET \
  --url https://tu-dominio.com/api/external/v1/returns \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "meta": {
    "empresa": "Mi Empresa S.A.",
    "timestamp": "2023-11-07T05:31:56Z",
    "filters_applied": {}
  },
  "data": [
    {
      "id": 123,
      "fecha": "2023-12-25",
      "correlativo": "<string>",
      "tipo": "<string>",
      "sub_total": 123,
      "total": 123,
      "iva": 123,
      "observaciones": "<string>",
      "id_venta": 123,
      "nombre_cliente": "<string>",
      "nombre_usuario": "<string>",
      "nombre_documento": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "detalles": [
        {
          "nombre_producto": "<string>",
          "codigo_producto": "<string>",
          "marca_producto": "<string>",
          "cantidad": 123,
          "precio": 123,
          "total": 123
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 100,
    "total": 1250,
    "total_pages": 13,
    "has_next": true,
    "has_prev": false,
    "from": 1,
    "to": 100
  }
}

Autorizaciones

Authorization
string
header
requerido

API Key de la empresa en formato Bearer token.

Ejemplo: Authorization: Bearer G8RCjH11DabBNjnX7wO5

Parámetros de consulta

fecha_inicio
string<date>

Fecha de inicio (Y-m-d)

Ejemplo:

"2024-01-01"

fecha_fin
string<date>

Fecha de fin (Y-m-d)

Ejemplo:

"2024-12-31"

id_venta
integer

ID de la venta original

Ejemplo:

12345

page
integer
predeterminado:1
Rango requerido: x >= 1
per_page
integer
predeterminado:100
Rango requerido: 1 <= x <= 200

Respuesta

Lista de devoluciones obtenida exitosamente

success
boolean
requerido

Indica si la operación fue exitosa

meta
object
data
object[]
pagination
object