These docs are for v2024.1. Click to read the latest docs for v2025.1.

Model, enums and routes changes

Here you can find an overview of all model, enums and route changes.

Legend

Icon

Description

🚫

The property or model has been removed

🔤

The property or model has been renamed

✏️

The attribute such as maximum length or required vs optional has been changed

🆕

The property has been newly added to the model


Route changes

DeliveryOrders

HTTP         

OperationId

Description

🚫

POST

AddFulfillmentRequest

Removed with route

/delivery-orders/{deliveryOrderId}/auction/fulfillment-requests

🔤

POST

AddDeliveryOrderAuction

Renamed endpoint into

AddClockDeliveryOrder

🔤

DELETE

DeleteDeliveryOrderAuction

Renamed endpoint into

DeleteClockDeliveryOrder



PlantPassports 🆕

HTTP      

OperationId

Description

🆕

POST

GetPlantPassportPdf

Added with route

/plant-passports

🆕

GET

GetPlantPassportPdfBySalesChannelOrderId

Added with route

/plant-passports/by-sales-channel-order-id/{salesChannelOrderId}

🆕

GET

GetPlantPassportPdfBySalesOrderId

Added with route

/plant-passports/by-sales-order-id/{salesOrderId}



TradeSettings 🆕

HTTP    

OperationId

Description

🆕

GET

GetCustomerTradeSettingsByOrganizationId

Added with route

/trade-settings/customer/by-id/{customerOrganizationId}

🆕

GET

GetCustomerTradeSettingsMaxSequence

Added with route

/trade-settings/customer/max-sequence

🆕

GET

GetCustomerTradeSettingsBySequenceNumber

Added with route

/trade-settings/customer/sync/{sequenceNumber}

🆕

GET

GetSupplierTradeSettingFromOrganization

Added with route

/trade-settings/supplier/current-organization



Enum changes


AuctionLocation

Description

Value

🔤

Renamed enum value into

DIGITAL

NURSERY



Model changes


AddClockSalesFromNurserySupplyLine

Description

Property

✏️

Changed

[Range]

to 1-999

vbnPackageCode



AddContract

Description

Property

✏️

Set a minimum length of 1

title

✏️

Set a minimum length of 1

description

🆕

Added new property

subSupplierOrganizationIds

🆕

Added new property

allowTradeItemVariants

🆕

Added new property

delivery

✏️

Set a minimum length of 1

contractLines

🔤

Renamed property into

startDateTime

startDate

🔤

Renamed property into

endDateTime

endDate

🚫

Removed property and moved to

delivery

deliveryConditionId

🚫

Removed property and moved to

delivery

defaultDeliveryLocationGln

🚫

Removed property and moved to

delivery

despatchWarehouseId

🚫

Removed property and moved to

delivery

nextLegIdentifier

🚫

Removed property and moved to

delivery

defaultIncoterm



ClockPresalesSupplyLine

Description

Property

🆕

Added property

auctionDate

✏️

Changed from nullable to non-nullable

creationDateTime

🆕

Added property

deliveryNotecode

🆕

Added property

deliveryNoteLetter

✏️

Changed from nullable to non-nullable

deliveryNoteReference

🆕

Added property

initialAuctionLocation

🚫

Removed property

packingConfigurations

🆕

Added property

packingConfiguration

🆕

Added property

photoUrl

🆕

Added property

tradeItemVersion

🚫

Removed property

tradingTerms


ClockSupplyLinePackingConfiguration

Description

Property

🚫

Removed property

additionalPricePerPiece

🚫

Removed property

allowedCustomerOrganizationIds

✏️

Changed from nullable to non-nullable

layersPerLoadCarrier

✏️

Changed from nullable to non-nullable

packagesPerLayer

🚫

Removed property

photoUrl

🚫

Removed property

transportHeightInCm


Contract

Description

Property

✏️

Changed to model

ContractVersion

and moved as

versionNumber

version

🚫

Removed property and moved to

version

as

reasonForVersionUpdate

versionDescription

✏️

Changed to model

ContractStatus

and moved as

approvalStatus

status

🚫

Removed property and moved to

status

as

approvedOnDateTime

dateOfApproval

🚫

Removed property and moved to

status

declineDescription

🚫

Removed property and moved to

status

isDeleted

🚫

Removed property and moved to

status

as

isDeleteRequestedBySupplier

deleteRequestedBy

🚫

Removed property

initiatedBy

🆕

Added new property

IsInitiatedBySupplier

✏️

Set a minimum length of 1

contractLines

🔤

Renamed property into

startDateTime

startDate

🔤

Renamed property into

endDateTime

endDate

🆕

Added new property

delivery

🚫

Removed property and moved to

delivery

as

deliveryConditionId

deliveryConditionSetId

🚫

Removed property and moved to

delivery

defaultDeliveryLocationGln

🚫

Removed property and moved to

delivery

despatchWarehouseId

🚫

Removed property and moved to

delivery

nextLegIdentifier

🚫

Removed property and moved to

delivery

defaultIncoterm

🆕

Added new property

allowTradeItemVariants

✏️

Changed from optional to required

reference

✏️

Changed from optional to required

creationDateTime



ContractDelivery 🆕

Description

Property

🆕

Added new property

deliveryConditionId

🆕

Added new property

defaultDeliveryLocationGln

🆕

Added new property

despatchWarehouseId

🆕

Added new property

defaultIncoterm

🆕

Added new property

nextLegIdentifier



ContractLine

Description

Property

🚫

Removed property

contractLineTradeItems

🆕

Added new property

tradeItem

🔤

Renamed property into

periods

contractLinePeriods

🚫

Removed property

additionalServiceIds

🆕

Added new property

additionalServices



ContractLineAdditionalService 🆕

Description

Property

🆕

Added new property

additionalServiceId

🆕

Added new property

isOptional



ContractLinePeriod

Description

Property

🔤

Renamed property into

startDateTime

startDate

🔤

Renamed property into

endDateTime

endDate

🚫

Removed property

lowerMarginPricePerPiece

🚫

Removed property

upperMarginPricePerPiece

🚫

Removed property

lowerMarginNumberOfPiecesPercentage

🚫

Removed property

upperMarginNumberOfPiecesPercentage

🆕

Added new property

pricePerPieceMargin

🆕

Added new property

numberOfPiecesMargin



ContractLinePeriodBandwidthNumberOfPieces 🆕

Description

Property

🆕

Added new property

lowerMarginNumberOfPieces

🆕

Added new property

upperMarginNumberOfPieces

🆕

Added new property

lowerMarginPercentage

🆕

Added new property

upperMarginPercentage



ContractLinePeriodBandwidthPricePerPiece 🆕

Description

Property

🆕

Added new property

lowerMarginPricePerPiece

🆕

Added new property

upperMarginPricePerPiece

🆕

Added new property

lowerMarginPercentage

🆕

Added new property

upperMarginPercentage



ContractLineTradeItem

Description

Property

🚫

Removed property

isPrimary

✏️

Changed to model

PackingConfigurationBase

packingConfiguration

🆕

Added new property

contractLineTradeItemGroupId



ContractPackingConfiguration

Description

Property

✏️

Changed

[Range]

to 1-999

vbnPackageCode



ContractStatus 🆕

Description

Property

🆕

Added new property

approvalStatus

🆕

Added new property

approvedOnDateTime

🆕

Added new property

declineDescription

🆕

Added new property

isDeleteRequestedBySupplier

🆕

Added new property

isDeleted



ContractVersion

Description

Property

🆕

Added new property

versionNumber

🆕

Added new property

isLatestApprovedVersion

🆕

Added new property

reasonForVersionUpdate



CustomPackage

Description

Property

✏️

Changed

[Range]

to 1-999

vbnPackageCode



CustomerTradeSettings 🆕

Description

Property

🆕

Added property

CustomerOrganizationId

🆕

Added property

acceptsDirectOrders

🆕

Added property

automaticallyAcceptsCorrectionRequestsOnDirectOrders

🆕

Added property

automaticallyAcceptsCorrectionRequestsOnSupplyOrders

🆕

Added property

allowSuppliersToManageSelectedTradeItemAssortment

🆕

Added property

acceptsSupplyOfTypePurchaseTip

🆕

Added property

usesContracts

🆕

Added property

acceptsTransportCost

🆕

Added property

sequenceNumber


DeliveryOrderAuction

Description

Property

🔤

Renamed property into

batchFulfillmentRequests

fulfillmentRequests

🆕

Added property

tradeItemFulfillmentRequests



ContractTradeItemGroup 🆕

Description

Property

🆕

Added property

contractTradeItemGroupId

🆕

Added property

SupplierOrganizationId

🆕

Added property

Name

🆕

Added property

tradeItems

🆕

Added property

creationDateTime

🆕

Added property

lastModifiedDateTime

🆕

Added property

isDeleted

🆕

Added property

sequenceNumber



ContractTradeItemGroupTradeItem 🆕

Description

Property

🆕

Added property

tradeItemId

🆕

Added property

isPrimary

🆕

Added property

packingConfiguration

🆕

Added property

isDeleted



EditContract

Description

Property

✏️

Set a minimum length of 1

title

✏️

Set a minimum length of 1

description

🆕

Added new property

subSupplierOrganizationIds

🆕

Added new property

allowTradeItemVariants

🆕

Added new property

delivery

✏️

Set a minimum length of 1

contractLines

🔤

Renamed property into

startDateTime

startDate

🔤

Renamed property into

endDateTime

endDate

🚫

Removed property and moved to

delivery

deliveryConditionId

🚫

Removed property and moved to

delivery

defaultDeliveryLocationGln

🚫

Removed property and moved to

delivery

despatchWarehouseId

🚫

Removed property and moved to

delivery

nextLegIdentifier

🚫

Removed property and moved to

delivery

defaultIncoterm

🚫

Removed property

customerOrganizationId



EditContractDelivery 🆕

Description

Property

🆕

Added property

deliveryConditionId

🆕

Added property

defaultDeliveryLocationGln

🆕

Added property

despatchWarehouseId

🆕

Added property

defaultIncoterm

🆕

Added property

nextLegIdentifier



EditContractLine

Description

Property

🔤

Renamed property into

tradeItem

contractLineTradeItem

🔤

Renamed property into

periods

contractLinePeriods

🔤

Renamed property into

additionalServices

contractLineAdditionalServices

🆕

Added property

tradeItemGroup

✏️

Changed from required to optional

tradeItem



EditContractLinePeriod

Description

Property

🔤

Renamed property into

startDateTime

startDate

🔤

Renamed property into

endDateTime

endDate

✏️

Changed from optional to required and as type decimal

pricePerPiece

🚫

Removed property

lowerMarginPricePerPiece

🚫

Removed property

upperMarginPricePerPiece

🚫

Removed property

lowerMarginNumberOfPiecesPercentage

🚫

Removed property

upperMarginNumberOfPiecesPercentage

🆕

Added new property

pricePerPieceMargin

🆕

Added new property

numberOfPiecesMargin

✏️

Changed from optional to required

numberOfPieces



EditContractLinePeriodBandwidthNumberOfPieces 🆕

Description

Property

🆕

Added new property

lowerMarginNumberOfPieces

🆕

Added new property

upperMarginNumberOfPieces

🆕

Added new property

lowerMarginPercentage

🆕

Added new property

upperMarginPercentage



EditContractLinePeriodBandwidthPricePerPiece 🆕

Description

Property

🆕

Added new property

lowerMarginPricePerPiece

🆕

Added new property

upperMarginPricePerPiece

🆕

Added new property

lowerMarginPercentage

🆕

Added new property

upperMarginPercentage



EditContractLineTradeItem

Description

Property

✏️

Changed to model

EditContractPackingConfiguration

packingConfiguration

🚫

Removed property

tradeItemVersion



EditContractLineTradeItemGroup 🆕


Description

Property

🆕

Added new property

contractLineTradeItemId

🆕

Added new property

contractTradeItemGroupId



EditContractPackingConfiguration 🆕

Description

Property

🆕

Added new property

piecesPerPackage

🆕

Added new property

vbnPackageCode

🆕

Added new property

customPackageId

🆕

Added new property

packagesPerLayer

🆕

Added new property

layersPerLoadCarrier

🆕

Added new property

loadCarrier

🆕

Added new property

photoUrl



FulfillmentRequestCreateAuction

Description

Property

🆕

Added property

auctionRemark

🆕

Added property

deliveryRemark

🆕

Added property

imageUrl

🚫

Removed property

remarks

🚫

Removed property

piecesPerPackage



FulfillmentRequestCreateAuctionTradeItem 🆕

Description

Property

🆕

Added property

auctionRemark

🆕

Added property

deliveryRemark

🆕

Added property

clockMinimumPrice

🆕

Added property

clockPreSalesPrice

🆕

Added property

fulfillmentRequestId

🆕

Added property

imageUrl

🆕

Added property

newBatchId

🆕

Added property

numberOfPackages

🆕

Added property

packingAgentOrganizationId

🆕

Added property

packingConfiguration

🆕

Added property

serviceCode

🆕

Added property

tradeItemId



InvoiceLine

Description

Property

🆕

Added property

invoiceLineId

🆕

Added property

numberOfPieces

🆕

Added property

salesChannelOrderId



OrderRequest

Description

Property

🆕

Added property

isDeleted



Package

Description

Property

✏️

Changed

[Range]

to 1-999

vbnPackageCode



PackingConfigurationBase

Description

Property

✏️

Changed

[Range]

to 1-999

vbnPackageCode



SalesOrder

Description

Property

✏️

Changed from nullable to non-nullable

salesChannelOrderId

✏️

Changed from nullable to non-nullable

status

✏️

Changed from nullable to non-nullable

paymentProvider

✏️

Changed from nullable to non-nullable

createdBySupplier

✏️

Changed from nullable to non-nullable

calculatedFields



SalesOrderMutables

Description

Property

✏️

Changed

[Range]

to 1-999

vbnPackageCode



SupplierTradeSettings 🆕

Description

Property

🆕

Added property

supplierOrganizationId

🆕

Added property

automaticallyAcceptsCorrectionRequests

🆕

Added property

usesCancellationGracePeriodOfMinimumQuantityIsNotMet

🆕

Added property

usesContract

🆕

Added property

usesCustomerStickers

🆕

Added property

acceptsOrderRequests

🆕

Added property

acceptsSupplyRequests

🆕

Added property

acceptsTradeItemRequests

🆕

Added property

acceptsPackingConfigurationRequests



SupplyLine

Description

Property

🆕

Added property

pricePerPieceLastModified

🚫

Removed property

tradingTerms



TradeSetting 🆕

Description

Property

🆕

Added property

isActive

🆕

Added property

exemptedOrganizationIds

🆕

Added property

lastModified


WeeklyBaseSupplyPriceGroupPrice

Description

Property

🆕

Added property

pricePerPieceLastModified