industry-department-solutions
latest
false
- Overview
- API Resources
Supply Chain & Retail Solutions API guide
Overview
The region resource represents geographic regions in the B2B pricing application. This resource stores regional information used for pricing and cost calculations.
→ For business context (purpose, usage notes, how this resource is used in the solution), see Region dataset in the User Guide.
Resource Endpoint
/api/v2/ingest/object/{prefix}REGION{suffix}
/api/v2/ingest/object/{prefix}REGION{suffix}
Supported Methods
| Method | Return Type | Description |
|---|---|---|
| POST | Response | Ingest (create/update) region 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
- region_id (string) - Unique identifier for the region
- updated_at (datetime) - Timestamp of when the record was last updated
Attributes
About Required + Nullable: every attribute key must appear in each payload (Required: Yes). Nullable: Yes means the value can be null when you don't have data; Nullable: No means a non-null value is required. See Schema definition structure for the underlying rules.
| Attribute | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
region_id | string | Yes | No | A unique identifier for each region. This is the primary key of the table. |
updated_at | datetime | Yes | Yes | Timestamp when the record was updated. |
region_name | string | Yes | No | The name of the region, describing the geographical area. Used for display purposes and to facilitate easier identification of regions by users. |
Relationships
Outbound References
This resource has relationships to:
- competitor_price - Regions can have competitive pricing data
- list_price - Regions can have list prices for products
- product_cost - Regions can have product cost information
- quote_line - Regions can be associated with quote lines
Inbound References
None
JSON Representation
{
"solutionName": "QP_OOTB",
"data": [
{
"region_id": "EMEA-UK",
"updated_at": "2025-01-28T10:00:00Z",
"region_name": "United Kingdom"
}
],
"operationType": "UPSERT"
}
{
"solutionName": "QP_OOTB",
"data": [
{
"region_id": "EMEA-UK",
"updated_at": "2025-01-28T10:00:00Z",
"region_name": "United Kingdom"
}
],
"operationType": "UPSERT"
}
Example Request
curl -X POST \
'https://ingestion.peak.ai/api/v2/objects/QP_REGION_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "QP_OOTB",
"data": [
{
"region_id": "EMEA-UK",
"updated_at": "2025-01-28T10:00:00Z",
"region_name": "United Kingdom"
}
],
"operationType": "UPSERT"
}'
curl -X POST \
'https://ingestion.peak.ai/api/v2/objects/QP_REGION_OOTB' \
-H 'Authorization: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"solutionName": "QP_OOTB",
"data": [
{
"region_id": "EMEA-UK",
"updated_at": "2025-01-28T10:00:00Z",
"region_name": "United Kingdom"
}
],
"operationType": "UPSERT"
}'
Important Notes
- Geographic Scope: Regions define the geographic boundaries for pricing and cost calculations
- Custom Attributes: Additional custom attributes can be added using the
/REGION/add-attributeendpoint - Data Validation: All attributes are validated according to their defined data types
Related Resources
- competitor_price - Competitor pricing by region
- list_price - List pricing by region
- product_cost - Product costs by region
- quote_line - Quote lines associated with regions