Bulk

Bulk

REST

The Bulk API provides functionality to manage bulk process.

Description

The Bulk API enables the creation and management of bulk process instances in the IITC platform, allowing clients to submit high-volume operations, retrieve bulk and bulk item details, and monitor execution progress and completion status via dedicated APIs and status notifications.

Use Cases

The Bulk API may be used by client applications wishing to:

Create bulk process instances to handle high‑volume operations through a single bulk request.

Execute and manage large sets of related actions or orders as part of a single bulk process.

Retrieve a list of existing bulk processes and their high‑level status.

Access detailed information for a specific bulk execution, including its current state and metadata.

Inspect individual items within a bulk process to understand per‑item execution results.

Resources

Key features

This API enables users to:

  • Create bulk process instances to execute high‑volume operations through a single request.
  • Group and process multiple related actions or orders as part of one bulk execution.
  • Retrieve a consolidated view of all bulk processes and their execution status.
  • Access detailed information for a specific bulk process, including metadata and current state.
  • Inspect individual bulk items to analyze per‑item processing results and outcomes.
  • Track bulk execution progress and completion via asynchronous bulk status notifications.
  • Improve scalability and operational efficiency when handling large datasets or mass actions.