Skip to content

Errors Reference

When an entity reaches an errored state, meaning an error happens that sets the entity's current_state to errored, the specific error will be attached to the state_reason attribute.

The error will either be a single word referencing one of the errors below or a link with additional details in the following format:

{location}/{type}/{id}/{error}

  • location: At what stage the error happened
  • type : the type of the entity that errored
  • id : the ID of the entity that errored
  • error : the specific error, a reference to the list of errors below

nofits

The event could not be fit into the planning. This usually happens for the following reasons:

  • Not enough room left in the planning
  • Not enough capacity among resources
  • Resource or Planning cancelled

These cases happen naturally as part of the process and can be handled by adding the events to another plan or providing additional resources.

However, there is a possibility that a planning with no events still throw this error. In which case you should verify the event you are sending, it is possible that the data is invalid such as the event capacity exceeding the capacity of any one resource or the distance between the depot and the event being too great for the current time window.

nopicks

This error can only occur if the entity is a Suggestion. The error means that the suggestion could not be picked because the planning has since then changed making it no longer feasible. This usually happens when it takes too long for the customer to pick a suggestion. The recommended solution is to ask for a new set of suggestions and hope the customers picks them before they expire.

tm_errors

This error happens when the Travel Matrix (TM) raises an error. The TM can raise an error for two reasons:

  • The coordinates you have inputed are not present on the map you are using. For example, if you deliver in the Netherlands but input latlon coordinates that point to Norway.
  • The Travel Matrix was unable to process your request. This is an unintended error that happens if the Travel Matrix does not successfully receive the request or is unable to process it. In this case it is recommended to try again. If the TM is unavailable for a long period please raise a ticket with support.

not_found_ids

This error happens when the entity you requested using an ID was not found. This usually means that either the ID is wrong or the entity does not meet the Query parameters. For example, requesting a bucket by ID with the parameter current_state=initialized will return this error if the bucket is not in that state even if it exists. Make sure your query parameter are not too strict and that the ID is correct.

timeout

The request timed out, try again later.

errors

An unhandled exception has occurred. This will usually take the form of a 500 response. An alert will be raised but if you have the time consider filing a ticket with support. You can try the request again later just in case it happened to be a software spasm.

transition_timeout

The entity timed out while trying to transition from one state to another and was forced into an errored state to avoid a stuck entity.