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 vendor ID 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,
xero,
shipstation,
easypost,
shippo,
shipbob,
shiphero,
sps_commerce,
orderful,
stedi,
katana,
hubspot,
avalara,
zapier,
make,
slack,
digikey

Body

application/json

Starting an OAuth connection, for the page and the API alike. The plan feature comes from the vendor, never from the request.

label
string | null

What to call the connection, such as Main store. Not needed when signing in again.

Maximum string length: 80
capabilities
enum<string>[] | null

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

One thing a connector can do for a connection. Each case has a contract: a connector has the capability when it implements that contract, and the category cores add the contract's methods.

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
region_acknowledged
boolean | null

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

connection
string<uuid> | null

A connection that needs attention, to sign in again instead of making a new one.

answer
string | null

The answer to the question the integration asks before connecting, such as the marketplace id of an Amazon store.

Maximum string length: 100
store_domain
string | null

The store to connect, such as acme.myshopify.com, for an integration that connects one store at a time.

Maximum string length: 255

Response

AuthorizationResource

data
AuthorizationResource · object
required