Create share link

post

https://api.sensos.io/v1/accounts/{accountId}/shipments/{shipmentId}/shareLink

Generates a shareable URL for a shipment tracking page. The link can be used to embed shipment tracking in an iframe or shared directly with external parties. You should cache this link throughout its validity to avoid generating new links every time.

Path Params

accountId

string

required

The account ID associated with the shipment.

shipmentId

string

required

The shipment ID to generate a share link for.

Body Params

Share link configuration.

Request data for generating a share link for a shipment.

ttl

int64

≤ 32000000

Time to live in seconds for the share link. Maximum value is 32000000 seconds (approximately 1 year).

includeAlerts

boolean

Include alert information in the shared tracking page.

includeReports

boolean

Include report information in the shared tracking page.

includeMilestones

boolean

Include milestone information in the shared tracking page.

includeCarrierEvents

boolean

Include carrier event information in the shared tracking page.

includeRoute

boolean | null

Include route information in the shared tracking page.

includeDocuments

boolean

Include document information in the shared tracking page.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Success