Quickstart

Create an API key

In StockShift, open Settings > Access > API keys and press New API key. Name it after the system that will use it, tick catalog:read and press Create key.Copy the key straight away. It is shown once and never again.

List your items

Send the key as a bearer token. Paths are relative to https://app.stockshift.io/api/v1, and requests and responses are JSON.

curl https://app.stockshift.io/api/v1/catalog/items \
  -H "Authorization: Bearer $STOCKSHIFT_TOKEN" \
  -H "Accept: application/json"

import { StockShift } from "@stockshift/sdk";

const stockshift = new StockShift({ token: process.env.STOCKSHIFT_TOKEN! });

for await (const item of stockshift.paginate("/catalog/items")) {
  console.log(item.sku, item.name);
}

import os

from stockshift import StockShift

with StockShift(token=os.environ["STOCKSHIFT_TOKEN"]) as stockshift:
    for item in stockshift.catalog.iter_items():
        print(item.sku, item.name)

use StockShift\Sdk\StockShift;

$stockshift = new StockShift(getenv('STOCKSHIFT_TOKEN'));

$page = $stockshift->catalog()->listItems();

Read the answer

A list comes back one page at a time, with a cursor for the next page:

{
  "data": {
    "items": [{ "id": "01J8QZ4M...", "sku": "BOLT-M4", "name": "M4 hex bolt" }],
    "next_cursor": "eyJpZCI6IjAxSjhRWjRN..."
  }
}

Send next_cursor back as after to get the next page. The SDKs do this for you. See Pagination.

Give each key only the scopes its job needs. Permissions and scopes explains the two checks every call passes.
Branch on the code of an error, not its text. See Errors.
Rather than polling for changes, subscribe to webhooks.

Get started

Using the API

Events and apps

Next

​Next

Next