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

El ID de la conexión que devolvió el inicio del registro.

Cuerpo

application/json

La prueba que termina un registro: el PIN que envió el proveedor, los datos de una factura reciente, o soporte cuando el equipo de soporte del proveedor ya confirmó la cuenta.

method
enum<string>
requerido

Cómo se comprueba la cuenta: sms, call o email con el PIN, invoice o support.

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

El PIN de seis dígitos que envió el proveedor.

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

El número de una factura de los últimos 90 días.

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

La fecha de la factura, como YYYY-MM-DD.

invoice_amount
number | null

El importe de la factura, como 222.50.

Rango requerido: 0 <= x <= 99999999
invoice_currency
string | null

La moneda de la factura, como USD.

Required string length: 3

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.