> ## 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.
# Éléments de lot
> Récupère la liste des éléments traités pour un lot. Vous pouvez ensuite utiliser le `retrieve_id` pour obtenir le contenu avec le point de terminaison Retrieve
**Métadonnées :** Si vous avez attaché des `metadata` à des éléments individuels lors de la [création du lot](/api-reference/batches/create), elles seront renvoyées avec chaque élément dans la réponse.
## OpenAPI
````yaml fr/openapi/batches.json GET /v1/batches/{batch_id}/items
openapi: 3.0.3
info:
title: API des lots
version: 1.0.0
servers:
- url: https://api.olostep.com
security: []
paths:
/v1/batches/{batch_id}/items:
get:
summary: >-
Récupérer la liste des éléments complétés ou échoués éventuellement avec
le contenu pour un lot spécifique
description: >-
Récupère la liste des éléments et du contenu selon le statut demandé
pour un ID de lot spécifique.
parameters:
- name: batch_id
in: path
required: true
schema:
type: string
description: L'ID du lot pour lequel récupérer les éléments.
- name: status
in: query
required: false
schema:
type: string
enum:
- completed
- failed
description: Statut des URLs à récupérer (completed ou failed).
- name: cursor
in: query
required: false
schema:
type: integer
description: >-
Curseur de pagination. Omet ce paramètre lors de la première
requête. Pour les requêtes suivantes, utilise la valeur `cursor` de
la réponse précédente. Voir
[Pagination](/api-reference/common/pagination) pour plus de détails.
- name: limit
in: query
required: false
schema:
type: integer
description: Nombre de résultats à retourner (recommandé 10-50).
responses:
'200':
description: Réponse réussie avec des éléments de lot.
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: >-
Métadonnées au niveau de l'élément si fournies lors
de la création du lot.
links_on_page:
type: array
items:
type: string
items_count:
type: integer
cursor:
type: integer
description: >-
Curseur de pagination. Présent lorsqu'il y a plus de
résultats disponibles. Utilise cette valeur dans le
paramètre `cursor` de la prochaine requête. Voir
[Pagination](/api-reference/common/pagination) pour plus
de détails.
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: >-
Mauvaise requête en raison de paramètres incorrects. Voir [Mauvaise
Requête](/api-reference/errors/bad_request) pour plus de détails.
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: Mauvaise Requête
detail: Status must be either 'completed' or 'failed'
created: 1704067200
metadata: {}
'401':
description: >-
Les informations d'authentification sont manquantes ou invalides.
Voir [Non autorisé](/api-reference/errors/unauthorized) pour plus de
détails.
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: Non autorisé
detail: Your API key is invalid
created: 1704067200
metadata: {}
'404':
description: >-
Lot non trouvé pour l'ID fourni. Voir [Non
Trouvé](/api-reference/errors/not_found) pour plus de détails.
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: Non Trouvé
detail: Batch not found
created: 1704067200
metadata: {}
'500':
description: >-
Erreur interne du serveur. Voir [Erreur
interne](/api-reference/errors/internal_error) pour plus de détails.
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: Erreur interne du serveur
detail: An unexpected error occurred
created: 1704067200
metadata: {}
security:
- Authorization: []
components:
schemas:
Metadata:
type: object
description: >-
Ensemble de paires clé-valeur pour stocker des informations
supplémentaires sur un objet. Suit l'approche de Stripe avec des règles
de validation : max 50 clés, clé max 40 caractères (pas de crochets),
valeur max 500 caractères, toutes les valeurs stockées en tant que
chaînes.
additionalProperties:
type: string
maxLength: 500
description: >-
Valeur des métadonnées (max 500 caractères). Les nombres et les
booléens sont automatiquement convertis en chaînes.
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: Réponse d'erreur RFC 7807 Détails du Problème
properties:
id:
type: string
description: Identifiant unique de l'erreur
object:
type: string
enum:
- error
description: Toujours 'error'
code:
type: string
description: Code d'erreur lisible par machine
type:
type: string
format: uri
description: Référence URI identifiant le type de problème
status:
type: integer
description: Code de statut HTTP
title:
type: string
description: Résumé court et lisible par un humain
detail:
type: string
description: Explication lisible par un humain
created:
type: integer
description: Horodatage Unix
metadata:
$ref: '#/components/schemas/Metadata'
errors:
type: array
description: Tableau optionnel de détails d'erreur supplémentaires
items: {}
required:
- id
- object
- code
- type
- status
- title
- detail
- created
securitySchemes:
Authorization:
type: http
scheme: bearer
description: >-
En-tête d'authentification Bearer sous la forme Bearer , où
est ton jeton d'authentification.
````