Suppliers

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`

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`

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`

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

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

Description

Value

🆕

Added enum value

CALCULATED

🆕

Added enum value

MANUAL

Model changes

AddBatchPackingConfiguration

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

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`

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`

Description

Property

🔤

Renamed property into

deliveryNoteLetter

sequenceCharacter

🆕

Added property

deliveryNoteCode

BatchPackingConfiguration

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

Description

Property

🚫

Removed obsolete property

bunchesPerPackage

ClockSupplyLinePackingConfiguration

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

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`

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`

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

string

submissionErrors

✏️

Changed from optional to required

status

FulfillmentRequest

Description	Property
🆕 Added property	`clockMinimumPrice`

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`

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`

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`

Description

Property

🆕

Added property

numberOfUnits

Organization

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

Description

Property

🚫

Removed obsolete property

email

🚫

Removed obsolete property

phone

PackingConfiguration

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

Description

Property

🚫

Removed obsolete property

bunchesPerPackage

PackingConfigurationRequest

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

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`

Description

Property

🚫

Removed obsolete property

bunchesPerPackage

SalesOrder

Description	Property
🆕 Added property	`automaticallyCancelledOn`

Description

Property

🆕

Added property

automaticallyCancelledOn

SalesOrderExternalIntegrationRequest

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

Description

Property

🚫

Removed obsolete property

orderDateTime

✏️

Changed from optional to required

paymentProvider

🆕

Added property

includedServices

SalesOrderRequest

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

Description

Property

✏️

Changed from optional to required

paymentProvider

SupplyLinePackingConfiguration

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

Description

Property

🚫

Removed obsolete property

bunchesPerPackage

SupplyLinePackingConfigurationCreate

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

Description

Property

🚫

Removed obsolete property

bunchesPerPackage

TradeItemUpdate

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

Description

Property

✏️

Changed maximum length from 14 to 13

articleGtin

TransformBatchRequestPackingConfiguration

Description	Property
🚫 Removed obsolete property	`bunchesPerPackage`

Description

Property

🚫

Removed obsolete property

bunchesPerPackage

WeeklyBaseSupply

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

Description

Property

✏️

Changed from optional to required

numberOfPieces

🆕

Added property

priceGroupPrices

WeeklyBaseSupplyPriceGroupPrice 🆕

Description

Property

🆕

Added property

priceGroupId

🆕

Added property

pricePerPiece

🆕

Added property

priceGroupType

Customers

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

SalesOrders

HTTP	OperationId	Description
✏️ PUT	AddSalesOrderAdditionalStickerService	This endpoint cannot be used when uploading a PDF of MULTI_TYPE.
🆕 PUT	AddSalesOrderAdditionalStickerServiceMultiType	Added with route `/sales-orders/{salesOrderId}/additional-sticker-service-multiple`

HTTP

OperationId

Description

✏️

PUT

AddSalesOrderAdditionalStickerService

This endpoint cannot be used when uploading a PDF of MULTI_TYPE.

🆕

PUT

AddSalesOrderAdditionalStickerServiceMultiType

Added with route

/sales-orders/{salesOrderId}/additional-sticker-service-multiple

TradeItemGroupSelection 🆕

HTTP	OperationId	Description
🆕 GET	GetTradeItemGroupSelectionsBySequenceNumber	Added with route `/trade-item-group-selections/sync/{sequenceNumber}`
🆕 GET	GetTradeItemGroupSelectionsMaxSequence	Added with route `/trade-item-group-selections/current-max-sequence`
🆕 GET	GetTradeItemGroupSelectionById	Added with route `/trade-item-group-selections/{tradeItemGroupSelectionId}`
🆕 POST	AddTradeItemGroupSelection	Added with route `/trade-item-group-selections/`
🆕 PUT	EditTradeItemGroupSelection	Added with route `/trade-item-group-selections/{tradeItemGroupSelectionId}`
🆕 POST	AddTradeItemsToTradeItemGroupSelection	Added with route `/trade-item-group-selections/{tradeItemGroupSelectionId}/trade-items`
🆕 DELETE	DeleteTradeItemsFromTradeItemGroupSelection	Added with route `/trade-item-group-selections/{tradeItemGroupSelectionId}/trade-items`
🆕 DELETE	DeleteTradeItemGroupSelection	Added with route `/trade-item-group-selections/{tradeItemGroupSelectionId}`

HTTP

OperationId

Description

🆕

GET

GetTradeItemGroupSelectionsBySequenceNumber

Added with route

/trade-item-group-selections/sync/{sequenceNumber}

🆕

GET

GetTradeItemGroupSelectionsMaxSequence

Added with route

/trade-item-group-selections/current-max-sequence

🆕

GET

GetTradeItemGroupSelectionById

Added with route

/trade-item-group-selections/{tradeItemGroupSelectionId}

🆕

POST

AddTradeItemGroupSelection

Added with route

/trade-item-group-selections/

🆕

PUT

EditTradeItemGroupSelection

Added with route

/trade-item-group-selections/{tradeItemGroupSelectionId}

🆕

POST

AddTradeItemsToTradeItemGroupSelection

Added with route

/trade-item-group-selections/{tradeItemGroupSelectionId}/trade-items

🆕

DELETE

DeleteTradeItemsFromTradeItemGroupSelection

Added with route

/trade-item-group-selections/{tradeItemGroupSelectionId}/trade-items

🆕

DELETE

DeleteTradeItemGroupSelection

Added with route

/trade-item-group-selections/{tradeItemGroupSelectionId}

Enum changes

AdditionalServiceUnit

Description

Value

🆕

Added enum value

LABEL

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

Model changes

AddAdditionalStickerServiceComposition 🆕

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

AddPackingConfigurationRequest

Description

Property

🚫

Removed obsolete property

bunchesPerPackage

AddPurchaseOrderRequest

Description

Property

🆕

Added property

deviatingCharacteristics

AddPurchaseOrderRequestPackingConfiguration

Description

Property

🚫

Removed obsolete property

bunchesPerPackage

AddPurchaseOrderVbnCriteria

Description

Property

🚫

Removed obsolete property

characteristics

AddSalesOrderAdditionalStickerService

Description

Property

🆕

Added property

numberOfUnits

🆕

Added property

composition

AddSalesOrderAdditionalStickerServiceMultiType 🆕

Description	Property
🆕 Added property	`stickerId`
🆕 Added property	`size`
🆕 Added property	`additionalInformation`
🆕 Added property	`stickerFileInformation`
🆕 Added property	`compositions`

AddSupplyRequest

Description

Property

🆕

Added property

supplyRequestGroupId

AddTradeItemGroupSelection 🆕

Description	Property
🆕 Added property	`tradeItemSelectionId`
🆕 Added property	`name`
🆕 Added property	`description`
🆕 Added property	`imageUrl`
🆕 Added property	`tradeItemIds`

ClockSupplyLinePackingConfiguration

Description

Property

🚫

Removed obsolete property

bunchesPerPackage

CustomerSticker

Description	Property
🚫 Removed obsolete property	`additionalServiceId`
✏️ Mark as deprecated in the description	`purchaseOrderId`
✏️ Mark as deprecated in the description	`blanketOrderId`
🆕 Added property	`compositions`

CustomerStickerComposition 🆕

Description

Property

🆕

Added property

stickerType

🆕

Added property

numberOfUnits

EditTradeItemGroupSelection 🆕

Description

Property

🆕

Added property

name

🆕

Added property

description

🆕

Added property

imageUrl

OrderedAdditinalService

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

PurchaseOrderPackingConfiguration

Description

Property

🚫

Removed obsolete property

bunchesPerPackage

SalesOrder

Description

Property

🆕

Added property

salesOrderGroupId

🆕

Added property

automaticallyCancelledOn

SelectedTradeItem

Description

Property

🆕

Added property

isDeletedFromCatalog

🆕

Added property

photoIsUnavailableInCatalog

SelectedTradeItemPackingConfiguration

Description

Property

🆕

Added property

isUnavailableInCatalog

SupplyRequest

Description

Property

🆕

Added property

supplyRequestGroupId

TradeItemGroupSelection 🆕

Description	Property
🆕 Added property	`name`
🆕 Added property	`description`
🆕 Added property	`imageUrl`
🆕 Added property	`tradeItems`
🆕 Added property	`added`
🆕 Added property	`lastModified`
🆕 Added property	`isDeleted`
🆕 Added property	`sequenceNumber`

TradeItemGroupSelectionTradeItem 🆕

Description	Property
🆕 Added property	`tradeItemId`
🆕 Added property	`added`
🆕 Added property	`lastModified`
🆕 Added property	`isDeleted`

TradeItemRequestPackingConfiguration

Description

Property

🚫

Removed obsolete property

bunchesPerPackage