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

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

const orders = await lapyme.orders.listOrders({
  limit: 20,
});
{
  "request_id": "<string>",
  "data": [
    {
      "object": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_number": "<string>",
      "raw_order_number": 123,
      "order_date": "2023-11-07T05:31:56Z",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_name": "<string>",
      "customer_tax_id": "<string>",
      "items_count": 123,
      "total_units": 123,
      "discount_amount": 1,
      "subtotal": 1,
      "tax_amount": 1,
      "total": 1,
      "notes": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by_name": "<string>"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>",
  "url": "<string>"
}

Authorizations

Authorization
string
header
required

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

Query Parameters

query
string
cursor
string
limit
integer
default:50
Required range: 1 <= x <= 100
date_from
string<date>
date_to
string<date>
status
enum<string>
Available options:
open,
completed,
cancelled
preparation_status
enum<string>
Available options:
unfulfilled,
in_progress,
partially_fulfilled,
fulfilled,
cancelled

Response

Pedidos obtenidos exitosamente

request_id
string
required
data
object[]
required
has_more
boolean
required
next_cursor
string | null
required
object
enum<string>
required

List-envelope discriminator.

Available options:
list
url
string
required

Requested list path.