Tracking Events API

Overview

The Get Tracking Events API lets you receive status events on the delivery status of an order. Reporting of tracking events allows both our customers and 3rd parties to stay informed about the exact location and status of returned items throughout the entire external return journey.

With that, having tracking events for return shipments allows to trigger refunds automatically upon confirmation of returned item receipt (or any other tracking event).

The API accepts one or more order ID numbers, up to 100, on a single call, a list of either orders moved to forward shipments, after checkout completion (outbound), or returns (inbound) and returns their status.

For each order the following tracking details are provided:

Order ID
Tracking Event Time
- Global-e Event, one or more.
- Shipper event, one or more.
Is the Shipper active?
Tracking URL
Shipper Name
Inbound or Outbound shipping.
Location Address – The current location of the order.
Tracking Status, one of the following:
- DispatchedToCustomer
- DeliveryAttempt
- Delivered
- ReturnedByShipper

The list returned in the response is ordered by “Tracking event date time” ASC.

Prerequisites

The request can include a list of global-e order IDs, a list of tracking events, or both, but all the same type: Inbound or Outbound.

If requesting inbound and outbound tracking events, two different requests should be issued.

Implementation

GetTrackingEvents

API ENDPOINT: GetTrackingEvents

POST request URL: https://{server_name}/Shipment/GetTrackingEvents

Request Parameters

Parameter	Type	Description	Mandatory
`EventSinceInUTC`	string	Date and time for the earliest time of the order shipment status, UTC time zone, in RFC 2822 format (for example, Fri, 8 Aug 2014 17:13:07 +0000).	No
`Type`	string	The shipment direction. One of the following	Yes
`OrderIds`	List of strings	List of Global‑e Order IDs. Up to 100 in each request, in the format GEnnnnnn.	Conditional
`TrackingNumbers`	List of strings	List of Global‑e tracking numbers. Up to 100 in each request, in the format GEnnnnnn.	Conditional

Response Parameters

Parameter	Type	Description	Mandatory
`SuccessfulTrackingNumbers`	List of Objects	The events for each `OrderId` listed in the request. The object includes: `GlobaleOrderID` `MerchantOrderID` `TrackingNumber` Type – Inbound or Outbound `ShipperName` `TrackingEvents` Object
`TrackingEvents`	List of Objects	Tracking details for each Global-e order ID in the request, in ascending tracing event time: `ShipmentEventDescription` `TrackingEventTimeDateUTC` `GlobaleEventDescription` `TrackingEventStatus` One of the following: `DispatchedToCustomer` `DeliveryAttempt` `Delivered` `ReturnedByShipper` Location – Object of `FullAddress`

Examples

Request

Request for only for GE orders:

{
  "EventSinceInUTC": "2023-01-01 00:04:23",
  "Type": "outbound",
  "OrderIds": [
    "GE381652418TS"
],
    "TrackingNumbers":[
]}

Response

{
    "IsSuccess": true,
    "Data": {
        "SuccessfulTrackingNumbers": [
            {
                "GlobaleOrderID": "GE381652418TS",
                "MerchantOrderID": "381652418",
                "GlobaleParcelCode": "240324091851129-P1",
                "IsTrackingNumberActive": true,
                "TrackingNumber": "GE381652418TS2864637A0",
                "Type": "outbound",
                "TrackingUrl": "https://mailingtechnology.com/tracking/?tn=GE381652418TS2864637A0",
                "ShipperName": "Spring XBS Packet Registered-GlobalE",
                "TrackingEvents": [
                    {
                        "ShipperEventDescription": "The parcel has been created but is waiting to be manifested (i.e. despatched)",
                        "TrackingEventDateTimeInUTC": "2024-03-24T09:19:08",
                        "GlobaleEventCode": "1",
                        "GlobaleEventDescription": "The parcel has been created but is waiting to be manifested (i.e. despatched)",
                        "ShipperEventCode": "0",
                        "TrackingEventStatus": [],
                        "Location": {
                            "FullAddress": null
                        }
                    }
                ]
            },
            {
                "GlobaleOrderID": "GE381652418TS",
                "MerchantOrderID": "381652418",
                "GlobaleParcelCode": "240324091851211-P2",
                "IsTrackingNumberActive": true,
                "TrackingNumber": "GE381652418TS2864637A0",
                "Type": "outbound",
                "TrackingUrl": "https://mailingtechnology.com/tracking/?tn=GE381652418TS2864637A0",
                "ShipperName": "Spring XBS Packet Registered-GlobalE",
                "TrackingEvents": [
                    {
                        "ShipperEventDescription": "The parcel has been created but is waiting to be manifested (i.e. despatched)",
                        "TrackingEventDateTimeInUTC": "2024-03-24T09:19:16",
                        "GlobaleEventCode": "1",
                        "GlobaleEventDescription": "The parcel has been created but is waiting to be manifested (i.e. despatched)",
                        "ShipperEventCode": "0",
                        "TrackingEventStatus": [],
                        "Location": {
                            "FullAddress": null
                        }
                    }
                ]
            },
            {
                "GlobaleOrderID": "GE381652418TS",
                "MerchantOrderID": "381652418",
                "GlobaleParcelCode": "24032409185195-P3",
                "IsTrackingNumberActive": true,
                "TrackingNumber": "GE381652418TS2864637A0",
                "Type": "outbound",
                "TrackingUrl": "https://mailingtechnology.com/tracking/?tn=GE381652418TS2864637A0",
                "ShipperName": "Spring XBS Packet Registered-GlobalE",
                "TrackingEvents": [
                    {
                        "ShipperEventDescription": "The parcel has been created but is waiting to be manifested (i.e. despatched)",
                        "TrackingEventDateTimeInUTC": "2024-03-24T09:19:17",
                        "GlobaleEventCode": "1",
                        "GlobaleEventDescription": "The parcel has been created but is waiting to be manifested (i.e. despatched)",
                        "ShipperEventCode": "0",
                        "TrackingEventStatus": [],
                        "Location": {
                            "FullAddress": null
                        }
                    }
                ]
            }
        ],
        "FailedTrackingNumbers": []
    },
    "Errors": null
}

Documentation Portal

Tracking Events API

Overview

Prerequisites

Implementation

Examples