Paginación, filtros y ordenación

Las rutas de búsqueda y listado devuelven páginas de resultados. La paginación evita respuestas demasiado grandes y permite reconciliar datos de forma estable. Algunas rutas también aceptan filterBy y sortBy. Consulta la referencia OpenAPI de cada endpoint para saber qué campos admite.

Parámetros

Parámetro	Tipo	Valor por defecto	Reglas
`pageNumber`	integer	`1`	Debe ser mayor o igual que `1`.
`pageSize`	integer	`25`	Debe estar entre `1` y `1000`.

GET /v1/items/skus?pageNumber=1&pageSize=50

Filtrar resultados

filterBy usa expresiones con el formato Campo[Operador]valor.

GET /v1/items/skus?filterBy=Name[Contains]mesa&pageNumber=1&pageSize=50

Usa los nombres exactos de campo que indique la referencia del endpoint. No todos los campos admiten los mismos operadores.

Operador	Uso habitual
`Contains`	El campo contiene el texto indicado.
`Equals`	El campo coincide exactamente con el valor.
`StartsWith`	El campo empieza por el texto indicado.
`EndsWith`	El campo termina por el texto indicado.
`IsNull`	El campo no tiene valor.
`IsNotNull`	El campo tiene valor.
`Gt`	Mayor que.
`Gte`	Mayor o igual que.
`Lt`	Menor que.
`Lte`	Menor o igual que.
`IsAfter`	Fecha posterior al valor indicado.
`IsOnOrAfter`	Fecha igual o posterior al valor indicado.
`IsBefore`	Fecha anterior al valor indicado.
`IsOnOrBefore`	Fecha igual o anterior al valor indicado.

Puedes combinar filtros con && para Y y || para O. Usa paréntesis cuando necesites agrupar condiciones.

GET /v1/items/skus?filterBy=Name[Contains]mesa&&Code[StartsWith]SKU

Ordenar resultados

sortBy indica el campo de ordenación. Para ordenar en descendente, antepón - al campo.

GET /v1/items/skus?sortBy=Name&pageNumber=1&pageSize=50
GET /v1/items/skus?sortBy=-LastModifiedAt&pageNumber=1&pageSize=50

Los campos disponibles dependen del endpoint. Los campos de fecha como CreatedAt o LastModifiedAt suelen ser útiles para sincronizaciones incrementales cuando la ruta los expone.

Respuesta

{
  "results": [
    {
      "reference": "SKU-0001",
      "name": "Mesa nórdica blanca"
    }
  ],
  "pageNumber": 1,
  "totalPages": 12,
  "totalCount": 587,
  "pageSize": 50
}

Recorrer todas las páginas

Empieza por la primera página

Llama con un pageSize que tu integración pueda procesar sin agotar el tiempo de espera.

Procesa los resultados

Guarda cada elemento usando su id o reference.

Avanza hasta la última página

Sigue llamando mientras pageNumber sea menor que totalPages.

Repite periódicamente

En integraciones críticas, combina paginación con webhooks para detectar cambios entre sincronizaciones.

page=1
while true; do
  response=$(curl "https://api.bold-factory.com/v1/items/skus?pageNumber=$page&pageSize=100" \
    -H "X-Api-Key: $BOLD_API_KEY")

  total_pages=$(echo "$response" | jq ".totalPages")
  echo "$response" | jq ".results[]"

  if [ "$page" -ge "$total_pages" ]; then
    break
  fi

  page=$((page + 1))
done

Usa páginas pequeñas durante pruebas. Sube pageSize solo cuando midas tiempos de respuesta, memoria y límites del sistema receptor.

Primeros pasos

Webhooks

Referencia de API

Paginación, filtros y ordenación

Parámetros

Filtrar resultados

Ordenar resultados

Respuesta

Recorrer todas las páginas

​Parámetros

​Filtrar resultados

​Ordenar resultados

​Respuesta

​Recorrer todas las páginas

Parámetros

Filtrar resultados

Ordenar resultados

Respuesta

Recorrer todas las páginas