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

The first step of registering the organization's own account with a vendor that issues the key itself, such as FedEx. The address must match the one the vendor has on file for the account.

account_number
string
required

The account number, 9 to 12 digits. A FedEx account number has nine.

Pattern: ^\d{9,12}$
line1
string
required

The street of the shipping or billing address the vendor has on file for the account.

Maximum string length: 100
city
string
required

The city of the address the vendor has on file for the account.

Maximum string length: 60
postal_code
string
required

The postal or ZIP code of the address the vendor has on file for the account.

Maximum string length: 12
country
string
required

The country, as an ISO 3166-1 alpha-2 code such as US.

Required string length: 2
label
string | null

The connection's name, such as FedEx. Not needed when registering a connection again.

Maximum string length: 80
name
string | null

The account holder's name as the vendor has it. Required when company is left out.

Maximum string length: 100
company
string | null

The company on the account. Required when name is left out.

Maximum string length: 100
line2
string | null

The second line of the street address, such as a suite or unit.

Maximum string length: 100
region
string | null

The state or province code, such as TN.

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

The capabilities to turn on, such as buys_labels. Leave it out to turn on 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 member accepts that the vendor processes data outside the organization's region.

connection
string<uuid> | null

The ID of a connection that needs attention, to register it again. Leave it out to make a new connection.

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.