PartnerReference

A reference represents one article in the buyer's master data. All logistics units for that code are grouped under logistics_units[].

Matched by code for idempotency: resubmitting the same code updates the existing reference and its nested collections.

code
Type: string
max length:
256
required

Unique partner identifier; idempotency key.
name
Type: string
max length:
256
required

Reference display name.
product_kinds
Type: array object[] · PartnerReferenceProductKind[] 1…
required

The reference's category hierarchy as an ordered array, root → leaf. Each entry is resolved against product_kind.external_id within the target workspace; the reference is linked to the leaf node. The order is part of the contract and must always be the same.
- code
  Type: string
  required
  
  Partner category code at this hierarchy level. Free string — no padding enforced. Examples: "22", "0213", "795". Resolved against product_kind.external_id within the target workspace.
- name
  Type: string
  required
  
  Human-readable label for the category level.
attributes
Type: array object[] · PartnerReferenceAttribute[]

EAV attributes attached to the reference.
- attribute
  Type: string
  required
  
  Attribute key (e.g. origin, size, vat_rate).
- value
  required
  
  Attribute value. May be sent as either string ("5.5") or number (5.5); the server accepts both. The list of attribute keys is open; partners send whatever is relevant for their integration.
  
  Type: string
  
  Attribute value. May be sent as either string ("5.5") or number (5.5); the server accepts both. The list of attribute keys is open; partners send whatever is relevant for their integration.
deleted_at
Type: string | null Format: date-time
Optional RFC 3339 timestamp, a per-row soft-delete signal. Applies only to the (code, logistics-unit) rows in this request. Once the timestamp has passed, the row is treated as inactive.
- Past-dated values are immediately effective (the row reads as inactive on the next call).
- Future values keep the row active until the timestamp passes.
- Omitting the field on a later POST clears any previously stored value.
description
Type: string

Free-text description. Always a string, empty ("") when no value, never null.
logistics_units
Type: array object[] · PartnerReferenceLogisticsUnit[]

All logistics units for this reference. One entry per logistics unit. At least one logistics unit is expected for sellable references.
One logistics unit. Server-side, each entry produces its own references row keyed by <outer reference.code>-<code> (joined with a -), plus a reference_box_types junction row resolving box_type_code against the shared box_types dictionary.
- code
  Type: string
  max length:
  32
  required
  
  Partner logistics-unit code (scoped to this reference, e.g. 01).
- net_weight
  required
  
  Net weight of the logistics unit in kg. Accepts string ("4.20") or number (4.20).
  
  Type: string
  
  Net weight of the logistics unit in kg. Accepts string ("4.20") or number (4.20).
- pieces_per_unit
  required
  
  Number of consumer units per logistics unit. Accepts string ("12") or integer (12).
  
  Type: string
  
  Number of consumer units per logistics unit. Accepts string ("12") or integer (12).
- box_type_code
  Type: string
  max length:
  32
  
  Short code for the physical box type (e.g. CRT, COL, 2PL). Resolved against box_types.external_code; auto-created if unknown. Optional — omit when the logistics unit has no physical container.
- units_per_pallet
  
  Average number of logistics units per pallet. Accepts string ("144") or integer (144).
  
  Type: string
  
  Average number of logistics units per pallet. Accepts string ("144") or integer (144).
metadata
Type: object

Partner-specific traceability payload. Stored as-is by Consentio. Open-ended object; partners send whatever keys are relevant.
- propertyName
  Type: anything
organic
Type: boolean

Whether the reference is organic-certified.
status
Type: string enum

On create: defaults to inactive, any value other than active results in inactive. On update: set to the value provided (active/inactive); if omitted, left unchanged. inactive is a soft delete (the row is kept but hidden from active results).
values
- active
- inactive