Metadata-Version: 2.4
Name: traceapi-sdk
Version: 0.3.0
Summary: Official server-side Python client for Trace shipment tracking
License-Expression: MIT
Project-URL: Homepage, https://traceapi.dev/docs
Project-URL: Repository, https://github.com/traceapi-dev/trace-ui/tree/main/clients/python
Keywords: tracking,shipment,traceapi,webhooks
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Official Trace Python client - 0.3.0

```sh
pip install https://traceapi.dev/downloads/traceapi_sdk-0.3.0-py3-none-any.whl
```

```python
import os
from traceapi import Trace, TraceError, verify_webhook
trace = Trace(os.environ['TRACE_API_KEY'])
# Sandbox exercises authentication without a carrier lookup.
example = trace.sandbox('delivered')
result = trace.track('YOUR_NUMBER', carrier='ups')
```

Requires Python 3.11+. Source is public at
https://github.com/traceapi-dev/trace-ui/tree/main/clients/python.
The future registry command is `pip install traceapi-sdk==0.3.0`; use the pinned
download until registry publication is confirmed.

Server-side client for tracking, order-linked shipments, imports, action feeds,
merchant cohorts and webhook recovery. See https://traceapi.dev/docs#official-clients
for versioned download/install instructions and the full API reference.

Models are generated from the public OpenAPI contract by npm run sdk:generate.
Unknown timezone timestamps remain null. Import success means record creation;
verified carrier acquisition is a separate asynchronous outcome.

Defaults: timeout 95 seconds per attempt, at most two retries on confirmed
429/503 for reads or supported idempotent creates, honoring Retry-After up to
60 seconds. Ambiguous transport errors and non-idempotent actions are surfaced
without retries. Explicit webhook replay never silently repeats.

Verify webhook signatures on raw bytes within five minutes, accepting any
matching v1 signature during rotation overlap. Deduplicate event IDs after
verification. Keep API keys/signing secrets on your server.

Pin this 0.x version; future 0.x releases may break compatibility. New /v1
response fields are additive; clients must tolerate them. Download artifacts
are served by Trace; registry publication is separate. MIT license covers SDK
code only. Python requires 3.11+; the TypeScript client requires Node 22+.
