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

El primer paso para registrar la cuenta propia de la organización con un proveedor que emite la clave por sí mismo, como FedEx. La dirección debe coincidir con la que el proveedor tiene registrada para la cuenta.

account_number
string
requerido

El número de cuenta, de 9 a 12 dígitos. Un número de cuenta de FedEx tiene nueve.

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

La calle de la dirección de envío o de facturación que el proveedor tiene registrada para la cuenta.

Maximum string length: 100
city
string
requerido

La ciudad de la dirección que el proveedor tiene registrada para la cuenta.

Maximum string length: 60
postal_code
string
requerido

El código postal o ZIP de la dirección que el proveedor tiene registrada para la cuenta.

Maximum string length: 12
country
string
requerido

El país, como código ISO 3166-1 alfa-2, como US.

Required string length: 2
label
string | null

El nombre de la conexión, como FedEx. No hace falta al registrar una conexión de nuevo.

Maximum string length: 80
name
string | null

El nombre del titular de la cuenta como lo tiene el proveedor. Es obligatorio cuando se omite company.

Maximum string length: 100
company
string | null

La empresa de la cuenta. Es obligatoria cuando se omite name.

Maximum string length: 100
line2
string | null

La segunda línea de la dirección, como un local o una unidad.

Maximum string length: 100
region
string | null

El código del estado o la provincia, como TN.

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

Las capacidades que se activan, como buys_labels. 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

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

connection
string<uuid> | null

El ID de una conexión que necesita atención, para registrarla de nuevo. Omítelo para crear una conexión nueva.

Respuesta

IntegrationsRegistrationResource

data
IntegrationsRegistrationResource · object
requerido

En qué situación está el registro de la cuenta propia de la organización con un proveedor, y las formas en que el miembro puede demostrar que es dueño de la cuenta.