Passer au contenu principal
POST
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Paramètres de chemin

vendor
enum<string>
requis

La clé de fournisseur de l'intégration, comme fedex ou shopify. Un système auquel StockShift se connecte, ou prévoit de se connecter. Un système sans connecteur pour l'instant figure au répertoire comme à venir.

Options disponibles:
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

Corps

application/json

Connecter un fournisseur avec une clé, pour la page comme pour l'API. La clé est essayée auprès du fournisseur avant que quoi que ce soit soit conservé.

label
string
requis

Le nom à donner à la connexion, comme Boutique principale.

Maximum string length: 80
fields
object
requis

La clé et le secret par nom de champ, comme api_key. Les champs qu'un fournisseur accepte figurent dans son formulaire de connexion ; omettez-le pour un fournisseur qui n'en accepte aucun, comme QuickBooks Desktop, dont StockShift génère le mot de passe.

capabilities
enum<string>[] | null

Ce qu'il faut activer, comme exports_stock_levels. Omettez-le pour activer tout ce que l'intégration peut faire.

Une chose qu'une connexion peut faire, par exemple importer des commandes ou acheter des étiquettes. Chaque intégration en offre certaines, et l'organisation active celles qu'elle veut pour chaque connexion.

Options disponibles:
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 lorsque la personne accepte que le fournisseur traite des données hors de la région de l'organisation.

settings
object

Les paramètres de l'intégration, pour une intégration qui essaie sa clé avec eux, comme l'environnement et le companyCode d'Avalara AvaTax. Les paramètres qu'elle accepte figurent dans son formulaire de connexion.

Réponse

ConnectionResource

data
ConnectionResource · object
requis

Une connexion entre l'organisation et un système externe, comme une boutique, un transporteur ou un grand livre comptable. Elle n'inclut jamais de jeton, de clé ni de secret : ils sont conservés chiffrés et ne peuvent pas être lus par l'API.