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
connection
string
requis

L'ID de la connexion que le début de l'enregistrement a renvoyée.

Corps

application/json

La preuve qui termine une inscription : le NIP que le fournisseur a envoyé, les détails d'une facture récente, ou support lorsque l'équipe de soutien du fournisseur a déjà confirmé le compte.

method
enum<string>
requis

Comment le compte est prouvé : sms, call ou email avec le NIP, facture ou soutien.

Options disponibles:
invoice,
sms,
call,
email,
support
pin
string | null

Le NIP à six chiffres que le fournisseur a envoyé.

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

Le numéro d'une facture des 90 derniers jours.

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

La date de la facture, sous forme YYYY-MM-DD.

invoice_amount
number | null

Le montant de la facture, comme 222.50.

Plage requise: 0 <= x <= 99999999
invoice_currency
string | null

La devise de la facture, comme USD.

Required string length: 3

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.