Supply Chain & Retail Solutions API guide

Overview​

Resource Endpoint​

/api/v2/ingest/object/INV_LOCATION_EXTRA_OOTB
/api/v2/ingest/object/INV_LOCATION_EXTRA_OOTB

Supported Methods​

Request Headers​

Properties​

Primary Keys​

• location_id (string) - Unique identifier for the location this attribute belongs to. Part of the composite primary key.
• location_extra_id (string) - Unique identifier for this specific extra attribute record. Part of the composite primary key.
• updated_at (timestamp) - Timestamp of the most recent update to the record. Part of the composite primary key.

Attributes​

Relationships​

Outbound References​

Inbound References​

• locations — location_id → locations.location_id

JSON Representation​

{
  "solutionName": "INV_OOTB",
  "data": [
    {
      "location_id": "LOC-001",
      "location_extra_id": "ATTR-001",
      "location_extra_attribute": "capacity_units",
      "location_extra_value": "10000",
      "updated_at": "2025-01-15 08:00:00",
      "created_at": "2025-01-10 08:00:00"
    }
  ],
  "operationType": "UPSERT"
}
{
  "solutionName": "INV_OOTB",
  "data": [
    {
      "location_id": "LOC-001",
      "location_extra_id": "ATTR-001",
      "location_extra_attribute": "capacity_units",
      "location_extra_value": "10000",
      "updated_at": "2025-01-15 08:00:00",
      "created_at": "2025-01-10 08:00:00"
    }
  ],
  "operationType": "UPSERT"
}

Example Request​

curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/INV_LOCATION_EXTRA_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "INV_OOTB",
    "data": [
      {
        "location_id": "LOC-001",
        "location_extra_id": "ATTR-001",
        "location_extra_attribute": "capacity_units",
        "location_extra_value": "10000",
        "updated_at": "2025-01-15 08:00:00",
        "created_at": "2025-01-10 08:00:00"
      }
    ],
    "operationType": "UPSERT"
  }'
curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/INV_LOCATION_EXTRA_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "INV_OOTB",
    "data": [
      {
        "location_id": "LOC-001",
        "location_extra_id": "ATTR-001",
        "location_extra_attribute": "capacity_units",
        "location_extra_value": "10000",
        "updated_at": "2025-01-15 08:00:00",
        "created_at": "2025-01-10 08:00:00"
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes​

• location_id, location_extra_id, and updated_at together form the composite primary key. All three fields must be provided on every record.
• location_extra_attribute is required and defines the name of the custom attribute being stored.
• location_extra_value is optional; it may be omitted or set to null if no value is currently available for the attribute.
• All attribute values are stored as strings, regardless of the underlying data type they represent.
• location_id must correspond to an existing record in the Locations resource.
• All timestamps must be provided in YYYY-MM-DD HH:MM:SS format.

Related Resources​

• Locations
• Product Extra