Skip to main content

​
Overview

Send tracking events that occur during the fulfillment process to e-CROSS’ TMS (Transportation Management System). This endpoint supports batch updates of up to 500 records for different parcels.
It’s VERY important that new tracking events are informed to e-CROSS as soon as possible to give the best visibility for the buyer of the parcel.

​
Update Parcel Trackings

Send a batch of tracking events to e-CROSS. This API requires either the parcelId or externalParcelId instead of the orderId. 
curl -X PUT 'https://hermes.api.e-cross.tech/ext/parcelTrackings' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "carrierId": "ACME",
    "events": [
      {
        "parcelId": "ACME800413194788BR",
        "externalParcelId": "NL970165916BR",
        "eventDate": "2023-08-07T19:48:04+00:00",
        "externalCode": "AWAITING_PICK_UP",
        "description": "Order packed",
        "location": "Paris, FR"
      },
      {
        "parcelId": "ACME800413194788BR",
        "externalParcelId": "NL970165916BR",
        "eventDate": "2023-08-08T05:20:29+00:00",
        "externalCode": "LEFT_FULFILLMENT",
        "description": "Parcel delivered to logistic operator",
        "location": "Paris, FR"
      }
    ]
  }'

{
  "status": "UPDATE IN PROGRESS"
}

​
Request Parameters

​
carrierId
string
required
ID of the partner (fulfillment), registered within e-CROSS. This is a constant value that uniquely identifies your fulfillment and is informed together with your API credentials.
​
events
array
required
List of tracking events. Maximum 500 events per request.

​
Response Fields

​
status
string
required
Current status of the update. Returns UPDATE IN PROGRESS when the request is accepted.

​
Monitored Events

There are specific events that should be monitored during the fulfillment process to give buyers the best visibility:

​
AWAITING_PICK_UP

This event indicates the parcel was picked and packed and is ready to be picked up by the first mile operator. When to send: After the picking & packing process is finished and the parcel is ready for pickup.

​
LEFT_FULFILLMENT

This event indicates the parcel was picked by the first mile operator and left the fulfillment facility. When to send: After the first mile carrier has collected the parcel from your warehouse.

​
Identifying Parcel IDs

You can identify parcels using either method:
1

Using parcelId

  1. Retrieve the order using Get Order API
  2. Find the READY_FOR_SHIP status in statusHistory
  3. Extract eventData.parcelId
2

Using externalParcelId

  1. Scan the barcode on the shipping label, OR
  2. Find it in order.shipping.deliveries.lastMileTrackingNumber
The externalParcelId is the tracking number in the barcode on the shipping label. This can be identified by warehouse operators using a barcode scanner.

​
Batch Processing

This endpoint supports batch updates of up to 500 events for different parcels in a single request. This allows you to efficiently update multiple parcels at once. 
// Example: Batch update multiple parcels
const events = [
  {
    parcelId: "ACME800413194788BR",
    externalParcelId: "NL970165916BR",
    eventDate: "2023-08-07T19:48:04+00:00",
    externalCode: "AWAITING_PICK_UP",
    description: "Order packed",
    location: "Paris, FR"
  },
  // ... up to 500 events
];

const response = await fetch('https://hermes.api.e-cross.tech/ext/parcelTrackings', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    carrierId: 'ACME',
    events: events
  })
});

Sandbox & Testing

Next: Learn about sandbox endpoints for testing