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

The proof that finishes a registration: the PIN the vendor sent, the details of a recent invoice, or support when the vendor's support team already confirmed the account.

method
enum<string>
required

How the account is proven: sms, call or email with the PIN, invoice, or support.

Available options:
invoice,
sms,
call,
email,
support
pin
string | null

The six digit PIN the vendor sent.

Pattern: ^\d{6}$
invoice_number
string | null

The number of an invoice from the last 90 days.

Pattern: ^\d{1,20}$
invoice_date
string<date> | null

The invoice's date, as YYYY-MM-DD.

invoice_amount
number | null

The invoice's amount, such as 222.50.

Required range: 0 <= x <= 99999999
invoice_currency
string | null

The invoice's currency, such as USD.

Required string length: 3

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.