These docs are for v2023.2. Click to read the latest docs for v2024.2.

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

CatalogPrices

HTTP	OperationId	Description
🆕 PUT	EditWeeklyBaseSupplyLines	Added with route `/trade-items/base-supply/{year}/{week}`
✏️ GET	GetWeeklyBaseSupplies	Changed the rate/burst limit to: Rate limit: `1 per second` , Burst limit: `20`

PriceGroups 🆕

HTTP	OperationId	Description
🆕 GET	GetPriceGroupById	Added with route `/price-groups/{priceGroupId}`
🆕 GET	GetPriceGroupsBySequenceNumber	Added with route `/price-groups/sync/{sequenceNumber}`
🆕 GET	GetPriceGroupsMaxSequence	Added with route `/price-groups/current-max-sequence`

SalesOrders

HTTP	OperationId	Description
🆕 PATCH	SetSalesOrderCancelled	Added with route `/sales-orders/{salesOrderId}/cancel`
🆕 PATCH	SetSalesOrderCommitted	Added with route `/sales-orders/{salesOrderId}/commit`

Enum changes

AdditionalServiceUnit

Description	Value
🆕 Added enum value	LABEL

FulfillmentType 🆕

Description	Value
🆕 Added enum value	UNKNOWN
🆕 Added enum value	CLOCK
🆕 Added enum value	DIRECT_SALES
🆕 Added enum value	GOODS_MOVEMENT

Incoterm

Description	Value
🆕 Added enum value	CPT
🆕 Added enum value	CIP
🆕 Added enum value	DPU
🆕 Added enum value	FAS
🆕 Added enum value	CFR
🆕 Added enum value	CIF

PriceGroupType 🆕

Description	Value
🆕 Added enum value	CALCULATED
🆕 Added enum value	MANUAL

Model changes

AddBatchPackingConfiguration

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

AddFulfillmentOrderCorrection 🆕

Added a copy of FulfillmentOrderCorrection without the unused properties

Description	Property
🚫 Removed unused property	`status`
🚫 Removed unused property	`errors`
🚫 Removed unused property	`creationDateTime`
🚫 Removed unused property	`lastModifiedDateTime`

AddLoadCarrierConfiguration

Description	Property
🔤 Renamed property into `sortIndex`	`sequenceNumber`
✏️ Added a minimum length of 1 item	`loadCarrierItems`

AddLoadCarrierCorrection 🆕

Added a copy of LoadCarrierCorrection with changed properties

Description	Property
🔤 Renamed property into `documentReference`	`logisticLabelCode`

AddLoadCarrierItem

Description	Property
🚫 Removed obsolete property	`batchId`
🚫 Removed obsolete property	`tradeItemId`
🚫 Removed obsolete property	`batchReference`
🚫 Removed obsolete property	`logisticLabelCode`
🔤 Renamed property into `sortIndex`	`itemPosition`
🔤 Renamed property into `deliveryRemarks`	`deliveryRemark`
✏️ Changed from required to optional	`deliveryRemark`
✏️ Added minimum length of 1 character	`deliveryRemark`
🆕 Added property	`commercialInvoiceReference`

AddLoadCarrierItemCorrection 🆕

Added a copy of LoadCarrierItemCorrection with changed properties

Description	Property
🔤 Renamed property into `deliveryNoteLetter`	`sequenceCharacter`
🆕 Added property	`deliveryNoteCode`

BatchPackingConfiguration

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

ClockSupplyLinePackingConfiguration

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

CustomerSticker

Description	Property
🚫 Removed obsolete property	`additionalServiceId`
🆕 Added new property	`compositions`

CustomerStickerComposition 🆕

Description	Property
🆕 Added property	`stickerType`
🆕 Added property	`numberOfUnits`

EditWeeklyBaseSupplyLines 🆕

Description	Property
🆕 Added property	`tradeItemId`
🆕 Added property	`numberOfPieces`
🆕 Added property	`basePricePerPiece`
🆕 Added property	`manualPriceGroupPrices`

EditWeeklyBaseSupplyManualPriceGroupPrice 🆕

Description	Property
🆕 Added property	`priceGroupId`
🆕 Added property	`manualPricePerPiece`

FulfillmentOrder

Description	Property
🔤 Renamed property into `submissionError`	`submissionErrors`
🔤 Renamed property into `deliveryNoteCodes`	`logisticLabelCodes`
✏️ Changed from type FulfillmentOrderSubmissionErrors to `string`	`submissionErrors`
✏️ Changed from optional to required	`creationDateTime`
✏️ Changed from optional to required	`lastModifiedDateTime`
🆕 Added enum	`fulfillmentType`
🆕 Added property	`oneLabelOnly`

FulfillmentOrderCorrection

Description	Property
🚫 Removed obsolete property	`errors`
✏️ Changed from optional to required	`creationDateTime`
✏️ Changed from optional to required	`lastModifiedDateTime`

FulfillmentOrderCreate

Description	Property
✏️ Added a minimum length of 13 characters	`deliveryLocationGln`
🆕 Added property	`oneLabelOnly`

FulfillmentOrderInbound

Description	Property
🔤 Renamed property into `deliveryNoteCodes`	`logisticLabelCodes`
🆕 Added property	`carrierOrganizationId`
🆕 Added property	`creationDateTime`
🆕 Added property	`lastModifiedDateTime`

FulfillmentOrderStatus

Description	Property
🔤 Renamed property into `submissionError`	`submissionErrors`
✏️ Changed from type FulfillmentOrderSubmissionErrors to `string`	`submissionErrors`
✏️ Changed from optional to required	`status`

FulfillmentRequest

Description	Property
🆕 Added property	`clockMinimumPrice`

LoadCarrierConfiguration

Description	Property
🔤 Renamed property into `sortIndex`	`sequenceNumber`
🆕 Added property	`documentReference`
🆕 Added property	`deliveryNoteCodes`
🆕 Added property	`isReceived`
🆕 Added property	`receiptDateTime`

LoadCarrierConfigurationInbound

Description	Property
🔤 Renamed property into `sortIndex`	`sequenceNumber`
🆕 Added property	`documentReference`
🆕 Added property	`deliveryNoteCodes`

LoadCarrierCorrection

Description	Property
🔤 Renamed property into `documentReference`	`logisticLabelCode`

LoadCarrierItem

Description	Property
🔤 Renamed property into `deliveryRemarks`	`deliveryRemark`
🔤 Renamed property into `deliveryNoteCode`	`logisticLabelCode`
🔤 Renamed property into `deliveryNoteLetter`	`itemPosition`
✏️ Changed from optional to required	`batchId`
✏️ Changed from optional to required	`tradeItemId`
🆕 Added property	`commercialInvoiceReference`
🆕 Added property	`sortIndex`

LoadCarrierItemCorrection

Description	Property
🔤 Renamed property into `deliveryNoteLetter`	`sequenceCharacter`
✏️ Changed from optional to required	`numberOfPackages`
🆕 Added property	`deliveryNoteCode`

LoadCarrierItemInbound

Description	Property
🔤 Renamed property into `deliveryNoteCode`	`logisticLabelCode`
🔤 Renamed property into `sortIndex`	`itemPosition`
✏️ Changed from optional to required	`tradeItemId`
🆕 Added property	`deliveryNoteLetter`
🆕 Added property	`sortIndex`
🆕 Added property	`deliveryRemarks`

OrderedAdditionalService

Description	Property
🆕 Added property	`numberOfUnits`

Organization

Description	Property
🚫 Removed obsolete property	`email`
🚫 Removed obsolete property	`phone`

PackingConfiguration

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

PackingConfigurationRequest

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

PriceGroup 🆕

Description	Property
🆕 Added property	`priceGroupId`
🆕 Added property	`name`
🆕 Added property	`type`
🆕 Added property	`salesUnit`
🆕 Added property	`includedServices`
🆕 Added property	`customers`
🆕 Added property	`isDeleted`
🆕 Added property	`lastModifiedDateTime`
🆕 Added property	`sequenceNumber`

RequestPackingConfiguration

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

SalesOrder

Description	Property
🆕 Added property	`automaticallyCancelledOn`

SalesOrderExternalIntegrationRequest

Description	Property
🚫 Removed obsolete property	`orderDateTime`
✏️ Changed from optional to required	`paymentProvider`
🆕 Added property	`includedServices`

SalesOrderRequest

Description	Property
✏️ Changed from optional to required	`paymentProvider`

SupplyLinePackingConfiguration

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

SupplyLinePackingConfigurationCreate

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

TradeItemUpdate

Description	Property
✏️ Changed maximum length from 14 to 13	`articleGtin`

TransformBatchRequestPackingConfiguration

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

WeeklyBaseSupply

Description	Property
✏️ Changed from optional to required	`numberOfPieces`
🆕 Added property	`priceGroupPrices`

WeeklyBaseSupplyPriceGroupPrice 🆕

Description	Property
🆕 Added property	`priceGroupId`
🆕 Added property	`pricePerPiece`
🆕 Added property	`priceGroupType`

Updated 9 months ago