PartnerPurchaseNeed

A purchase need (procurement demand) represents a buyer's request for a specific product quantity to be delivered to a location within a date range.

Each purchase need is a flat record—one record per product demand. The code field is used for idempotency: resubmitting the same code will update the existing record rather than create a duplicate.

code
Type: string
max length:
256
required

Unique identifier for the purchase need in the partner's system. Used as the idempotency key: submitting a record with the same code will update the existing record rather than create a duplicate.
end_date
Type: stringFormat: date
required

End of the delivery window (ISO 8601)
external_status
Type: string
max length:
32
required

Fulfillment status of the purchase need in the partner's system. Free-form string—interpretation is partner-specific.
quantity
Type: numberFormat: double
required

Requested quantity. The unit of measure is specified by quantity_unit. Accepts both integers and decimals; integers are cast to double internally.
quantity_unit
Type: stringenum
required

Unit of measure for the quantity.

values
boxpalletkgpieceunknown
reference_code
Type: string
max length:
256
required

Standard product identifier in the partner's system. Can be an internal code, EAN, SKU, or any product reference agreed upon during integration setup.
start_date
Type: stringFormat: date
required

Start of the delivery window (ISO 8601)
created_at
Type: stringFormat: date-time
read-only

Timestamp when the purchase need was created in Consentio (read-only)
delivery_address_code
Type: string
max length:
20

Code identifying the delivery address or distribution depot
id
Type: integerFormat: uint
read-only

Consentio internal ID (read-only, assigned on creation)
logistics_unit_code
Type: string
max length:
20

Partner's code identifying the logistics unit type (e.g., pallet type, crate type, packaging format).
metadata
Type: object

Partner-specific metadata fields. Free-form key-value pairs— interpretation depends on the integration context.

Properties: 1
storage_location_code
Type: string
max length:
20

Identifier for the delivery/storage location (e.g., warehouse code, ripening facility code). Interpretation is partner-specific.
tender_kind
Type: stringenum

Type of tender/offer associated with this purchase need.

values
standardpromotionregional_promotionweekend_flash_offerpromotion_radiopromotion_leaflet
updated_at
Type: stringFormat: date-time
read-only

Timestamp when the purchase need was last updated in Consentio (read-only)

PartnerPurchaseNeedsBulkRequest

PartnerPurchaseNeedsBulkResponse