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

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

const transfers = await lapyme.stockTransfers.listStockTransfers({
  limit: 20,
});
{
  "request_id": "<string>",
  "data": [
    {
      "object": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source_warehouse_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "target_warehouse_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transfer_date": "2023-11-07T05:31:56Z",
      "notes": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source_warehouse": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "target_warehouse": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "items": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "quantity": 123,
          "received_quantity": 123,
          "product": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "sku": "<string>",
            "variant_options": {},
            "option_names": [
              "<string>"
            ]
          }
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "<string>",
  "object": "list",
  "url": "<string>"
}

Authorizations

Authorization
string
header
required

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

Query Parameters

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
query
string

Texto de búsqueda por nota, producto, SKU o variante

Alias de query

date_from
string<date>

Fecha inicial

date_to
string<date>

Fecha final

statuses
enum<string>[]

Estados de la transferencia. Puede repetirse o enviarse separada por comas.

Available options:
draft,
in_transit,
completed,
cancelled
source_warehouse_id
string<uuid>

Depósito de origen

target_warehouse_id
string<uuid>

Depósito de destino

Response

Transferencias obtenidas 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.