UiPath Documentation
industry-department-solutions
latest
false
  • Overview
    • Introduction
    • Getting Started
    • API Guide
    • Customizations
    • Data Onboarding Checklist
  • API Resources
UiPath logo, featuring letters U and I in white

Supply Chain & Retail Solutions API guide

Last updated Apr 16, 2026

Introduction

The Data Ingestion API is a web-based REST API used to onboard and validate data into UiPath's Supply Chain & Retail Pricing Solution. It provides a clear, standardised way for external partners and Peak data engineers to submit solution-related data.

The API defines versioned schemas and validation rules, documented in this documentation, which serve as the starting point for onboarding. By validating data at ingestion time, the API ensures that all submitted data is consistent, complete, and immediately usable by the Pricing Solution.

The API manages the full lifecycle of data ingestion, including schema validation, error reporting, and observability, so data providers can confidently monitor and troubleshoot their submissions. When validation issues occur, the API returns actionable feedback that enables quick correction and resubmission.

For historical data onboarding, the API only supports 500 rows per payload, with submission rates supported up to 50 requests per second, allowing larger historical datasets to be uploaded in a controlled and scalable manner.

For ongoing updates, the API supports both synchronous and asynchronous ingestion modes, enabling reliable daily or incremental data delivery while maintaining consistent validation guarantees. Once ingested successfully, the data is immediately available for use by the Pricing Solution..

Main capabilities

  • Data ingestion – receives datasets from external sources and ingests them into the warehouse according to schema and validation rules

  • Schema-driven validation – enforces data types, required fields, uniqueness, and custom business rules on each row

  • Error handling – returns detailed row-level validation errors and batch status for easy troubleshooting

  • Data management – supports updating and deleting records based on primary keys

  • Integration-ready – exposes a standard HTTP interface with JSON payloads and token-based authentication for third-party applications

This guide is intended primarily for technical end users familiar with REST APIs. For additional support, submit a support ticket.

  • Main capabilities

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated