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
id
stringRequiredThe tracking link's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
deleted_at
null | DateRequiredThe date with timezone at which the resource was deleted.
url
stringRequiredThe URL at which the status of the shipment can be tracked.
tracking_number
stringRequiredThe tracking number given by the shipping carrier.
fulfillment_id
stringRequiredThe ID of the fulfillment that the tracking link belongs to.
The details of the fulfillment that the tracking link belongs to.
idempotency_key
stringRequiredRandomly generated key used to continue the completion of a process in case of failure.
metadata
Record<string, unknown>RequiredAn optional key-value map with additional details
Was this section helpful?