Skip to main content
GET
/
api
/
v1
/
purchase-orders
La Pyme SDK
import { Lapyme } from "lapyme";

const lapyme = new Lapyme({
  bearerAuth: process.env["LAPYME_API_KEY"] ?? "",
});

const purchaseOrders = await lapyme.purchaseOrders.listPurchaseOrders({
  limit: 20,
  status: "draft",
});
{
  "request_id": "<string>",
  "data": [
    {
      "object": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_number": 123,
      "formatted_order_number": "<string>",
      "order_date": "2023-12-25",
      "expected_date": "2023-12-25",
      "currency": "<string>",
      "supplier": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "warehouse": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

Incluí tu API key en el header Authorization con el prefijo Bearer.

Query Parameters

query
string

Texto de búsqueda por proveedor o número de orden

cursor
string

Valor de next_cursor recibido en la respuesta anterior

limit
integer
default:50

Cantidad máxima de resultados por respuesta

Required range: 1 <= x <= 100
date_from
string<date>

Fecha inicial de la orden

date_to
string<date>

Fecha final de la orden

status
enum<string>

Estado o lista de estados separados por coma: draft, sent, partially_received, received, closed, cancelled

Available options:
draft,
sent,
partially_received,
received,
closed,
cancelled

Response

Órdenes de compra obtenidas exitosamente

request_id
string
required
data
object[]
required