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
connection
string
required

The ID of the connection that the start of the registration returned.

Body

application/json

Asks the vendor to send the PIN that proves a registration.

method
enum<string>
required

How the PIN comes: sms, call or email, to the contact on the account.

Available options:
sms,
call,
email

Response

IntegrationsRegistrationResource

data
IntegrationsRegistrationResource · object
required

Where the registration of the organization's own account with a vendor stands, and the ways the member can prove they own the account.