Iterable · Schema

PurchaseRequest

Request body for tracking a purchase event

Cross-Channel MessagingCustomer EngagementEmailMarketing AutomationPush NotificationsSMS

Properties

Name Type Description
user object The user who made the purchase
items array Array of items purchased
total number Total value of the purchase
createdAt integer Unix timestamp of the purchase
dataFields object Additional purchase data fields
campaignId integer Campaign ID to attribute the purchase to
templateId integer Template ID to attribute the purchase to
View JSON Schema on GitHub

JSON Schema

iterable-purchaserequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PurchaseRequest",
  "title": "PurchaseRequest",
  "type": "object",
  "description": "Request body for tracking a purchase event",
  "required": [
    "user",
    "items",
    "total"
  ],
  "properties": {
    "user": {
      "type": "object",
      "description": "The user who made the purchase",
      "properties": {
        "email": {
          "type": "string",
          "format": "email",
          "description": "Email address of the user"
        },
        "userId": {
          "type": "string",
          "description": "UserId of the user"
        },
        "dataFields": {
          "type": "object",
          "description": "Additional user data fields to update",
          "additionalProperties": true
        }
      }
    },
    "items": {
      "type": "array",
      "description": "Array of items purchased",
      "items": {
        "$ref": "#/components/schemas/CommerceItem"
      }
    },
    "total": {
      "type": "number",
      "description": "Total value of the purchase"
    },
    "createdAt": {
      "type": "integer",
      "description": "Unix timestamp of the purchase"
    },
    "dataFields": {
      "type": "object",
      "description": "Additional purchase data fields",
      "additionalProperties": true
    },
    "campaignId": {
      "type": "integer",
      "description": "Campaign ID to attribute the purchase to"
    },
    "templateId": {
      "type": "integer",
      "description": "Template ID to attribute the purchase to"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/iterable-purchaserequest"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.