REST API endpoints for package optimization

This section contains all of the API references for endpoints that are related to package optimization.
We have split this into two broad sub-sections:

One that deals with endpoints which fascilitate package optimization, and
Second sub-section that deals with endpoints which handle optimization hyperparameters.
{/* NOTE: we can add more here, such as for fetching results or statistics */}

If you have any questions, then as always, don't hesitate to reach out to .

API reference for endpoints that perform package optimization

This section contains all of the API references for endpoints that operate with package optimization.
These are endpoints that will perform package optimization and return recommended package(s) if possible.
We have split it into several sub-pages which provide some grouping of the endpoints.
If you have any questions, don't hesitate to reach out to .

Endpoints

API reference for endpoints that handle hyperparameters

This section contains all of the API references for endpoints that handle optimization hyperparameters.
Inserting/Updating hyperparameters
Unless you are happy with the default hyperparameters (as listed in ), you can change them any time by calling the following endpoint:

The endpoint accepts all of our currently supported optimization hyperparameters, but you do not need to specify all of them in your request.
View your hyperparameters
To check what optimization hyperparameters are currently being used, you can call the following:

View hyperparameters used for specific results
Sometimes you might want to know what hyperparameters were used for a specific optimization result. You can do that by calling:

The resultIds in the request refer to Skrym's internal unique identifier of each result.

Handling hyperparameters

A typical e-commerce order will pass through multiple steps in its journey to the customer, such as:

Picking and packing
Booking a delivery
Shipping

Our Feedback API makes it possible to use information from these different steps to get a complete representation of an order's journey.
Source of feedback
The feedbackSourceType field is used to understand from which stage of the order journey a data point comes from, and the accepted values are:

"WAREHOUSE"
"TRANSPORTER"
"INVOICE"
"OTHER"

Feedback on optimization accuracy
One of the key purposes of the Feedback API is to provide feedback on the accuracy of the optimization results provided by Skrym.
For this purpose, the API provides a set of fields that can be used to provide feedback on the optimization results from the warehouse or along the order journey.
For example, the fit field accepts the following values to describe the status of the package in relation to the recommendation:

"FITS"
"TOO_SMALL"
"TOO_BIG"
"UNKNOWN"


To allow flexibility, many of the fields can be left out. When Skrym ingests your call, it will use the highest information-dense field available to infer the status of event, defaulting to mandatory fields. For instance, if measuredDimensions are provided, then it will take precedence over "fit":"TOO_SMALL".
If you need to set a more custom information, you can do so in the metadata field. This field accepts a JSON in which you can specify key-value pairs with your pre-defined Custom Parameters that you can create in Scope, allowing you to specify specialized information such as {"extraInformation": {"isFragileOrder": true}}.
You can then retrieve all of your raw feedback information with the following API:

Or, if you are only interested in the summary of the feedback for 1 or more orders, you can use the following API:
