Skip to main content
GET
cURL
When to use: After starting a batch processing job with the POST endpoint, use this endpoint to:
  • Check if processing is complete
  • Monitor real-time progress
  • Retrieve paginated results when processing completes
Managing Executions:
Authentication Required: This endpoint requires a valid API key. The API key is verified, but execution IDs are not restricted to specific API keys. Keep your execution IDs secure.

Request

string
required
Your API key for authentication
string
required
The execution ID returned from POST /v1/productsFormat: products-batch-{uuid}Note: If the execution ID does not exist, the endpoint returns a 404 Not Found error.

Query Parameters

number
default:"1"
Page number for paginated results (only applicable when status is “completed”)Minimum: 1
number
default:"50"
Number of results per page (only applicable when status is “completed”)Maximum: 100

Response

string
Current execution statusPossible values:
  • "pending" - Execution has been created but not yet started
  • "running" - Execution is currently processing
  • "completed" - Execution finished successfully
  • "failed" - Execution failed or was aborted
object | null
Real-time progress information (null if not available)
string | null
Error message (always present, null if execution is successful or still running)
object
Product results (only present when status is “completed”)
object
Pagination information (only present when status is “completed” and results are available)
cURL

Polling Strategy

For best results when waiting for completion:
  1. Initial Poll: Check status immediately after receiving execution_id
  2. Polling Interval: Wait 5-10 seconds between polls for running executions
  3. Exponential Backoff: Consider increasing wait time for long-running jobs
  4. Timeout: Set a maximum wait time based on your batch size