industry-department-solutions
latest
false
- Overview
- API Resources
Supply Chain & Retail Solutions API guide
Last updated Apr 16, 2026
Merchant
Overview
The merchant resource represents merchant entities in the B2B pricing application. This resource stores merchant information including categorization details.
Resource Endpoint
/api/v2/ingest/object/{prefix}MERCHANT{suffix}
/api/v2/ingest/object/{prefix}MERCHANT{suffix}
Supported Methods
| Method | Return Type | Description |
|---|---|---|
| POST | Response | Ingest (create/update) merchant records via UPSERT operation |
Request Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Your Personal Access Token (PAT) from platform.peak.ai |
Content-Type | Yes | Must be application/json |
Properties
Primary Keys
- merchant_id (string) - Unique identifier for the merchant
- updated_at (datetime) - Timestamp of when the record was last updated
Attributes
| Attribute | Data Type | Required | Description |
|---|---|---|---|
merchant_id | string | Yes | Unique identifier for each merchant. Used to join merchant metadata to quotations and sales for model training and guardrails. |
updated_at | datetime | Yes | Timestamp when the record was updated. Used to identify the most up-to-date data in the UI and to match merchant metadata to the date of each quote in model training. |
merchant_name | string | No | Merchant name. Used in the UI to identify merchants. |
merchant_category | string | No | Merchant category. Used in model training as a feature to determine the optimal quote price. |
merchant_subcategory | string | No | Merchant sub-category. Used in model training as a feature to determine the optimal quote price. |
Relationships
Outbound References
This resource has relationships to:
- quote_line - Merchants can be associated with multiple quote lines
- sale - Merchants can have multiple sales records
Inbound References
None
JSON Representation
{
"solutionName": "QP_OOTB",
"data": [
{
"merchant_id": "MERCH-001",
"updated_at": "2025-01-28T10:00:00Z",
"merchant_name": "Global Trading Co",
"merchant_category": "Distributor",
"merchant_subcategory": "Wholesale"
}
],
"operationType": "UPSERT"
}
{
"solutionName": "QP_OOTB",
"data": [
{
"merchant_id": "MERCH-001",
"updated_at": "2025-01-28T10:00:00Z",
"merchant_name": "Global Trading Co",
"merchant_category": "Distributor",
"merchant_subcategory": "Wholesale"
}
],
"operationType": "UPSERT"
}
Example Request
curl -X POST \
'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_MERCHANT_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "QP_OOTB",
"data": [
{
"merchant_id": "MERCH-001",
"updated_at": "2025-01-28T10:00:00Z",
"merchant_name": "Global Trading Co",
"merchant_category": "Distributor",
"merchant_subcategory": "Wholesale"
}
],
"operationType": "UPSERT"
}'
curl -X POST \
'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_MERCHANT_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "QP_OOTB",
"data": [
{
"merchant_id": "MERCH-001",
"updated_at": "2025-01-28T10:00:00Z",
"merchant_name": "Global Trading Co",
"merchant_category": "Distributor",
"merchant_subcategory": "Wholesale"
}
],
"operationType": "UPSERT"
}'
Important Notes
- Custom Attributes: Additional custom attributes can be added using the
/MERCHANT/add-attributeendpoint - Data Validation: All attributes are validated according to their defined data types
Related Resources
- customer - Related business entities
- quote_line - Quote line items referencing merchants
- sale - Sales records associated with merchants