Python SDK
Python client for the Linkit public API.
Python SDK
Runtime: Python 3.11 or later.
Extract the source archive and make its src directory available on your application's import path. The required runtime libraries are listed in pyproject.toml: httpx with HTTP/2 support and msgspec.
orders.get and orders.list decode the served order envelopes. get_canonical, list_canonical, changes and iter_changes expose canonical data and the cursor feed. Generated public_api calls return raw JSON bytes; decode those bytes with your application's JSON reader.
Connect
import asyncio
from linkit import LinkitClient, LinkitConfiguration
async def main():
configuration = LinkitConfiguration(base_url="https://linkit.works", jwt_token=token)
async with LinkitClient.create(configuration) as client:
order = await client.orders.get("order-record-id")
print(order.id)
asyncio.run(main())API use
Use the server origin, such as https://linkit.works, as the base URL. Pass IDs as stored; the SDK adds /api/v1 and escapes path parameters. A branch's iv_id, its record id, a product ID and a SKU's iv_id are different identifiers.
Create branches and products before the SKUs that refer to them. Create orders with existing tenant records and a stable source identity. Order reads return snapshot envelopes; canonical reads normalize channel, status, amounts and lines. Persist the change-feed cursor after processing a page. A 304 means no changes; a 410 requires a new snapshot and cursor.
The generated public API service covers all 136 published operations. It also exposes customer addresses and groups, catalog metadata, offers, payment flows, queue status, analytics and webhook subscription management. Consult the API reference for each request body's fields. A method's route coverage does not grant permission to call it.
POST and PATCH are sent once. GET, HEAD, OPTIONS, PUT and DELETE may be retried after transient failures. Confirm the result of an uncertain write before repeating it. Health and ping omit bearer authentication; system health requires it.
Branch creation uses the dashboard's wallet rules. Trial and grace accounts are exempt; later, a shortfall returns BILLING_INSUFFICIENT_WALLET_BALANCE with the required and available SAR amounts. Only successfully inserted new branches incur activation fees.
Order deletion
The existing raw delete_orders_bulk method has no body argument, so it cannot supply the order_ids required by bulk deletion. For individual deletes, call client.public_api.delete_v1_orders(id) for each order and check each result; separate deletes are not an atomic batch.