Skip to main content
Skip to main content

TrackingLink

A tracking link holds information about tracking numbers for a Fulfillment. Tracking Links can optionally contain a URL that can be visited to see the status of the shipment. Typically, the tracking link is provided from the third-party service integrated through the used fulfillment provider.

Properties

created_atDateRequired
The date with timezone at which the resource was created.
deleted_atnull | DateRequired
The date with timezone at which the resource was deleted.
fulfillmentFulfillmentRequired
The details of the fulfillment that the tracking link belongs to.
fulfillment_idstringRequired
The ID of the fulfillment that the tracking link belongs to.
idstringRequired
The tracking link's ID
idempotency_keystringRequired
Randomly generated key used to continue the completion of a process in case of failure.
metadataRecord<string, unknown>Required
An optional key-value map with additional details
tracking_numberstringRequired
The tracking number given by the shipping carrier.
updated_atDateRequired
The date with timezone at which the resource was updated.
urlstringRequired
The URL at which the status of the shipment can be tracked.
Was this section helpful?