Back to AppPricingContact
API Endpoints
Start typing to search…

Adding shipments

Understanding webhook events when adding shipments to your endpoint.

📘

Prerequisites

Ensure that you have subscribed to the shipment.added.to.endpoint and shipment.in.error events.

When adding shipments to your endpoint, the following events will trigger:

  • shipment.added.to.endpoint
  • shipment.in.error
  • No event received

Case 1: You Received shipment.added.to.endpoint

Your shipment has been successfully added. You can use the event payload from this notification as your initial data for tracking.

Case 2: You Received shipment.in.error

Your shipment has been added to the endpoint, and we will continue tracking it as long as it remains in your shipment list. Depending on the specific error, follow the actions below:

Input Errors:

  • WRONG_NUMBER
  • WRONG_SEALINE
  • WRONG_TYPE
  • SEALINE_NOT_SUPPORTED
  • TYPE_NOT_SUPPORTED_FOR_SEALINE

Resolution:
The inputs you provided are incorrect or unsupported. Delete the shipment and retry entering it with corrected numbers, sealines, or types.

Auto-detection Errors

  • AUTO_CANT_DETECT_SEALINE
  • AUTO_CANT_DETECT_TYPE
  • AUTO_CANT_FIND_INFO

Resolution:
Insufficient information was provided, and we could not auto-detect the missing data. Delete the shipment and recreate it with additional details.

Sealine Issues

  • SEALINE_UNDER_MAINTENANCE
  • SEALINE_TEMPORARY_DISABLED
  • SEALINE_NO_RESPONSE

Resolution:
There is an issue retrieving data from the sealine. Keep the shipment in your list; we will continue attempting to fetch the data.

No Tracking Data Available

  • SEALINE_HASNT_PROVIDE_INFO

Resolution:
Although we contacted the shipping line, no tracking data is currently available. Keep the shipment in your list; we will continue to poll for updates.

Shipment Cancellation

  • SEALINE_CANCELED_SHIPMENT

Resolution:
The shipment has been canceled. Delete it from your list and contact the sealine for additional information.

Case 3: You Received No Event

If you do not receive a shipment.added.to.endpoint or shipment.in.error event, it indicates that the shipment has not been added to your endpoint. Possible reasons include:

  • The Shipment is Already Tracked:

Verify this by sending a GET request to the /easy-shipment endpoint. Check if your shipment appears in the tracked shipment list.

  • Internal Error:

Retry subscribing the shipment 5 minutes later. Notify us if the issue persists.