# ShedCloud Partner API

> Public, company-scoped REST API for ShedCloud (shed/portable-building dealer & manufacturer platform). All resource endpoints live under /partner/v1. Authenticate with a company API key (Bearer sc_live_... / sc_test_...) or an OAuth2 client_credentials access token from POST /oauth/token; both resolve to the same scoped identity. The API is additive-only within v1 (fields are never renamed, retyped, or removed).

Hosts: production https://go.shedcloud.com, sandbox https://api.shedcloudtest.com (identical contract, environment-specific credentials).

Resources: lot-stock, stock-templates, leads, quotes, orders, work-orders, locations, customers, products, domains, users, roles, payments, documents, events, webhook-deliveries, configurator-sessions. Writes support Idempotency-Key; updates support If-Match; every list endpoint is cursor/offset paginated.

## Docs

- [Full API reference (Markdown)](https://go.shedcloud.com/partner/reference.md): every endpoint, parameter, scope, and example in one Markdown file — the best single document for an AI agent
- [OpenAPI specification (JSON)](https://go.shedcloud.com/partner/openapi.json): machine-readable schema of all /partner/v1 routes
- [OpenAPI specification (YAML)](https://go.shedcloud.com/partner/openapi.yaml): same spec in YAML
- [Changelog (Markdown)](https://go.shedcloud.com/partner/changelog.md): dated, additive-only change history with SDK version mapping

## Human docs

- [Reference guide (HTML)](https://go.shedcloud.com/partner/reference): Stripe-style browsable reference
- [Interactive Swagger UI](https://go.shedcloud.com/partner/docs/): try requests against the spec

## SDKs

- [TypeScript/JavaScript SDK](https://www.npmjs.com/package/@shedcloud/partner-api): npm @shedcloud/partner-api
- [Go SDK](https://github.com/Corland-Partners-LLC/shedcloud-gomod): github.com/Corland-Partners-LLC/shedcloud-gomod/partnerapi
- [Python SDK](https://pypi.org/project/shedcloud-partner-api/): PyPI shedcloud-partner-api
- [PHP SDK](https://github.com/Corland-Partners-LLC/shedcloud-php): Composer shedcloud/partner-api
- [Ruby SDK](https://github.com/Corland-Partners-LLC/shedcloud-gem): RubyGems shedcloud-partner_api