Supply Chain & Retail Solutions API guide

Overview​

Resource Endpoint​

/api/v2/ingest/object/INV_LOCATIONS_OOTB
/api/v2/ingest/object/INV_LOCATIONS_OOTB

Supported Methods​

Request Headers​

Properties​

Primary Keys​

• location_id (string) - Unique identifier for the location. Used as the primary key for deduplication and UPSERT operations.
• updated_at (timestamp) - Timestamp of the most recent update to the record. Combined with location_id to form the composite primary key.

Attributes​

Relationships​

Outbound References​

Inbound References​

• stock — location_id → locations.location_id
• pricing — location_id → locations.location_id
• order_parameters — location_id → locations.location_id
• purchase_orders — location_id → locations.location_id
• transfers — location_id → locations.location_id
• manufacturing_orders — location_id → locations.location_id
• production_lines — location_id → locations.location_id
• sku_calendar — location_id → locations.location_id
• sales — location_id → locations.location_id
• customer_orders — location_id → locations.location_id
• location_extra — location_id → locations.location_id

JSON Representation​

{
  "solutionName": "INV_OOTB",
  "data": [
    {
      "location_id": "LOC-001",
      "location_name": "Central Warehouse",
      "country": "United Kingdom",
      "is_store": false,
      "is_dc": true,
      "is_factory": false,
      "updated_at": "2025-01-15 08:00:00"
    }
  ],
  "operationType": "UPSERT"
}
{
  "solutionName": "INV_OOTB",
  "data": [
    {
      "location_id": "LOC-001",
      "location_name": "Central Warehouse",
      "country": "United Kingdom",
      "is_store": false,
      "is_dc": true,
      "is_factory": false,
      "updated_at": "2025-01-15 08:00:00"
    }
  ],
  "operationType": "UPSERT"
}

Example Request​

curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/INV_LOCATIONS_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "INV_OOTB",
    "data": [
      {
        "location_id": "LOC-001",
        "location_name": "Central Warehouse",
        "country": "United Kingdom",
        "is_store": false,
        "is_dc": true,
        "is_factory": false,
        "updated_at": "2025-01-15 08:00:00"
      }
    ],
    "operationType": "UPSERT"
  }'
curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/INV_LOCATIONS_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "INV_OOTB",
    "data": [
      {
        "location_id": "LOC-001",
        "location_name": "Central Warehouse",
        "country": "United Kingdom",
        "is_store": false,
        "is_dc": true,
        "is_factory": false,
        "updated_at": "2025-01-15 08:00:00"
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes​

• location_id and updated_at together form the composite primary key. Both fields must be provided on every record.
• The boolean flags is_store, is_dc, and is_factory are all required. A location may have more than one flag set to true if it serves multiple roles.
• Timestamps must be provided in YYYY-MM-DD HH:MM:SS format.
• Records are ingested via UPSERT: an existing record with matching primary keys will be updated; otherwise a new record is inserted.

Related Resources​

• Products
• Stock
• Pricing
• Order Parameters
• Purchase Orders
• Transfers
• Manufacturing Orders
• Production Lines
• SKU Calendar
• Sales
• Customer Orders
• Location Extra