> ## 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.
# Batch-items
> Haalt de lijst op van items die voor een batch zijn verwerkt. Je kunt vervolgens de `retrieve_id` gebruiken om de inhoud op te halen met de Retrieve Endpoint
**Metadata:** Als je `metadata` hebt toegevoegd aan individuele items bij het [aanmaken van de batch](/api-reference/batches/create), zal dit worden teruggegeven met elk item in de respons.
## OpenAPI
````yaml nl/openapi/batches.json GET /v1/batches/{batch_id}/items
openapi: 3.0.3
info:
title: Batches API
version: 1.0.0
servers:
- url: https://api.olostep.com
security: []
paths:
/v1/batches/{batch_id}/items:
get:
summary: >-
Ophalen van voltooide of mislukte itemslijst optioneel met inhoud voor
een specifieke batch
description: >-
Haalt de lijst van items en inhoud op volgens de gevraagde status voor
een specifieke batch ID.
parameters:
- name: batch_id
in: path
required: true
schema:
type: string
description: De ID van de batch waarvoor je items wilt ophalen.
- name: status
in: query
required: false
schema:
type: string
enum:
- completed
- failed
description: Status van de URL's om op te halen (voltooid of mislukt).
- name: cursor
in: query
required: false
schema:
type: integer
description: >-
Paginering cursor. Laat deze parameter weg bij het eerste verzoek.
Voor volgende verzoeken, gebruik de `cursor` waarde van de vorige
respons. Zie [Pagination](/api-reference/common/pagination) voor
details.
- name: limit
in: query
required: false
schema:
type: integer
description: Aantal resultaten om te retourneren (aanbevolen 10-50).
responses:
'200':
description: Succesvolle respons met batch items.
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: >-
Item-niveau metadata als verstrekt tijdens batch
creatie.
links_on_page:
type: array
items:
type: string
items_count:
type: integer
cursor:
type: integer
description: >-
Paginering cursor. Aanwezig wanneer er meer resultaten
beschikbaar zijn. Gebruik deze waarde in de volgende
aanvraag's `cursor` parameter. Zie
[Paginering](/api-reference/common/pagination) voor
details.
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: >-
Foute aanvraag door onjuiste parameters. Zie [Foute
Aanvraag](/api-reference/errors/bad_request) voor details.
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: Slecht Verzoek
detail: Status must be either 'completed' or 'failed'
created: 1704067200
metadata: {}
'401':
description: >-
Authenticatiegegevens ontbreken of zijn ongeldig. Zie
[Unauthorized](/api-reference/errors/unauthorized) voor details.
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: Niet geautoriseerd
detail: Your API key is invalid
created: 1704067200
metadata: {}
'404':
description: >-
Batch niet gevonden voor de opgegeven ID. Zie [Not
Found](/api-reference/errors/not_found) voor details.
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: Niet Gevonden
detail: Batch not found
created: 1704067200
metadata: {}
'500':
description: >-
Interne serverfout. Zie [Internal
Error](/api-reference/errors/internal_error) voor details.
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: Interne Serverfout
detail: An unexpected error occurred
created: 1704067200
metadata: {}
security:
- Authorization: []
components:
schemas:
Metadata:
type: object
description: >-
Set van sleutel-waarde paren voor het opslaan van aanvullende informatie
over een object. Volgt Stripe's aanpak met validatieregels: max 50
sleutels, sleutel max 40 tekens (geen vierkante haken), waarde max 500
tekens, alle waarden opgeslagen als strings.
additionalProperties:
type: string
maxLength: 500
description: >-
Metadata waarde (max 500 tekens). Nummers en booleans worden
automatisch omgezet naar strings.
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: RFC 7807 Probleem Details foutrespons
properties:
id:
type: string
description: Unieke foutidentificatie
object:
type: string
enum:
- error
description: Altijd 'error'
code:
type: string
description: Machine-leesbare foutcode
type:
type: string
format: uri
description: URI referentie die het probleemtype identificeert
status:
type: integer
description: HTTP statuscode
title:
type: string
description: Korte, mens-leesbare samenvatting
detail:
type: string
description: Mens-leesbare uitleg
created:
type: integer
description: Unix tijdstempel
metadata:
$ref: '#/components/schemas/Metadata'
errors:
type: array
description: Optionele array van aanvullende foutdetails
items: {}
required:
- id
- object
- code
- type
- status
- title
- detail
- created
securitySchemes:
Authorization:
type: http
scheme: bearer
description: >-
Bearer authenticatie header in de vorm Bearer , waar jouw
auth token is.
````