Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

vendor
enum<string>
required

The integration's vendor key, such as fedex or shopify. A system StockShift connects to, or plans to. One without a connector yet is listed in the directory as coming soon.

Available options:
shopify,
woocommerce,
bigcommerce,
amazon,
etsy,
squarespace,
tiktok_shop,
quickbooks_online,
quickbooks_desktop,
xero,
shipstation,
easypost,
shippo,
shipbob,
shiphero,
sps_commerce,
orderful,
stedi,
katana,
hubspot,
salesforce,
avalara,
taxjar,
zapier,
make,
slack,
digikey,
dhl_express,
fedex,
ups,
usps,
onshape

Body

application/json

Connecting a vendor with a key, for the page and the API alike. The key is tried against the vendor before anything is kept.

label
string
required

What to call the connection, such as Main store.

Maximum string length: 80
fields
object
required

The key and secret by field name, such as api_key. Which fields a vendor takes is in its connect form; leave it out for one that takes none, such as QuickBooks Desktop, whose password StockShift makes.

capabilities
enum<string>[] | null

What to enable, such as exports_stock_levels. Leave it out to enable everything the integration can do.

One thing a connection can do, such as importing orders or buying labels. Each integration offers some of them, and the organization turns on the ones it wants for each connection.

Available options:
imports_products,
exports_products,
exports_stock_levels,
imports_orders,
exports_fulfillments,
posts_invoices,
posts_bills,
posts_journals,
posts_payments,
syncs_accounting_contacts,
reads_chart_of_accounts,
rates_shipments,
buys_labels,
tracks_shipments,
imports_migration_data,
exports_data,
sends_fulfillment_requests,
sends_inbound_notices,
reports_warehouse_stock,
calculates_tax,
receives_webhooks,
syncs_crm_accounts,
imports_deals,
exports_sales_activity,
posts_chat_messages,
quotes_part_pricing,
imports_cad_boms
region_acknowledged
boolean | null

True when the person accepts that the vendor processes data outside the organization's region.

settings
object

The integration's settings, for one that tries its key with them, such as Avalara AvaTax's environment and companyCode. Which settings it takes is in its connect form.

Response

ConnectionResource

data
ConnectionResource · object
required

A connection between the organization and an outside system, such as a store, a carrier or an accounting ledger. It never includes a token, key or secret: those are kept encrypted and can't be read through the API.