API & Custom Integrations

Private-beta access for approved website, inventory, and business-system connections.

Home
/ API & Custom Integrations

Controlled pilot · Not a general-availability public API

Connect SleekSync to the workflow your business actually needs

SleekSync API access is not a self-service public product. We review each integration first, then confirm whether the required production services are enabled for that tenant. Do not plan a launch until the POS displays an assigned base URL and the tenant owner can create a scoped key.

Request from the POS Contact integration team Walk through your use case Download OpenAPI 3.1

Good fits for the private beta

We start with the business outcome, then confirm whether an API, embed, import, export, or managed integration is the safest route.

Website catalog and availability

Publish approved product and availability data without exposing your POS database or staff credentials.

Website inquiries

Route a customer request from your website into an agreed SleekSync workflow for staff follow-up.

Shopify and partner POS inventory

Pilot guarded inventory-level synchronization with an explicit source of truth, stale-write protection, and tenant-scoped credentials.

Custom automation

Connect an approved internal tool or partner system after field mapping, permission, and security review.

How access works

Request the review from the POS

Open Settings > Integrations > API Access and record the connecting system, data direction, inventory owner, expected volume, and target launch date.

Confirm scope and safeguards

We review tenant boundaries, required fields, update rules, authentication, and launch responsibilities with you.

Enable a pilot and test

If the pilot is approved and deployed for your tenant, the designated administrator creates an expiring, scoped key in POS Settings and validates representative data before launch.

Private API v1 pilot contract

These routes document the controlled v1 implementation under validation; they are not evidence that your tenant is enabled. Begin development only after POS Settings → Integrations → API Access shows your assigned base URL. Send the key as a Bearer token from your server; browser requests containing an Origin header are rejected to reduce accidental credential exposure.

GET/healthany active key

Verifies the key, tenant API switch, rate limiter, and assigned base URL before integration work begins.

Inputs: no query parameters

GET/rental/policyinventory:read

Returns the effective rental period, extension allowance, three-dress cap, turnaround periods, and late fee for the tenant or store.

Inputs: optional store_id

GET/catalogcatalog:read

Returns the tenant's catalog with product details, images, aggregate inventory fields, and approved prices.

Inputs: limit (1–100), after (SKU cursor), category_id, store_id (filters inventory and store-scoped prices)

GET/inventory/availabilityinventory:read

Returns canonical current quantities and policy-compliant date-scoped rental availability by SKU.

Inputs: limit, after or skus (maximum 50), store_id, and an optional pickup_date/return_date pair

PUT/inventory/levelsinventory:write

Compare-and-sets one published SKU level. It can remove only API-created available units—never native, rented, sold, or connector-owned garments.

Inputs: JSON body with sku, store_id, available_quantity, expected_available_quantity, plus an Idempotency-Key header

POST/inquiriesinquiries:write

Accepts a website or partner inquiry with up to three dresses for staff follow-up. external_id safely replays only the same normalized payload.

Inputs: JSON body; maximum 64 KB, policy-compliant rental dates, and metadata up to 8 KB

Read the catalog

curl "$SLEEKSYNC_API_BASE_URL/catalog?limit=25" \
  -H "Authorization: Bearer $SLEEKSYNC_API_KEY"

Set an inventory level

curl "$SLEEKSYNC_API_BASE_URL/inventory/levels" \
  -X PUT \
  -H "Authorization: Bearer $SLEEKSYNC_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: shopify-level-1042" \
  -d '{
    "sku": "SHOP-SKU-1",
    "store_id": 12,
    "available_quantity": 8,
    "expected_available_quantity": 6
  }'

Submit an inquiry

curl "$SLEEKSYNC_API_BASE_URL/inquiries" \
  -X POST \
  -H "Authorization: Bearer $SLEEKSYNC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "web-1042",
    "customer_name": "Jordan Lee",
    "customer_email": "[email protected]",
    "pickup_date": "2026-10-17",
    "return_date": "2026-10-24",
    "requested_items": [
      { "sku": "DR-100", "size": "M" },
      { "sku": "DR-200", "size": "8" }
    ],
    "message": "Please confirm which dress is available",
    "source": "website"
  }'

Authentication and key lifecycle

1. SleekSync approves and production-validates the tenant.
2. Once enabled, the designated administrator creates a 30, 90, 180, or 365-day key.
3. The raw key is displayed once; SleekSync stores only its hash.
4. The administrator can review recent activity and revoke a key immediately.

Responses, limits, and retries

• Default limit: 120 requests per minute, per key.
• Rate headers include limit, remaining requests, and reset time.
• List responses use limit, has_more, and next_cursor.
• Errors include a stable code, message, and request_id.
• A repeated inquiry external_id and payload returns the original record; changed data with that ID returns 409.
• Inventory writes require an expected quantity and an Idempotency-Key; stale or protected changes return 409.
• Retry 429 responses after the Retry-After interval.

Credential safety

Never send an API key by email or WhatsApp, expose it in client-side code, store it in a public repository, or substitute a POS password, database credential, payment secret, or Supabase service-role key.

Bring us the system and the workflow

Include the system name, the data you need to read or update, expected volume, and your target launch date. We will tell you clearly what is supported now and what would require custom work.

Request API or integration access

Prefer email? [email protected]