Supply Chain & Retail Solutions API guide

Overview​

Resource Endpoint​

/api/v2/ingest/object/{prefix}LOCATION{suffix}
/api/v2/ingest/object/{prefix}LOCATION{suffix}

Supported Methods​

Request Headers​

Properties​

Primary Keys​

• location_id (string) - Unique identifier for the location

Attributes​

Relationships​

Outbound References​

• product_pricing_daily - Locations can have daily pricing data
• purchase_order - Locations can have purchase orders
• sale - Locations can have sales transactions
• stock - Locations can have stock levels
• tax - Locations can have tax rates

Inbound References​

JSON Representation​

{
  "solutionName": "QP_OOTB",
  "data": [
    {
      "location_id": "LOC-UK-001",
      "country": "United Kingdom",
      "name": "London Distribution Center",
      "region": "South East",
      "created_at": "2025-01-15T08:00:00Z"
    }
  ],
  "operationType": "UPSERT"
}
{
  "solutionName": "QP_OOTB",
  "data": [
    {
      "location_id": "LOC-UK-001",
      "country": "United Kingdom",
      "name": "London Distribution Center",
      "region": "South East",
      "created_at": "2025-01-15T08:00:00Z"
    }
  ],
  "operationType": "UPSERT"
}

Example Request​

curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_LOCATION_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "QP_OOTB",
    "data": [
      {
        "location_id": "LOC-UK-001",
        "country": "United Kingdom",
        "name": "London Distribution Center",
        "region": "South East",
        "created_at": "2025-01-15T08:00:00Z"
      }
    ],
    "operationType": "UPSERT"
  }'
curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_LOCATION_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "QP_OOTB",
    "data": [
      {
        "location_id": "LOC-UK-001",
        "country": "United Kingdom",
        "name": "London Distribution Center",
        "region": "South East",
        "created_at": "2025-01-15T08:00:00Z"
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes​

• Primary Key: This resource uses location_id as the primary key
• Geographic Hierarchy: Supports multi-level geographic organization (country, region)
• Central Entity: Location is referenced by many other B2C entities (pricing, sales, stock, tax)
• Custom Attributes: Additional custom attributes can be added using the /LOCATION/add-attribute endpoint
• Data Validation: All attributes are validated according to their defined data types

Related Resources​

• product_pricing_daily - Daily pricing by location
• purchase_order - Purchase orders for locations
• sale - Sales transactions at locations
• stock - Stock levels by location
• tax - Tax rates by location