shedcloud-partner-api 0.5.0

Official Python client for the ShedCloud Partner API

shedcloud-partner-api

Official Python client for the ShedCloud Partner API (/partner/v1/*).

Use this package from Python 3.10+ to call company-scoped Partner API endpoints with an API key (sc_live_…) or OAuth2 client credentials.

Install

pip install shedcloud-partner-api

For local development:

pip install -e ".[dev]"

Hosts

Environment	Host
production (default)	https://go.shedcloud.com
sandbox	https://api.shedcloudtest.com

Pass environment="sandbox" for test, or base_url= for a custom/local override.

Quick start

API key (production)

from shedcloud_partner_api import ShedCloudPartnerClient

client = ShedCloudPartnerClient(
    auth={"type": "api_key", "api_key": "sc_live_..."},
)

stock = client.lot_stock.list({"limit": 50, "purchase_type": "Lot Stock"})
print(stock["total"], stock["data"][0]["title"])

Sandbox

client = ShedCloudPartnerClient(
    environment="sandbox",
    auth={"type": "api_key", "api_key": "sc_live_..."},
)

OAuth2 client credentials

client = ShedCloudPartnerClient(
    auth={
        "type": "oauth",
        "client_id": "...",
        "client_secret": "...",
    },
)

orders = client.orders.list({"status": "Unprocessed", "limit": 25})

Create credentials in the ShedCloud portal under Settings → Developer API.

Resources

Each attribute maps to a section of the hosted reference.

Client attribute	Endpoints
client.lot_stock	GET /partner/v1/lot-stock
client.stock_templates	GET /partner/v1/stock-templates
client.leads	leads CRUD + status
client.quotes	quotes CRUD, convert, line items
client.orders	orders CRUD, contract, payments, line items
client.work_orders	work orders CRUD + status
client.locations	locations CRUD
client.customers	customers CRUD + merge
client.domains	storefront domains (read-only)
client.agreements	B2B agreements + state legal (read-only)
client.products	catalog products + sizes
client.users	users CRUD + roles
client.payments	payments (read-only)
client.documents	documents + download links
client.events	event feed, iterator, redeliver, webhook deliveries
client.configurator_sessions	3D configurator launch sessions

Idempotency and optimistic concurrency

client.quotes.create(body, idempotency_key="uuid-here")
client.orders.update(order_id, body, if_match=record["version"])

Event feed iterator

for event in client.events.iterate({"types": ["order.created"]}):
    handle(event)

Webhook verification

from shedcloud_partner_api import verify_webhook_signature, WEBHOOK_SIGNATURE_HEADER

verify_webhook_signature(
    request.body,
    request.headers[WEBHOOK_SIGNATURE_HEADER],
    webhook_secret,
)

Python field names

Request params and bodies use snake_case in Python (e.g. location_id, default_for_store). The client serializes them to camelCase JSON automatically.

Scopes

See shedcloud_partner_api.PartnerScopes — kept in sync with the API's scope catalog.

Related SDKs

• TypeScript/JavaScript: @shedcloud/partner-api
• Go: github.com/Corland-Partners-LLC/shedcloud-gomod/partnerapi

Publishing (maintainers)

Releases are automated via .github/workflows/publish.yml when a GitHub Release is published.

One-time PyPI trusted publisher setup:

1. pypi.org → your project → Publishing → Add a new pending publisher
2. Owner: Corland-Partners-LLC, repository: shedcloud-pypi, workflow: publish.yml, environment: pypi
3. GitHub repo → Settings → Environments → create environment pypi (optional approval rules)

Cut a release:

1. Bump version in pyproject.toml and src/shedcloud_partner_api/__init__.py
2. Update CHANGELOG.md, commit, tag: git tag v0.5.0 && git push origin v0.5.0
3. GitHub → Releases → Draft a new release from the tag → Publish release

CI runs lint + tests, builds sdist/wheel, and uploads to PyPI.

License

MIT