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

Démarrage d'une connexion OAuth, pour la page comme pour l'API. La fonctionnalité du forfait vient du fournisseur, jamais de la requête.

label
string | null

Le nom à donner à la connexion, comme Boutique principale. Inutile lors d'une nouvelle connexion.

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

Ce qu'il faut activer, comme imports_orders. 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.

connection
string<uuid> | null

Une connexion qui demande de l'attention, pour se connecter à nouveau au lieu d'en créer une nouvelle.

answer
string | null

La réponse à la question que l'intégration pose avant la connexion, par exemple l'ID de place de marché d'une boutique Amazon.

Maximum string length: 100
store_domain
string | null

La boutique à connecter, comme acme.myshopify.com, pour une intégration qui connecte une boutique à la fois.

Maximum string length: 255

Réponse

AuthorizationResource

data
AuthorizationResource · object
requis

Où envoyer un membre pour approuver une connexion OAuth chez le fournisseur.