API and webhooks

This help-center article is the plain-language overview. Full technical reference lives in the product docs and OpenAPI—not on the marketing site alone.

When to use the API

Use the Shipora Partner API when you need to:

• Create or list orders from your own backend / website

• Read business and location data for integrations

• Automate dispatch intake beyond Square

Prefer Square (or another built-in integration) when you’re already on that POS and don’t need custom software.

Where the real docs live

• Resource: Partner API guide (keys, auth, examples) · URL: https://app.shipora.com/docs/api

• Resource: OpenAPI / Swagger (try requests, schemas) · URL: https://api.shipora.com/docs

Create and revoke API keys in the console under Settings → Integrations → Shipora API (plan-gated; typically Pro). Keys look like `shp_live_…` and are sent as `Authorization: Bearer …` or `X-Api-Key`.

What the Partner API covers (high level)

Authenticated with a business API key, partners can work with:

• Business profile (scoped)

• Locations

• Orders — list, get, create

Capabilities expand over time—always check the live OpenAPI for exact paths and fields.

Webhooks

For event-driven updates (order status changes, etc.), see the Partner API guide and OpenAPI for the current webhook story. If your integration needs push events, start from app.shipora.com/docs/api rather than this overview page.

Help center vs developer docs

• These guides (`shipora.com/documentation`): How people use the console and driver app · Developer docs: How software calls Shipora

• These guides (`shipora.com/documentation`): Roles, POD, Square OAuth for operators · Developer docs: Auth headers, payloads, errors

• These guides (`shipora.com/documentation`): Written for owners and dispatchers · Developer docs: Written for engineers

Security basics

• Treat API keys like passwords—show once at create, store in a secrets manager

• Rotate/revoke keys if a vendor or employee leaves

• Never embed live keys in mobile apps or public repos

• Use HTTPS only (`api.shipora.com`)

Next steps

1. Open app.shipora.com/docs/api

2. Create a key under Settings → Integrations → Shipora API

3. Explore api.shipora.com/docs

4. Create a test order, then confirm it on the dispatch board