> ## Documentation Index
> Fetch the complete documentation index at: https://docs.olostep.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Elementos del Lote
> Recupera la lista de elementos procesados para un lote. Luego puedes usar el `retrieve_id` para obtener el contenido con el Endpoint de Recuperación
**Metadatos:** Si adjuntaste `metadata` a elementos individuales al [crear el lote](/api-reference/batches/create), se devolverá con cada elemento en la respuesta.
## OpenAPI
````yaml es/openapi/batches.json GET /v1/batches/{batch_id}/items
openapi: 3.0.3
info:
title: API de Lotes
version: 1.0.0
servers:
- url: https://api.olostep.com
security: []
paths:
/v1/batches/{batch_id}/items:
get:
summary: >-
Obtener lista de elementos completados o fallidos opcionalmente con
contenido para un lote específico
description: >-
Obtiene la lista de elementos y contenido según el estado solicitado
para un ID de lote específico.
parameters:
- name: batch_id
in: path
required: true
schema:
type: string
description: El ID del lote para obtener elementos.
- name: status
in: query
required: false
schema:
type: string
enum:
- completed
- failed
description: Estado de las URLs a obtener (completed o failed).
- name: cursor
in: query
required: false
schema:
type: integer
description: >-
Cursor de paginación. Omite este parámetro en la primera solicitud.
Para solicitudes posteriores, usa el valor `cursor` de la respuesta
anterior. Consulta [Paginación](/api-reference/common/pagination)
para más detalles.
- name: limit
in: query
required: false
schema:
type: integer
description: Número de resultados a devolver (recomendado 10-50).
responses:
'200':
description: Respuesta exitosa con elementos por lote.
content:
application/json:
schema:
type: object
properties:
batch_id:
type: string
object:
type: string
status:
type: string
items:
type: array
items:
type: object
properties:
custom_id:
type: string
retrieve_id:
type: string
url:
type: string
metadata:
allOf:
- $ref: '#/components/schemas/Metadata'
description: >-
Metadatos a nivel de elemento si se proporcionaron
durante la creación del lote.
links_on_page:
type: array
items:
type: string
items_count:
type: integer
cursor:
type: integer
description: >-
Cursor de paginación. Presente cuando hay más resultados
disponibles. Usa este valor en el parámetro `cursor` de la
siguiente solicitud. Consulta
[Paginación](/api-reference/common/pagination) para más
detalles.
example:
batch_id: batch_abc123def456
object: list
status: completed
items:
- custom_id: product-123
retrieve_id: ret_xyz789
url: https://example.com/product/123
metadata:
source: catalog_sync
priority: high
- custom_id: product-456
retrieve_id: ret_abc456
url: https://example.com/product/456
items_count: 2
'400':
description: >-
Solicitud incorrecta debido a parámetros incorrectos. Consulta
[Solicitud Incorrecta](/api-reference/errors/bad_request) para más
detalles.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
id: error_abc123
object: error
code: validation_error
type: https://docs.olostep.com/api-reference/errors/bad_request
status: 400
title: Solicitud Incorrecta
detail: Status must be either 'completed' or 'failed'
created: 1704067200
metadata: {}
'401':
description: >-
Las credenciales de autenticación faltan o son inválidas. Consulta
[Unauthorized](/api-reference/errors/unauthorized) para más
detalles.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
id: error_abc123
object: error
code: invalid_api_key
type: https://docs.olostep.com/api-reference/errors/unauthorized
status: 401
title: No autorizado
detail: Your API key is invalid
created: 1704067200
metadata: {}
'404':
description: >-
Lote no encontrado para el ID proporcionado. Consulta [No
Encontrado](/api-reference/errors/not_found) para más detalles.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
id: error_abc123
object: error
code: batch_not_found
type: https://docs.olostep.com/api-reference/errors/not_found
status: 404
title: No Encontrado
detail: Batch not found
created: 1704067200
metadata: {}
'500':
description: >-
Error interno del servidor. Consulta [Internal
Error](/api-reference/errors/internal_error) para más detalles.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
id: error_abc123
object: error
code: internal_server_error
type: https://docs.olostep.com/api-reference/errors/internal_error
status: 500
title: Error Interno del Servidor
detail: An unexpected error occurred
created: 1704067200
metadata: {}
security:
- Authorization: []
components:
schemas:
Metadata:
type: object
description: >-
Conjunto de pares clave-valor para almacenar información adicional sobre
un objeto. Sigue el enfoque de Stripe con reglas de validación: máximo
50 claves, clave máximo 40 caracteres (sin corchetes), valor máximo 500
caracteres, todos los valores almacenados como cadenas.
additionalProperties:
type: string
maxLength: 500
description: >-
Valor de metadatos (máximo 500 caracteres). Los números y booleanos se
convierten automáticamente a cadenas.
maxProperties: 50
example:
order_id: '12345'
customer_name: John Doe
priority: high
processed: 'true'
x-validation-rules:
max_keys: 50
key_max_length: 40
key_forbidden_chars:
- '['
- ']'
value_max_length: 500
value_types:
- string
- number (coerced)
- boolean (coerced)
Error:
type: object
description: Respuesta de error de Detalles del Problema RFC 7807
properties:
id:
type: string
description: Identificador único de error
object:
type: string
enum:
- error
description: Siempre 'error'
code:
type: string
description: Código de error legible por máquina
type:
type: string
format: uri
description: Referencia URI que identifica el tipo de problema
status:
type: integer
description: Código de estado HTTP
title:
type: string
description: Resumen corto y legible por humanos
detail:
type: string
description: Explicación legible por humanos
created:
type: integer
description: Marca de tiempo Unix
metadata:
$ref: '#/components/schemas/Metadata'
errors:
type: array
description: Array opcional de detalles adicionales del error
items: {}
required:
- id
- object
- code
- type
- status
- title
- detail
- created
securitySchemes:
Authorization:
type: http
scheme: bearer
description: >-
Encabezado de autenticación Bearer de la forma Bearer , donde
es tu token de autenticación.
````