Skip to main content
POST
Get tracking events
The Get Tracking Events API lets you receive status events on the delivery status of an order — a list of either forward shipments after checkout completion (outbound) or returns (inbound), up to 100 per call — and returns their status. Having tracking events for return shipments also lets refunds be triggered automatically upon confirmation of returned-item receipt (or any other tracking event).
Prerequisite — one direction per request. A request may include a list of Global-e order IDs, a list of tracking numbers, or both — but all the same type: inbound or outbound. Inbound and outbound cannot be mixed; to request both, issue two separate requests.
The full list of tracking events reported by Global-e (GlobaleEventCodeGlobaleEventDescription), returned in the TrackingEvents array of each successful result:
Returned per item in the FailedTrackingNumbers list. {0} is replaced with the relevant value (order ID, tracking number, or limit).

Headers

MerchantGUID
string
required

Merchant's unique identifier (present in the documented example).

Body

application/json
Type
enum<string>
required

The shipment direction. One of the following - inbound, outbound.

Available options:
inbound,
outbound
EventSinceInUTC
string

Date and time for the earliest time of the order shipment status, UTC, in RFC 2822 format (for example, Fri, 8 Aug 2014 17:13:07 +0000).

OrderIds
string[]

List of Global‑e Order IDs. Up to 100 in each request. Note: each OrderId, string, has prefix GE followed by numbers, in the format GE1234. Max length: 100 chars. One of either OrderIds or TrackingNumbers are mandatory.

TrackingNumbers
string[]

List of Global‑e tracking numbers. Up to 100 in each request, with prefix GE followed by numbers in the format GE1234. Conditional — one of either OrderIds or TrackingNumbers are mandatory.

Response

200 - application/json

Tracking events for the requested orders/tracking numbers. Each successful entry is returned in SuccessfulTrackingNumbers; per-item failures are returned in FailedTrackingNumbers (each carrying an ErrorInfo).

Data
object
Errors
any | null

Present in the documented example (null on success). Shape undocumented.