CarbonLookup

Carbon envelope (LIQ-1032). Default GET serves stored canonical carbon. force_refresh=true acquires via the engine and persists. Default GET .../carbon (no categories query) returns buyer cat2/cat5 and OEM cat11/cat12 slices.

  • asset_id
    Type: string
    required
  • categories
    Type: array of CarbonCatSlice
    required
    Properties: 8
  • identifier
    Type: string
    required
  • lane
    Type: string | null
    required

    Resolve lane (carbon for this API).

  • schema_version
    Type: string
    required

    Contractual provenance schema (liq-1056-2).

  • as_of
    Type: string | nullFormat: date-time

    Contractual as-of instant (usually provenance retrieved_at).

  • assurance_markers
    Type: array of string | null

    Assurance markers on the winning source (e.g. EY_AUDIT).

  • cache_hit
    Type: boolean | null

    true when the default GET served stored canonical carbon.

  • downgraded_from
    Type: object | null
    Properties: 2
  • grounding
    Type: string | null

    How the value is grounded (e.g. ASSURED).

  • iq_level
    Type: string | null

    IQ on the stored (or just-acquired) canonical carbon document.

  • listing_id
    Type: string | null

    OrgListingSubscription listing that fronts the winning source (IQ1 included).

  • listing_slug
    Type: string | null

    Catalog slug of the held listing.

  • message
    Type: string | null

    Partner-visible hint (e.g. how to acquire when NOT_ENRICHED).

  • no_match_reason
    Type: string | null

    NOT_ENRICHED when default GET finds no stored carbon (pass force_refresh=true to acquire). After acquire, engine NO_PRODUCT_MATCH (or other contractual reasons) when the subscribed sources have no value.

  • numeric_score
    Type: number | null
  • retrieved_at
    Type: string | nullFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • source_slug
    Type: string | null

    Winning source slug from the stored document (not hardcoded).

  • vendor_raw

    Present when vendor_raw=true. Either the winning licensed-source observation (or this request’s live e.product value.raw when no row is stored), or source/payload null with a message when none exists. Omitted when the query flag is false. Error bodies never include this field or vendor names.

    Present when vendor_raw=true. Either the winning licensed-source observation (or this request’s live e.product value.raw when no row is stored), or source/payload null with a message when none exists. Omitted when the query flag is false. Error bodies never include this field or vendor names.

    • domain
      Type: string
      required
    • payload
      Type: object
      required

      Vendor-shaped JSON stored on AssetSourceObservation.

      Properties: 1
    • retrieved_at
      Type: stringFormat: date-time
      required

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • source
      Type: string
      required

      SourceRegistration slug (e.g. rejoose).