When using our API to create, modify or update orders, you might receive an error message as either the information might be in the wrong format or the resource you would like to pair does not exist yet. In this case, we advise you to check the file (mainly JSON) you have sent to Shippeo.

 

List of possible Errors

Below you find a list of possible error messages with their explanation and possible next steps. 

 

  Message Explanation Next Steps

Authentication related

{ "detail": "Invalid credentials", "status": 401, "source": { "pointer": "/" } }

The username and password combination you have sent is invalid. Double-check the entered data or reset the password of the API user. The administrator of your Shippeo account can help you (read more here).

{ "detail": "The token \"{{shipperTokend}}\" is invalid", "status": 401, "source": { "pointer": "/" } }

The token you have sent is invalid. Please double check the token you have entered or request a new token.

{ "detail": "Expired JWT Token", "status": 401, "code": "TOKEN_EXPIRED_EXCEPTION", "source": { "pointer": "/" }, "title": "Token has expired" }

The token you have sent is expired.

Please request a new token as this token is no longer valid.

As a reminder, an API token is:

  • Valid for 15 days in the production environment.
  • Valid for 2 days in the test environment.

And can be refreshed a maximum of once a day.


Format related


{ "detail": "Invalid json message received", "status": 400, "source": { "pointer": "/" } }

The JSON message you have sent is incorrect.

Please check the message you are trying to send, as this JSON is not generally valid. You can find examples in our API documentation.

{ "detail": "This value is too long. It should have 35 characters or less.", "status": 400, "source": { "pointer": "/shipment/orders[0]/pick_up/name" } }

The value you have added for a specific field is too long.

Check the field indicated by the section "pointer" in the message and shorten the value to be less than the characters indicated.

{ "errors": [ { "detail": "This value should not be blank.", "status": 400, "source": { "pointer": "/shipment/orders[0]/pick_up/name" } } ]}

There is a value missing for a specific field in your message.

Check the field indicated by the section "pointer" in the message and enter a value as this field cannot be empty.

{ "detail": "This value is too short. It should have 1 character or more.", "status": 400, "source": { "pointer": "/shipment/orders[0]/handling_units[1]/ tracking_code" } }

The value you have added for a specific field is too long.

Check the field indicated by the section "pointer" in the message and lengthen the value to be more than the characters indicated.

Agency related {"errors":[{"detail": "no agency could be found with the given information","status": 400,"source":{"pointer": "\/shipment\/ carrier"}} The agency that the order was being chartered to does not exist or has a different reference Check with your Shippeo carrier contact. Make sure to include: the JSON, the carrier name, the carrier reference you are using.
{"errors":[{"detail": "Agency already charter","status":400,"source":{"pointer":"\/"}}]} The order has already been chartered to an agency.
  1. Log into Shippeo and search for the order.
  2. Search the order and click on the order details.
  3. Check in the timeline when the order was chartered and to what agency.
  4. Consult with your EDI team on what triggered this message.
{"errors":[{"detail": "Agency not found for field situation_justification.charter .agency"}} The agency that the order was being chartered to does not exist or has a different reference. Check with your Shippeo carrier contact. Ensure to include: the JSON, the carrier name, and the carrier reference you are using.

Order related


 

 

 

 

{“errors”:[{“detail”: “This value should not be null.“, ”status”:400,“source”:{“pointer”:“\/situation_justification\ /charter\/agency\/id”}}]}

A value in your file has the value 0, which is not allowed. Please check your JSON File for any value that equals 0.

{“errors”:[{“detail”: “This value is too short. It should have 1 character or more.“,”status”:400,“source”:{“pointer”:“\/order\/id”}}]}

 A value in your file does not have any information. Please check your JSON File for any value that holds no information.
{“errors”:[{“detail”: “Order reference not found.“,”status”: 400, “source”:{“pointer”:“\/order”}}]}

The order reference was not found.

Check your Shippeo account to see whether the order does exist.

{“errors”:[{“detail”: “Order not found with filters : "OrderById(id= "xxxxxx"), NotArchivedOrd“, ”status”:400,“source”:{“pointer”:“\/order\/id”}}]}

The order cannot be found with those filters.

This error can have different reasons, but the main reason is that this order is not active anymore, and it is therefore not possible anymore to update it. Consequently, you can check the order in question in Shippeo to see whether the order is still ongoing. If that is the case, we invite you to reach out to our Shippeo support team.

 {“errors”:[{“detail”: “Order can not be pair with the same mean,” “status”: 400, “source”:{“pointer”: “\/pair\/mean\/id”}}]} The order has been paired with the same resource already. No action is required here as the orders have already been paired with the right resource.
 {“errors”:[{“detail”: “Can not perform an action on a finished order,” “status”: 400, “source”:{“pointer”:“\/“}}]} The order is already closed. No action is required here as a closed order cannot be updated anymore.

 {“errors”:[{“detail”: “The externalId is already used in this organization,” “status”:400, “source”:{“pointer”:“\/canonical_external_id”}}]}

The order ID is already in use for another order. 

The order ID/reference must be unique in the Shippeo environment among active orders. In this case, you can:

  • Close the order with the same reference in Shippeo.
  • Change the order reference. 
{"errors":[{"detail":"The action xxx has already been executed.", "status":409,"code":"ACTION_ ALREADY_EXECUTED",  "source":{"pointer":"\/"},"title":"Action already executed"}]} The action has already been executed.

No action is required from your side, as the action you are trying to perform has already been executed in Shippeo.

{ "detail": "Delivery is before load", "status": 400, "source": { "pointer": "/shipment/orders[0]" } }

The delivery slot is set before the loading slot.

Please check the order and ensure that the delivery slot is not planned before the loading.

{ "detail": "Theoretical start date is after theoretical end date", "status": 400, "source": { "pointer": "/shipment/orders[0]/pick_up" } }

The end of the loading or delivery slot is before the start of the loading or delivery slot.

Please check the order and ensure that the end of the loading or delivery slot is not earlier than the start of the corresponding slot.

{ "detail": "This value is not a valid datetime.", "status": 400, "source": { "pointer": "/" } }

The format of the date is not the correct one.

Please check the date format you have sent in your JSON file.

As a reminder, the date format needs to be according to the ISO 8601 standard, e.g.

  • 2019-10-09T08:10:42Z
  • 2019-10-09T08:10:42+02:00
Resource related {"title": "Mean can neither be found or created", "detail": "Some information might be missing or inaccurate", "status": 400, "source": {"pointer": "/"} The resource (mean) has to be created in Shippeo beforehand.

Ensure that the license plate sent in the JSON is correct. Then contact your Shippeo contact with your subcontractor contact in CC and the following information:

  1. JSON
  2. 2. Subcontractor
  3. License plate

Note: It is possible to create resources during the order creation. Please consult this article to learn more.

{"errors":[{"detail":"A deactivated mean cannot be paired","status":400,"source":{"pointer":"\/pair"}}]} The resource (mean) is not active in your Shippeo account.

As a Carrier or a Shipper using your own fleet

Ensure the resource is active in your Shippeo account:

 

  1. Log into Shippeo.
  2. Click on your name in the right-hand corner and choose "Admin."
  3. Click on "Resources"
  4. Check the slider "All resources" next to the search bar.
  5. Search for the resource in question
  6. Check whether the resource is active or deactivated.
  • If the resource is deactivated, you can edit the resource and set the slider in the top right-hand corner to active again.
  • If the resource is active, please reach out to our support team, supplying them with this information.

As a Shipper who pairs for their Carrier:

Please reach out to your Carrier, asking them to perform the above action.

{ "detail": "The label is already used in this organization", "status": 400, "source": { "pointer": "\/label" } The resource label already exists for this organization.

Please check the resource list to see whether this name already exists in Shippeo to avoid any duplicates. If this is no duplicate but a different resource, please update the name to something different.


Place / Address related

{ "detail": "An existing place or a new place informations must be provided", "status": 400, "source": { "pointer": "/shipment/orders[0]/pick_up" } }

The place/address for loading or delivery does not exist.

Please check the order and ensure that the place/address for both loading and delivery does exist in the Shippeo environment and that you use the correct name. You can read more here about how to create places/addresses in Shippeo.

{ "detail": "Loading and Delivery cannot reference the same place", "status": 400, "source": { "pointer": "/shipment/orders[0]" } }

The loading and delivery place/address is the same.

Please check the order and ensure that the loading and delivery place/address are different.

{ "detail": "Place is deactivated and cannot be used.", "status": 400, "source": { "pointer": "/shipment/orders[0]/pick_up" } }

The place/address for loading or delivery is deactivated.

Please check the order and ensure that the place/address for loading and delivery is an active address in Shippeo. 

Goods related

{ "errors": [ { "detail": "Invalid packing qualifier provided : [TR], available values are [PX, PD, PE, PC, NA]", "status": 400, "source": { "pointer": "/shipment/orders[0]/packing[0]/type" } } ]}

The packing qualifier you have used is invalid.

Please check your message and ensure that the packing qualifier for the mentioned goods is one of the following: PX, PD, PE, PC, NA

{ "detail": "no custom packaging qualifier could be found with the given information", "status": 400, "source": { "pointer": "/shipment/orders[0]/handling_units[0]/ custom_packaging_qualifier" } }

The custom packing qualifier you have used is invalid.

Please check your message and the used custom qualifier. If you need any additional custom packing qualifiers for your Shippeo account, please get in touch with your account manager.

 

Is your error not on the list?

If you encounter any other error message that is not in the list yet or something is not sufficiently clear to you, please reach out to our Support Team by clicking on "Submit a request" at the top bar of this page.

Was this article helpful?
0 out of 0 found this helpful