Feedback Handling

How Skrym supports feedback flows

Last updated 12 Sept 2024

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"
postapi.skrym.com/core.GeneralFeedback

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:

postapi.skrym.com/detection.GetFeedbackForOrganization

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

postapi.skrym.com/core.GetFeedbackSummaryForOrders