Batch Items

Retrieves the list of items processed for a batch. You can then use the retrieve_id to get the content with the Retrieve Endpoint

GET /v1/batches/{batch_id}/items

Retrieve completed or failed items list optionally with content for a specific batch

cURL

curl --request GET \
  --url https://api.olostep.com/v1/batches/{batch_id}/items \
  --header 'Authorization: Bearer <token>'

200

{
  "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
}

Metadata: If you attached metadata to individual items when creating the batch, it will be returned with each item in the response.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer , where is your auth token.

Path Parameters

batch_id · string · required

The ID of the batch to retrieve items for.

Query Parameters

status · enum<string>

Status of the URLs to retrieve (completed or failed).

Available options: completed, failed

cursor · integer

Pagination cursor. Omit this parameter on the first request. For subsequent requests, use the cursor value from the previous response. See Pagination for details.

limit · integer

Number of results to return (recommended 10-50).

Response

200

application/json

Successful response with batch items.

batch_id · string

object · string

status · string

items · object[]

Show child attributes

items_count · integer

cursor · integer

Pagination cursor. Present when there are more results available. Use this value in the next request's cursor parameter. See Pagination for details.