PartnerReference

A reference represents one article in the buyer's master data. On the wire, a single object groups all of its logistics units under logistics_units[]. Server-side, each logistics unit becomes its own row keyed by <code>-<logistics-unit code> (the stored buyer_tag).

Idempotent per row: resubmitting the same (code, logistics-unit code) updates the existing row.

  • EAV attributes attached to the reference. Numeric values may be sent as either string or number; the server accepts both.

    Properties: 2
  • Partner's unique identifier for the outer reference. Composed with each logistics-unit code into buyer_tag = "<code>-<lu code>".

  • Reference display name

  • The reference's category hierarchy as an ordered array, root → leaf. The server uses array position to determine each entry's hierarchy level.

    For ITM/FFL: 4 entries — CODE FILIERE ACHAT, NUMERO DE FAMILLE INTERNE, IDENTIFIANT SOUS FAMILLE PRODUIT, CODE PRODUIT GENERIQUE (the leaf). Each entry is resolved against product_kind.external_id within the target workspace; the reference is linked to the leaf.

    Properties: 2
  • Optional RFC 3339 timestamp, per-row soft-delete signal. Applies only to the (code, logistics-unit) rows in this request. Stored as-is; the row reads as inactive once the timestamp has passed (no background job, the check is applied at read time). Past-dated → immediately reads as inactive. Omitting the field clears any previously stored value.

  • Free-text description. Always a string, empty ("") when no value, never null.

  • To ignore. Reserved for partner traceability.

  • All logistics units for this outer reference. One entry per logistics unit. Each entry produces its own storage row. Absent / empty array means no logistics-unit-level mutation for this code (rows already in the DB are left untouched).

    Properties: 6
  • Partner-specific traceability payload. Stored as-is; Consentio does not interpret values. The object is open; partners may send whatever keys are relevant.

    Properties: 1
  • Whether the reference is organic-certified

  • On create: defaults to inactive; any value other than "active" results in inactive. On update: set to the value provided; if omitted, the existing value is left unchanged.