SupplyChainNode.hp

Whether this node takes part in the flow of payment: 1 means the system in asi pays the seller in sid, who in turn pays the previous node. Under SupplyChain 1.0 it should always be 1.

CurrentintegerOptionalSince 2.6-202204

Field facts

Path: source.schain.nodes.hp
Object: SupplyChainNode
Type: integer
Requirement: Optional
Added: OpenRTB 2.6-202204
Spec section: 3.2.26

How it is used

The OpenRTB 2.6 table lists hp without marking it required, but the standalone SupplyChain 1.0 specification requires it, and every system that forwards a chain is expected to pass the value on. A 1.1 draft allows 0 for systems that handle the request without being paid, so buyers who count paid hops should filter on hp first.

Example

Where the field sits in a payload, with everything else left out:

{
  "id": "req-1",
  "source": {
    "schain": {
      "nodes": [
        {
          "hp": 1
        }
      ]
    }
  }
}

Common mistakes

Omitting hp on nodes you append or forward. Strict parsers reject the node, and the validator warns (openrtb.schain.node.hp_missing).
Setting 0 under version 1.0 to describe a passthrough system. The validator warns because 1.0 expects 1 on every node.

Version history

Added in OpenRTB 2.6-202204, and present in the latest snapshot. The table shows how each version's spec text types the field.

Versions	Type in the spec	Required	Deprecated
2.6-202204	Added in the first 2.6 release, published without a structured text archive; the 2.6-202210 republication is the first tagged text.
2.6-202210 to 2.6-202606	integer	No	No

Related fields

Other SupplyChainNode fields

For a walkthrough of the whole object, read Supply chain (schain).