IAB Tech Lab · Schema

Order

Campaign container (insertion order) holding one or more lines. Merges the buyer's OpenDirect ``Order`` with the seller's ``ExecutionOrder``. Per flagged decision FD-8, the seller's record is authoritative for order/fulfillment state. ID minting: ``order_id`` is seller-issued (created via the seller's API on buyer request).

CompanyAdvertisingAdTechStandardsProgrammaticReal-Time BiddingConsentPrivacyVideo AdsAgentic AdvertisingNon-Profit

Properties

Name Type Description
account_id string Seller-issued account identifier.
budget object Estimated budget (exact micros; FD-11).
consent_context object Privacy consent signals riding with the order (FD-10).
created_at string
deal_id object Deal this order fulfils, if deal-led.
end_date string
ext object
external_ids object Ad-server order references (e.g. GAM order id).
name string
order_id string Seller-issued order identifier.
proposal_id object Proposal this order materializes, if any.
start_date string
status object
updated_at object
View JSON Schema on GitHub

JSON Schema

iab-tech-lab-agentic-primitive-order.json Raw ↑
{
  "$defs": {
    "ConsentContext": {
      "description": "Privacy consent signals that travel with a deal (flagged decision FD-10).\n\nFull build-out (EP-10.4) of the EP-1.2 placeholder: the three\ninteroperable consent-string carriers \u2014 GPP (Global Privacy Platform)\nwith its applicable section ids, TCF (Transparency & Consent Framework)\nwith the ``gdpr_applies`` gate, and the US Privacy (``us_privacy``)\nstring \u2014 plus the SGP (SafeGuard Privacy / IAB Diligence Platform)\n``diligence_status``. Field names from the EP-1.2 placeholder are kept\nunchanged for backward compatibility; the build-out is purely additive.\nIt travels with the Deal, Quote, and Order. Strings are carried opaque:\nno decoding/vendor-list validation is claimed (see the conformance\nstandards registry).",
      "properties": {
        "applicable_regimes": {
          "description": "Privacy regime identifiers in scope (e.g. 'GDPR', 'CCPA').",
          "items": {
            "type": "string"
          },
          "title": "Applicable Regimes",
          "type": "array"
        },
        "diligence_status": {
          "$ref": "#/$defs/DiligenceStatus",
          "default": "unknown",
          "description": "Counterparty diligence status (SGP = SafeGuard Privacy / IAB Diligence Platform)."
        },
        "gdpr_applies": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Whether GDPR (EU General Data Protection Regulation) applies to this context; None when undetermined. Gates interpretation of the TCF string.",
          "title": "Gdpr Applies"
        },
        "gpp_section_ids": {
          "description": "GPP section ids present in the string.",
          "items": {
            "type": "integer"
          },
          "title": "Gpp Section Ids",
          "type": "array"
        },
        "gpp_string": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "GPP (Global Privacy Platform) consent string.",
          "title": "Gpp String"
        },
        "tcf_string": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "TCF (Transparency & Consent Framework) TC string, when GDPR applies.",
          "title": "Tcf String"
        },
        "us_privacy": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "US Privacy (CCPA) string, e.g. '1YNN'; superseded by GPP where present.",
          "title": "Us Privacy"
        },
        "verified_at": {
          "anyOf": [
            {
              "format": "date-time",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Timezone-aware timestamp of the last diligence verification, if any.",
          "title": "Verified At"
        }
      },
      "title": "ConsentContext",
      "type": "object"
    },
    "DiligenceStatus": {
      "description": "Status of counterparty privacy diligence (IAB Diligence Platform).",
      "enum": [
        "unknown",
        "pending",
        "passed",
        "failed"
      ],
      "title": "DiligenceStatus",
      "type": "string"
    },
    "Money": {
      "description": "Exact money amount in integer micros (flagged decision FD-11).\n\n``1_000_000`` micros = 1 currency unit \u2014 the ad-industry convention\n(Google Ad Manager, among others, prices in micros). Float is BANNED on\nthe wire for money: IEEE 754 floating point is non-deterministic for\nmoney math (``0.1 + 0.2 != 0.3``, and repeated CPM \u2014 cost per mille \u2014\narithmetic accumulates error), and the two source repos used ``float``\nend-to-end; that defect must not be fossilized into the spec. Every\nprice, rate, budget, and offer in the shared contract is a ``Money``.\n\n``amount_micros`` is a strict integer: float inputs are rejected at\nvalidation time rather than silently truncated.",
      "properties": {
        "amount_micros": {
          "description": "Amount in micros; 1,000,000 micros = 1 currency unit.",
          "title": "Amount Micros",
          "type": "integer"
        },
        "currency": {
          "default": "USD",
          "description": "ISO 4217 alpha-3 currency code.",
          "pattern": "^[A-Z]{3}$",
          "title": "Currency",
          "type": "string"
        }
      },
      "required": [
        "amount_micros"
      ],
      "title": "Money",
      "type": "object"
    },
    "OrderStatus": {
      "description": "ONE order status vocabulary.\n\nAdopts the seller's unified ``order_state_machine.OrderStatus`` (which\nalready merged the seller's workflow and ad-server vocabularies).\n\nRecorded aliases (retired values, NOT valid on the wire): buyer\nOpenDirect ``PENDING`` -> ``pending_approval``; ``APPROVED``/``REJECTED``\n(uppercase) -> lowercase; seller ``ExecutionOrderStatus.proposed`` ->\n``submitted``; ``canceled`` -> ``cancelled``. The seller-internal\n``syncing`` ad-server state is dropped from the wire vocabulary.",
      "enum": [
        "draft",
        "submitted",
        "pending_approval",
        "approved",
        "rejected",
        "in_progress",
        "booked",
        "unbooked",
        "completed",
        "failed",
        "cancelled"
      ],
      "title": "OrderStatus",
      "type": "string"
    }
  },
  "description": "Campaign container (insertion order) holding one or more lines.\n\nMerges the buyer's OpenDirect ``Order`` with the seller's\n``ExecutionOrder``. Per flagged decision FD-8, the seller's record is\nauthoritative for order/fulfillment state.\n\nID minting: ``order_id`` is seller-issued (created via the seller's\nAPI on buyer request).",
  "properties": {
    "account_id": {
      "description": "Seller-issued account identifier.",
      "title": "Account Id",
      "type": "string"
    },
    "budget": {
      "$ref": "#/$defs/Money",
      "description": "Estimated budget (exact micros; FD-11)."
    },
    "consent_context": {
      "anyOf": [
        {
          "$ref": "#/$defs/ConsentContext"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Privacy consent signals riding with the order (FD-10)."
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "deal_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Deal this order fulfils, if deal-led.",
      "title": "Deal Id"
    },
    "end_date": {
      "format": "date",
      "title": "End Date",
      "type": "string"
    },
    "ext": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Ext"
    },
    "external_ids": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Ad-server order references (e.g. GAM order id).",
      "title": "External Ids"
    },
    "name": {
      "maxLength": 200,
      "title": "Name",
      "type": "string"
    },
    "order_id": {
      "description": "Seller-issued order identifier.",
      "title": "Order Id",
      "type": "string"
    },
    "proposal_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Proposal this order materializes, if any.",
      "title": "Proposal Id"
    },
    "start_date": {
      "format": "date",
      "title": "Start Date",
      "type": "string"
    },
    "status": {
      "$ref": "#/$defs/OrderStatus",
      "default": "draft"
    },
    "updated_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Updated At"
    }
  },
  "required": [
    "order_id",
    "account_id",
    "name",
    "budget",
    "start_date",
    "end_date"
  ],
  "title": "Order",
  "type": "object"
}

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/iab-tech-lab-agentic-primitive-order"
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.