Release notes - Suppliers API

This page will show the changes made in the suppliers API version 2022v2. The changes are marked with a publish date to staging and production. New changes will be added at the top of the page.

DeliveryOrderAuction - CarrierOrganizationId

Added the option the get the carrier organization from a DeliveryOrder and set the carrier organization while creating a new DeliveryOrder with model DeliveryOrderAuction.

  • Added optional property CarrierOrganizationId into DeliveryOrderAuction
  • Added optional property CarrierOrganizationId into DeliveryOrder

published: 20-10-2022

Webhook - AggregateType

  • Added enum value BATCH
  • Added enum value DELIVERYORDER
  • Added enum value FULFILLMENTORDER

published: 14-10-2022

FulfillmentOrder - CarrierOrganizationId

Added the option the get and set the carrier organization for a FulfillmentOrder. Overwrites the carrier organization found in the mathcing DeliveryOrder by setting it while creating a new FulfillmentOrder.

  • Added optional property CarrierOrganizationId into FulfillmentOrder
  • Added optional property CarrierOrganizationId into FulfillmentOrderCreate

published: 06-10-2022

AdditionalService - Units

Added new units for the AdditionalService and removed the requirement to pass along the unit while placing a SalesOrder with an AdditionalService.

AdditionalService

  • Replaced property enum Unit into a new enum AdditionalServiceUnit

OrderedAdditionalService

  • Set property Price as non nullable
  • Replaced property enum Unit into a new enum AdditionalServiceUnit

SalesOrderExternalIntegrationRequest

  • Replaced property model AdditionalServices into OrderAdditionalService

SalesOrderRequest

  • Replaced property model AdditionalServices into OrderAdditionalService

published: 30-09-2022

FulfillmentOrder - LoadCarrierItem marked as OK/NOK

Added the status of received item to the model LoadCarrierItem. Customers can mark the load carrier item as OK/NOK with a reason.

  • Added property StatusOfReceivedItem
  • Added property StatusOfReceivedItemReason
  • Added model AddLoadCarrierItem for creating a FulfillmentOrder with model FulfillmentOrderCreate

published: 29-09-2022

Missing max string length

Added the string length for missing string properties.

InvoiceLine

  • Added a max length of 24 to property InvoiceId
  • Added a max length of 7 to property DeliveryFormReference

LoadCarrierItemInbound

  • Added a max length of 8 to property BatchReference

OrderRequest

  • Added a max length of 255 to property DeclinedReason

TradeItemUpdate

  • Added a max length of 14 to property ArticleGtin

published: 29-09-2022

ClockPresalesSupplyLine - Add and edit

Added the option to create KVV supplyLines based on the ClockSupplyLine and edit the KVV supply lines after creating a clock delivery order.

  • Added endpoint AddClockPresalesSupplyLine
  • Added endpoint EditClockPresalesSupplyLine

published: 27-09-2022

CustomerOffer - Volume prices

Added the option to set volume prices for CustomerOffer supply lines.
The PricePerPiece will result in a volume price with a unit PACKAGE.

  • Added optional property VolumePrices
  • Added model AddVolumePrice

published: 26-09-2022

SalesOrderMutation - Information

Added more information to the SalesOrderMutation model.

  • Added property SalesOrderCorrectionRequestReason
  • Added property CorrectionType
  • Added property CreatedDateTime
  • Renamed enum SalesOrderMutationType into SalesOrderMutationUpdateType
  • Added enum value WITHDRAWN_BY_CUSTOMER into SalesOrderMutationUpdateType

published: 26-09-2022

LoadCarrierItem - DeliveryRemark

Added the option to add/overwrite the delivery remark on a load carrier item which will be printed on the connect EAB document. A NULL value indicates the use of the default delivery remark found in the FulfillmentRequest or will ignore the value in an update.

  • Added optional property DeliveryMark into LoadCarrierItem

published: 21-09-2022

Get SalesOrder by id and version

  • Added endpoint GetSalesOrderByIdAndVersion
  • Added model SalesOrderVersion

published: 21-09-2022

Removed SalesOrderCorrections and added SalesOrderMutations

Removed the model SalesOrderCorrection corresponding property in SalesOrder. The old model was not representing all the corrections and mutations on a SalesOrder. It was also impossible to retrace the SalesOrder back to the original values of version 1.

Added a new model SalesOrderMutation to indicate the different mutations/corrections on a SalesOrder.
SalesOrderMutation contains the old and new values, a mutation type to indicate the action by which the SalesOrder was mutated (PRICE_UPDATE or CORRECTION_REQUEST) and an optional SalesOrderCorrectionRequestId which is filled when the mutation is created by a SalesOrderCorrectionRequest. The SalesOrderCorrectionRequest must always be accepted before it results in a mutation in the SalesOrder.

  • Removed property SalesOrderCorrections from SalesOrder
  • Added property Mutations to SalesOrder
  • Removed Unused property IncludedPriceComponents from SalesOrderCalculatedFields

published: 21-09-2022

SupplyLine - Remove obsolete TradePeriod

  • Removed obsolete property TradePeriod
  • Set property OrderPeriod as required

published: 19-09-2022

Renamed OrderLineId into the default SalesOrderId

  • Renamed property OrderLineId from FulfillmentRequest into SalesOrderId
  • Renamed property OrderLineId from FulfillmentRequestCreate into SalesOrderId
  • Renamed property OrderLineId from SalesOrderExernalIntegrationRequest into SalesOrderId
  • Renamed property OrderLineId from SalesOrderRequest into SalesOrderId
  • Renamed property OrderLineId from StickerMetaData into SalesOrderId

published: 16-09-2022

Invoice lines

Created a new controller InvoiceLines to fetch and sync the invoice lines and moved the old GetInvoiceLinesBySalesOrderId endpoint in SalesOrders to this new controller.

  • Moved endpoint GetInvoiceLinesBySalesOrderId with new route invoice-lines/{salesOrderId}
  • Added sync endpoint GetInvoiceLinesBySequenceNumber
  • Added endpoint GetInvoiceLinesMaxSequence for fetching the max sequence

published: 13-09-2022

Batch and AddBatch validation

  • LoadCarrier cannot be of type NONE while calling AddBatch
  • Set minimum range of property NumberOfPieces to 1
  • Renamed property SelectedPackingConfiguration into PackingConfiguration in model AddBatch and Batch
  • Added new model AddBatchPackingConfiguration with a required PackagesPerLayer and set minimum range for LayersPerLoadCarrier and PackagesPerLayer

published: 13-09-2022

Remove Insights endpoints

Removed all the Insights endpoint and models in preperation of a new stand-alone API.

published: 07-09-2022

VolumePrices - PricePerPiece

  • Renamed property value into PricePerPiece

published: 07-09-2022

CorrectionRequestStatus

  • Added enum value PENDING_CLAIM

published: 31-08-2022

SalesOrderCorrectionRequest - NULL price

  • Always return the PricePerPiece value as NULL instead of 0.

published: 30-08-2022

AddSupplyLine

  • Renamed endpoint AddSupplyLines into AddSupplyLine

published: 29-08-2022

AddSalesOrderExternalIntegration - SalesOrderResponse

  • Removed SalesOrderResponse as response model from AddSalesOrderExternalIntegration

published: 29-08-2022

SalesOrderCorrectionRequest - Package

  • Added optional property Package into AddSalesOrderCorrectionRequest and SalesOrderCorrectionRequest
  • Removed property VbnPackageCode into AddSalesOrderCorrectionRequest and SalesOrderCorrectionRequest
  • Removed property CustomPackageId into AddSalesOrderCorrectionRequest and SalesOrderCorrectionRequest

published: 02-08-2022

AuctionLocation

  • Added enum value NURSERY

published: 02-08-2022

TradeInstrumentType

  • Added enum value BID_OFFER
  • Added enum value CLOCK_SALES_FROM_NURSERY

published: 08-07-2022

Contract - Add, Edit and Delete endpoints

Added endpoints to add, edit, accept, decline or delete contracts.

  • Added endpoint AddContract for adding new contracts.
  • Added endpoint EditContract for editing contracts with state DRAFT/FINALIZED/DECLINED
  • Added endpoint FinalizeContract to set your contract from state DRAFT to FINALIZED and offer it to the customer for approval.
  • Added endpoint ApproveContract to approve a FINALIZED contract waiting for an approval of the supplier.
  • Added endpoint DeclineContract to decline a FINALIZED contract waiting for an approval of the supplier.
  • Added endpoint RequestDeleteContract to delete a contract with state DRAFT/FINALIZED/DECLINED or request a delete for an APPROVED contract to be accepted by the customer.
  • Added endpoint ApproveDeleteContract to approve the delete request to delete the APPROVED contract.

published: 07-07-2022

DeliveryCondition - Non working days

Added non working days into model DeliveryCondition to indicate a deviating time frame on specific public holidays.

DeliveryCondition

  • Added property OrderTimeZone. Contains values like Europe/Amsterdam.
  • Added property DeliveryTimeZone. Contains values like Europe/Amsterdam.
  • Added property NonWorkingDayDeliveryCondition

TimeFrame

  • Changed property type LatestOrderTime from string($partial-time) to string($duration)
  • Changed property type LatestDeliveryTime from string($partial-time) to string($duration)

published: 04-07-2022

SupplyLine - Price group name

  • Added optional property PriceGroupName

published: 30-06-2022

CustomerOffer - AllowedCustomers

Added the option to edit the allowed customers on a customer offer.

  • Added property AllowedCustomers into EditCustomerOffer

published: 27-06-2022

Renamed VbnPackageTypeCode into the default VbnPackageCode

  • Renamed property VbnPackageTypeCode from AddSalesOrderCorrectionRequest into VbnPackageCode
  • Renamed property VbnPackageTypeCode from SalesOrderCorrectionRequest into VbnPackageCode

published: 27-06-2022

SalesOrder - Model changes

  • Added property SupplierOrganizationId
  • Renamed property OrderLineId into SalesOrderId
  • Renamed property SelectedPackingConfiguration into PackingConfiguration
  • Changed property type SalesChannel from string to enum.

published: 24-06-2022

CreditCheckStatus - Expired

  • Added value EXPIRED to CreditCheckStatus

published: 27-06-2022

SupplyLine - Volume prices

Volume prices indicates the volume discount prices as a price per piece for the minimum purchase of a LAYER or a LOAD_CARRIER. With a default for PACKAGE which contains the default PricePerPiece of a SupplyLine.

  • Added property VolumePrices into SupplyLine

published: 27-06-2022

GetBatches

Removed query parameter from endpoint GetBatches.

published: 23-06-2022

SalesOrderCorrectionRequest - CustomPackageId

Readded the option to place a correction request on the custom package in a sales-order.

  • Added property CustomPackageId into SalesOrderCorrectionRequest.
  • Added property CustomPackageId into AddSalesOrderCorrectionRequest.

published: 08-06-2022