• Currently, PUZZLE adds the parameter "Order.Processor" after the computation has been finished.

  You should not expect that this parameters to remain. This parameter will be removed in a later release without further notification.

This PUZZLE Plugin provides the Best-Fit optimization and a REST-API for the Best-Fit optimization. The Best-Fit REST API is largely identical to the PUZZLE REST API. Therefore, this document describes the differences to the PUZZLE REST API.

The introduction section describes the core idea of the PUZZLE REST API.

A PUZZLE Best-Fit optimization distributes all order items of a job to the required number of loading devices and finds the appropriate loading devices for the order by means of a Branch and Bound algorithm. PUZZLE can select the appropriate loading devices from the collection of loading devices specified in the loadingDevices attribute of the job.

For a job, PUZZLE creates a collection of solutions, which contains a solution for each required loading device. Those solutions consists of the required loading device together with the positions of the order items packed onto the required loading device. For each order item that fits into at least one loading device, the collection of solutions of a job contains the order item in the quantity specified in the order of the job.

For a Best-Fit optimization, PUZZLE minimizes the number of loading devices required as the main criterion and maximizes the volume utilization of the loads onto the loading devices as the secondary criterion, which is far less important. Currently, a client cannot customize these criteria.

The Best-Fit REST API uses the same data objects as the PUZZLE REST API.

Parameters

PUZZLE ignores the parameter Search.SolutionCount for a Best-Fit optimization and always returns exactly one collection of loads for a job.

The Best-Fit REST API uses the same state machine as the PUZZLE REST API, only with a Best-Fit specific prefix to the urls.

The Best-Fit REST API supports the same plugins as the PUZZLE REST API.

The Best-Fit REST API has the same errors and error handling as the PUZZLE REST API

This section describes all available HTTP endpoints of the Best-Fit REST API. For each endpoint, this documentation contains an interactive representation of the structure of the request body schema and the response schema below the endpoint description. In addition, the right column contains request and response samples for these structures.

In order to facilitate understanding, the following scenario is included as example.

For a Best-Fit optimization, PUZZLE will compute a collection of loads required to distribute an order consisting of 5 tablets and 5 usb power supplies. For each load, PUZZLE can select between an off-the-shelf FEFCO 0201 carton and a customized carton in which exactly one tablet fits.