Supply Chain & Retail Solutions API guide

Overview​

Resource Endpoint​

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

Supported Methods​

Request Headers​

Properties​

Primary Keys​

• location_id (string) - Foreign key reference to locations
• product_id (string) - Foreign key reference to products

Attributes​

Relationships​

Outbound References​

Inbound References​

• location - Foreign key location_id references location
• product - Foreign key product_id references product

JSON Representation​

{
  "solutionName": "QP_OOTB",
  "data": [
    {
      "location_id": "LOC-UK-001",
      "product_id": "PROD-001",
      "created_at": "2025-01-10T08:00:00Z",
      "vat": 0.20,
      "updated_at": "2025-01-28T10:00:00Z"
    }
  ],
  "operationType": "UPSERT"
}
{
  "solutionName": "QP_OOTB",
  "data": [
    {
      "location_id": "LOC-UK-001",
      "product_id": "PROD-001",
      "created_at": "2025-01-10T08:00:00Z",
      "vat": 0.20,
      "updated_at": "2025-01-28T10:00:00Z"
    }
  ],
  "operationType": "UPSERT"
}

Example Request​

curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_TAX_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "QP_OOTB",
    "data": [
      {
        "location_id": "LOC-UK-001",
        "product_id": "PROD-001",
        "created_at": "2025-01-10T08:00:00Z",
        "vat": 0.20,
        "updated_at": "2025-01-28T10:00:00Z"
      }
    ],
    "operationType": "UPSERT"
  }'
curl -X POST \
  'https://service.peak.ai/ingestion-api/api/v2/ingest/object/QP_TAX_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "QP_OOTB",
    "data": [
      {
        "location_id": "LOC-UK-001",
        "product_id": "PROD-001",
        "created_at": "2025-01-10T08:00:00Z",
        "vat": 0.20,
        "updated_at": "2025-01-28T10:00:00Z"
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes​

• Foreign Key Dependencies: Requires valid product_id and location_id to exist in their respective tables
• Tax Rate Format: VAT is typically stored as a decimal (e.g., 0.20 represents 20% tax)
• Location-Specific: Tax rates can vary by location due to different jurisdictions
• Product-Specific: Some products may have different tax rates (e.g., reduced rates for essentials)
• Pricing Calculations: Used to calculate final prices including tax
• Custom Attributes: Additional custom attributes can be added using the /TAX/add-attribute endpoint
• Data Validation: All attributes are validated according to their defined data types

Related Resources​

• product - Product information
• location - Location details
• product_pricing_daily - Pricing data used with tax rates
• sale - Sales transactions with applied tax