Supply Chain & Retail Solutions API guide

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.​

• 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 for your deployment

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://service.peak.ai/ingestion-api/api/v2/objects/{prefix}{OBJECT_NAME}{suffix}
• Send a test request with a small data sample and verify a successful response
• Review the API Guide for error codes if any validation errors are returned
• Ingest your full dataset

Optional​

• Add custom attributes to extend the schema for your business needs