Data Onboarding Checklist

Use this checklist to track your progress as you prepare and submit data to the Supply Chain & Retail Solutions ingestion API. Complete each item before moving on to the next stage.

Before you begin

Read the Getting Started guide
Confirm you have access to platform.peak.ai
Generate a Personal Access Token (PAT) from the Access Tokens page in the platform

Gather your solution details

Submit a support ticket if you do not have these details already.

Obtain your solution name (e.g., QP_OOTB)
Obtain your prefix (e.g., QP_)
Obtain your suffix (e.g., _OOTB)
Identify the target schema name (e.g., STAGE)
Identify the app name and app version of the standard schema you will roll out

Roll out the solution tables

This step creates the warehouse tables (and matching <table_name>_failed_rows tables) you will ingest into. See Schema lifecycle for the full reference.

Confirm a standard schema has been saved for your appName + appVersion
Send a POST /api/v2/schema/rollout request for your solutionName
Verify the response lists every expected table under successfulObjects and that failedObjects is empty
(Optional) Use GET /api/v2/schema/solutions to confirm the rollout is registered for your tenant

Prepare your data

Review the data model for your solution module:
- Markdown & Promotions
- Quote Pricing
- Inventory Management
Review the supported Data Types and ensure your data matches the expected formats
Identify the primary key columns for each object you plan to ingest
Confirm all required fields are present in your dataset
Split your data into batches of 500 rows or fewer per request

Submit your data

Choose your operation type: UPSERT (insert or update) or APPEND (insert only)
Construct your API request using the ingestion URL pattern: POST https://ingestion.peak.ai/api/v2/objects/{prefix}{OBJECT_NAME}{suffix}
Send a test request with a small data sample (consider dryRun: true for a no-write smoke test) and verify a successful response
Review the API Guide for error codes if any validation errors are returned. A 207 Multi-Status response means part of the batch was accepted and part rejected.
Ingest your full dataset

Monitor your ingestion

Confirm aggregate outcomes (records ingested, pass rate, top error codes) in the Data Quality Dashboard in your Peak tenant
Review any failed rows in the dashboard's failed-rows detail page

Optional

Add custom attributes to extend the schema for your business needs
Request enablement of scheduled ingestion if you want incoming rows to be batched and flushed on a cron rather than written immediately

Supply Chain & Retail Solutions API guide

Before you begin​

Gather your solution details​

Roll out the solution tables​

Prepare your data​

Submit your data​

Monitor your ingestion​

Optional​

Was this page helpful?