Release notes - Customers API

Purchase- / SalesOrder - Location

It is no longer possible to add address information when placing a Purchase- / SalesOrder. It is only possible to specify the GLN which must be a valid floricode location GLN.

• Added model AddLocation with required property Gln
• Added model AddPurchaseOrderDelivery with the location model AddLocation
• Replaced property model Location in OrderedDelivery with AddLocation
• Replaced property model PurchaseOrderDelivery in AddPurchaseOrder with AddPurchaseOrderDelivery
• Replaced property model PurchaseOrderDelivery in AddPurchaseOrderRequest with AddPurchaseOrderDelivery

published: 21-10-2022

Default rate limit

Added default rate limiting for all endpoints with a rate limit of 3.4 per second and a burst limit of 1000

published: 17-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

AddPurchaseOrder

• Replaced property model AdditionalServices into OrderAdditionalService

AddPurchaseOrderRequest

• Replaced property model AdditionalServices into OrderAdditionalService

SalesOrderRequest

• Replaced property model AdditionalServices into OrderAdditionalService

published: 30-09-2022

ASN - Mark status of received load carrier item as OK/NOK

You can now mark the status of your received load carrier items with an OK/NOK.

• Added endpoint MarkStatusOfReceivedLoadCarrierConfigurationItem
• Added property StatusOfReceivedItem into LoadCarrierItem
• Added property StatusOfReceivedItemReason into LoadCarrierItem

published: 29-09-2022

ASN - Get by SalesOrder id

• Added endpoint GetAdvanceShippingNoticesBySalesOrderId

published: 29-09-2022

Clock supply

Added AuctionController with endpoints to fetch ClockSupplyLine and ClockPresalesSupplyLine

• Added endpoint GetClockSupplyLineById
• Added endpoint GetClockPresalesSupplyLineById

published: 28-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

Missing max string length

Added the string length for missing string properties.

AddPurchaseOrderVbnCriteria

• Added a max length of 40 to property TradeItemCode
• Added a max length of 40 to property TradeItemDescription
• Added a max length of 6 to property VbnProductCode

Address

• Added a max length of 70 to property AddressLine
• Added a max length of 70 to property City
• Added a max length of 3 to property CountryCode
• Added a max length of 10 to property PostalCode
• Added a max length of 70 to property StateOrProvince

CarrierOrganization

• Added a max length of 255 to property Name

Contract

• Added a max length of 255 to property Title
• Added a max length of 13 to property DefaultDeliveryLocationGln
• Added a max length of 13 to property ContractReference
• Added a max length of 2047 to property DeclineDescription
• Added a max length of 2047 to property Description

ContractAttachmentDetails

• Added a max length of 255 to property AttachmentFileName

DeliveryGroup

• Added a min length of 13 to property DeliveryLocationGln
• Added a max length of 13 to property DeliveryLocationGln

DeliveryRegion

• Added a max length of 255 to property Name

EditBlanketOrderLine

• Added a min length of 13 to property DeliveryLocationGln
• Added a max length of 13 to property DeliveryLocationGln

FulfillmentLocation

• Added a min length of 13 to property Gln
• Added a max length of 13 to property Gln

Identity

• Added a max length of 20 to property Gln

InvoiceLine

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

LoadCarrierConfiguration

• Added a max length of 18 to property DocumentReference

LoadCarrierItem

• Added a max length of 19 to property LogisticLabelCode

Organization

• Added a max length of 255 to property Name

OrganizationDetails

• Added a max length of 255 to property CommercialName
• Added a max length of 100 to property Email
• Added a max length of 255 to property Phone
• Added a max length of 255 to property Website

PurchaseOrder

• Added a max length of 40 to property TradeItemCode
• Added a max length of 6 to property VbnProductCode

SalesOrderPlantPassport

• Added a max length of 13 to property SalesChannelOrderId
• Added a max length of 30 to property CountryCodeAndPhytosanitaryNumber
• Added a max length of 8 to property TraceabilityCode

Sticker

• Added a max length of 13 to property AdditionalInformation

TradeItem

• Added a max length of 120 to property Name

Warehouse

• Added a max length of 255 to property Name

published: 23-09-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: 23-09-2022

SalesOrder - Get by id and version

Added enpoint GetSalesOrderByIdAndVersion to fetch the sales order by id and version and return it as a new model SalesOrderVersion

published: 21-09-2022

SalesOrder - SalesOrderMutations

Added 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.

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

published: 20-09-2022

PurchaseOrder - ActionRequired - Additional service

• Added enum value INCORRECT_ADDITIONAL_SERVICE

published: 15-09-2022

InvoiceLines

Added InvoiceLinesController with the route /invoice-lines for the sync endpoints.

• Moved endpoint GetInvoiceLinesBySalesOrderId from SalesOrdersController into InvoiceLinesController with route invoice-lines/{salesOrderId}
• Added endpoint GetInvoiceLinesBySequenceNumber
• Added endpoint GetInvoiceLinesMaxSequence

published: 13-09-2022

VolumePrices - PricePerPiece

• Renamed property value into PricePerPiece

published: 07-09-2022

Remove AddSelectedTradeItems

Removed endpoint AddSelectedTradeItems for adding multiple SelectedTradeItems in one call.

published: 06-09-2022

CorrectionRequestStatus

• Added enum value PENDING_CLAIM

published: 31-08-2022

SalesOrder - Required properties

• Set SalesChannelOrderId as required.
• Set SalesOrderStatus as required.
• Set TradeItemVersion as required.
• Set SalesOrderVersion as required.
• Set CalculatedFields as required.
• Set PaymentProvider as required.
• Set CreationDateTime as required.

published: 26-08-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: 20-07-2022

TradeInstrumentType

• Added enum value BID_OFFER
• Added enum value CLOCK_SALES_FROM_NURSERY

published: 15-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 supplier for approval.
• Added endpoint ApproveContract to approve a FINALIZED contract waiting for an approval of the customer.
• Added endpoint DeclineContract to decline a FINALIZED contract waiting for an approval of the customer.
• 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 supplier.
• Added endpoint ApproveDeleteContract to approve the delete request to delete the APPROVED contract.

published: 13-07-2022

PurchaseOrder - ActionRequired

• Added enum value INVALID_DELIVERY_GLN
• Added enum value INVALID_DELIVERY_MOMENT
• Added enum value TRADE_ITEM_UNAVAILABLE
• Added enum value INVALID_SUPPLY_REQUEST
• Added enum value DIFFERENT_SUPPLIER
• Added enum value CUSTOMER_DOES_NOT_ACCEPT_TRANSPORT_COST

published: 11-07-2022

SalesOrder - Model changes

• Added property LastModified
• Added property CreationDateTime
• Added property DespatchWarehouseId
• Added property DeliveryPricePerPiece
• Added property CalculatedFields with a new model SalesOrderCalculatedFields
• Replaced property model SelectedPackingConfiguration with a new model SalesOrderPackingConfiguration
• Removed property GoodsStatus
• Removed property TotalPrice
• Changed property type SalesChannel from string to enum.

OrderedAdditionalService

• Renamed property PricePerPiece into Price
• Added property Unit

SalesOrderDelivery

• Renamed property DeliveryConditionSetId into DeliveryConditionId
• Renamed property DeliveryPrice into DeliveryCost

published: 08-07-2022

SupplyRequest - Endpoint changes

• Added endpoint EditSupplyRequest to edit the base SupplyRequest properties.
• Added endpoint DeleteSupplyRequest to completely delete an existing SupplyRequest. Accepted SupplyLines will be marked as deleted.
• Added endpoint AddSupplyRequestLine to further add lines to an existing SupplyRequest.
• Added endpoint EditSupplyRequestLines to edit not accepted lines.
• Added endpoint DeleteSupplyRequestLine to delete a specific SupplyRequestLine. Accepted SupplyLines will be marked as deleted.

published: 27-06-2022

SupplyRequests - Model changes

AddSupplyRequest

• Set property Title as required.
• Renamed property ExpiresAt into ResponseEndDateTime .
• Set property ResponseEndDateTime as nullable. A NULL value allows the supplier to respond till the end of the SupplyRequest.
• Removed property QuantityDescription. It is now possible to set the quantity at property level.
• Added property Currency into AddSupplyRequest

AddSupplyRequestLine

• Added optional property NumberOfPieces.
• Added property UsesCatalogAvailability. Indicates if you prefer the SupplyLine availability to be based of the TradeItem availability or limited quantity.

SupplyRequest

• Set property Title as required.
• Renamed property ExpiresAt into ResponseEndDateTime .

SupplyRequestLine

• Added optional property NumberOfPieces.
• Set property RejectionReason as nullable property.
• Added property IsDeleted.
• Changed property Status into enum SupplyRequestLineStatus

Misc

• Renamed model AddSupplyRequestPackingConfiguration into SupplyRequestLinePackingConfiguration
• Added model EditSupplyRequest.
• Added model EditSupplyRequestLine
• Changed the values of enum SupplyRequestStatus

published: 27-06-2022

Splitted /requests endpoints into /catalog-requests and /supply-requests

Splitted the RequestsController into CatalogRequestsController and SupplyRequestsController.

published: 27-06-2022

Renamed VbnPackageTypeCode into the default VbnPackageCode

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

published: 27-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

Remove Insights endpoints

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

published: 20-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