---
seo:
  description: >-
    An API for external apps a shop has approved. Call it with the access token
    from the OAuth 2.1 authorization code flow (PKCE S256) in Authorization:
    Bearer.…
sidebar:
  label: Overview
title: Toreca Cloud Partner API
---
An API for external apps a shop has approved. Call it with the access token from the OAuth 2.1 authorization code flow (PKCE S256) in `Authorization: Bearer`. The token decides which shop's data you work with.

Every response carries `Cache-Control: no-store`. Errors look like `{ "error": "code" }`.

Version 1

Base URL: `https://api.toreca-cloud.com/partner/v1`

## Connection

Create, check and end the connection with a shop. Either read scope works.

- [`GET /connection`](/en/api/reference/connection/get-connection) — Get the connection.
- [`POST /connection`](/en/api/reference/connection/create-connection) — Create the connection.
- [`DELETE /connection`](/en/api/reference/connection/delete-connection) — End the connection.

## Buy boosts

Cards and BOXes a shop is buying above its usual price. Readable with `purchase-boosts:read`.

- [`GET /purchase-boosts`](/en/api/reference/buy-boosts/list-purchase-boosts) — List buy boosts.

## Inventory

Sync of sites, storage locations and stock units. Needs `inventory:read`.

- [`GET /inventory/sites`](/en/api/reference/inventory/list-sites) — List sites and storage locations.
- [`GET /inventory/changes`](/en/api/reference/inventory/list-changes) — Read inventory changes.
- [`GET /inventory/items/{id}/photos/{side}`](/en/api/reference/inventory/get-item-photo) — Get a unit's photo.

## Card catalog

Search Toreca Cloud's card catalog. Needs `inventory:read`.

- [`GET /cards`](/en/api/reference/card-catalog/search-cards) — Search the card catalog.
- [`GET /cards/{id}`](/en/api/reference/card-catalog/get-card) — Get a card.

## Change notifications

Register a webhook that tells you stock changed. Needs `inventory:read`.

- [`PUT /webhook`](/en/api/reference/change-notifications/set-webhook) — Register the webhook.
- [`DELETE /webhook`](/en/api/reference/change-notifications/delete-webhook) — Remove the webhook.