Paginación

Todos los endpoints de listado devuelven resultados paginados. La API utiliza paginación basada en desplazamiento con parámetros de consulta y estructura de respuesta consistentes en cada recurso.

Parámetros de Consulta

Los endpoints específicos de órdenes (Órdenes de Compra, Órdenes de Envío, Órdenes de Trabajo) aceptan parámetros adicionales:

Los endpoints de órdenes tienen un tamaño máximo de página menor de 50 en lugar de 250.

Estructura de Respuesta

Cada respuesta paginada envuelve los resultados en un objeto consistente:

{
  "value": [
    { "partNo": 1, "shortID": "WIDGET-001", "description": "Standard Widget" },
    { "partNo": 2, "shortID": "GADGET-002", "description": "Premium Gadget" }
  ],
  "totalCount": 847,
  "page": 1,
  "pageSize": 25,
  "pageCount": 34,
  "hasMore": true
}

Encabezados de Respuesta

Las respuestas paginadas también incluyen estos encabezados para clientes que prefieren paginación basada en encabezados:

Iteración de Todas las Páginas

Para obtener todos los registros, incremente page hasta que hasMore sea false:

$page = 1
$allItems = @()

do {
    $response = Invoke-RestMethod -Uri "$baseUrl/Item?page=$page&pageSize=100" `
        -Headers @{ Authorization = "Bearer $token" }
    $allItems += $response.value
    $page++
} while ($response.hasMore)

Write-Host "Retrieved $($allItems.Count) items"

page=1
while true; do
  response=$(curl -s "$BASE_URL/Item?page=$page&pageSize=100" \
    -H "Authorization: Bearer $TOKEN")

  # Process items in .value
  echo "$response" | jq '.value[]'

  has_more=$(echo "$response" | jq '.hasMore')
  if [ "$has_more" = "false" ]; then break; fi
  page=$((page + 1))
done

Ordenamiento

Pase sort con un nombre de columna y opcionalmente direction:

GET /Item?sort=shortID&direction=DESC&page=1&pageSize=50

Las columnas de ordenamiento disponibles varian por endpoint. Los valores de ordenamiento invalidos se ignoran (el endpoint usa su ordenamiento predeterminado). Consulte la documentacion Swagger en su instancia para las opciones de ordenamiento que soporta cada endpoint.

Modificado Desde

Use modifiedSince para sincronizacion incremental. Solo se devuelven los registros con una marca de tiempo Modified en o despues de su valor:

GET /Item?modifiedSince=2026-05-01T00:00:00Z&page=1&pageSize=250

La marca de tiempo debe estar en formato ISO 8601 (se recomienda UTC). Almacene el ultimo valor de Modified de cada ejecucion de sincronizacion y uselo como modifiedSince en la siguiente ejecucion.

Not all endpoints support modifiedSince — see individual endpoint documentation for availability.

Page Size Limits

Requesting a pageSize above the maximum silently caps it at the limit.