Saltar al contenido principal
POST
cURL

Autorizaciones

Authorization
string
header
requerido

Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.

Parámetros de ruta

vendor
enum<string>
requerido

La clave de proveedor de la integración, como fedex o shopify. Un sistema al que StockShift se conecta, o planea conectarse. Uno que aún no tiene conector aparece en el directorio como próximamente.

Opciones 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

Cuerpo

application/json

Conecta un proveedor externo con una clave, tanto para la página como para la API. La clave se prueba con el proveedor externo antes de conservar nada.

label
string
requerido

Cómo llamar a la conexión, como Main store.

Maximum string length: 80
fields
object
requerido

La clave y el secreto por nombre de campo, como api_key. Los campos que acepta un proveedor están en su formulario de conexión; omítelo para uno que no acepta ninguno, como QuickBooks Desktop, cuya contraseña genera StockShift.

capabilities
enum<string>[] | null

Qué activar, como exports_stock_levels. Omítelo para activar todo lo que puede hacer la integración.

Una cosa que puede hacer una conexión, como importar pedidos o comprar etiquetas. Cada integración ofrece algunas de ellas, y la organización activa las que quiere para cada conexión.

Opciones 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

Es true cuando la persona acepta que el proveedor procese datos fuera de la región de la organización.

settings
object

Los ajustes de la integración, para una que prueba su clave con ellos, como el entorno y companyCode de Avalara AvaTax. Los ajustes que acepta están en su formulario de conexión.

Respuesta

ConnectionResource

data
ConnectionResource · object
requerido

Una conexión entre la organización y un sistema externo, como una tienda, un transportista o un libro contable. Nunca incluye un token, una clave ni un secreto: se guardan cifrados y no se pueden leer a través de la API.