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

La première étape de l'enregistrement du compte propre à l'organisation auprès d'un fournisseur qui émet lui-même la clé, comme FedEx. L'adresse doit correspondre à celle que le fournisseur a au dossier pour le compte.

account_number
string
requis

Le numéro de compte, de 9 à 12 chiffres. Un numéro de compte FedEx en compte neuf.

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

La rue de l'adresse de livraison ou de facturation que le fournisseur a au dossier pour le compte.

Maximum string length: 100
city
string
requis

La ville de l'adresse que le fournisseur a au dossier pour le compte.

Maximum string length: 60
postal_code
string
requis

Le code postal de l'adresse que le fournisseur a au dossier pour le compte.

Maximum string length: 12
country
string
requis

Le pays, sous forme de code ISO 3166-1 alpha-2 comme US.

Required string length: 2
label
string | null

Le nom de la connexion, par exemple FedEx. Inutile lors du nouvel enregistrement d'une connexion.

Maximum string length: 80
name
string | null

Le nom du titulaire du compte tel que le fournisseur l'a. Obligatoire lorsque company est omis.

Maximum string length: 100
company
string | null

L'entreprise du compte. Obligatoire lorsque name est omis.

Maximum string length: 100
line2
string | null

La deuxième ligne de l'adresse municipale, comme un bureau ou une unité.

Maximum string length: 100
region
string | null

Le code de l'État ou de la province, comme TN.

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

Les capacités à activer, par exemple buys_labels. Omettez-les 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 le membre accepte que le fournisseur traite des données hors de la région de l'organisation.

connection
string<uuid> | null

L'ID d'une connexion qui demande de l'attention, pour l'enregistrer de nouveau. Omettez-le pour créer une nouvelle connexion.

Réponse

IntegrationsRegistrationResource

data
IntegrationsRegistrationResource · object
requis

Où en est l'enregistrement du compte propre de l'organisation auprès d'un fournisseur, et les moyens dont le membre dispose pour prouver qu'il en est le titulaire.