cURL
curl --request POST \
--url https://app.stockshift.io/api/v1/integrations/migrations/{migration}/columns/{entity}/suggest \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"include_samples": true
}
'import requests
url = "https://app.stockshift.io/api/v1/integrations/migrations/{migration}/columns/{entity}/suggest"
payload = { "include_samples": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/integrations/migrations/{migration}/columns/{entity}/suggest",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'include_samples' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.stockshift.io/api/v1/integrations/migrations/{migration}/columns/{entity}/suggest"
payload := strings.NewReader("{\n \"include_samples\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"id": "<string>",
"name": "<string>",
"source": "generic_csv",
"status": "uploading",
"problem": "<string>",
"report": {},
"ignored_files": [
"<string>"
],
"include_samples_for_ai": true,
"ai_available": true,
"committed_at": "<string>",
"rolled_back_at": "<string>",
"created_at": "<string>",
"entities": [
{
"entity": "units",
"label": "<string>",
"file": "<string>",
"rows": 123,
"columns": [
{
"source_column": "<string>",
"target_field": "<string>",
"suggested_by": "profile",
"suggested_field": "<string>",
"confidence": 123,
"samples": [
"<string>"
]
}
],
"fields": [
{
"name": "<string>",
"label": "<string>",
"required": true,
"type": "text",
"example": "<string>",
"key": true,
"references": "units",
"choices": [
"<string>"
]
}
]
}
]
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}Migraciones
Sugiere asignaciones de columnas con IA
Pide al asignador con IA un campo de destino para cada columna de una entidad. El asignador ve los nombres de las columnas y hasta cinco valores de muestra por columna, con los datos personales enmascarados a menos que include_samples sea true. Nunca ve una fila de un artículo controlado. Una vez que se envían muestras sin enmascarar, esa elección se conserva en la migración y queda registrada en el historial de auditoría. Una sugerencia se aplica solo cuando un miembro la confirma asignando las columnas. Se rechaza cuando la asignación de columnas con IA está desactivada para la organización, y siempre en el entorno federal. La solicitud queda registrada en el historial de auditoría. Requiere el permiso integrations.migrate y un token con integrations:write.
POST
/
integrations
/
migrations
/
{migration}
/
columns
/
{entity}
/
suggest
cURL
curl --request POST \
--url https://app.stockshift.io/api/v1/integrations/migrations/{migration}/columns/{entity}/suggest \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"include_samples": true
}
'import requests
url = "https://app.stockshift.io/api/v1/integrations/migrations/{migration}/columns/{entity}/suggest"
payload = { "include_samples": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/integrations/migrations/{migration}/columns/{entity}/suggest",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'include_samples' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.stockshift.io/api/v1/integrations/migrations/{migration}/columns/{entity}/suggest"
payload := strings.NewReader("{\n \"include_samples\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"id": "<string>",
"name": "<string>",
"source": "generic_csv",
"status": "uploading",
"problem": "<string>",
"report": {},
"ignored_files": [
"<string>"
],
"include_samples_for_ai": true,
"ai_available": true,
"committed_at": "<string>",
"rolled_back_at": "<string>",
"created_at": "<string>",
"entities": [
{
"entity": "units",
"label": "<string>",
"file": "<string>",
"rows": 123,
"columns": [
{
"source_column": "<string>",
"target_field": "<string>",
"suggested_by": "profile",
"suggested_field": "<string>",
"confidence": 123,
"samples": [
"<string>"
]
}
],
"fields": [
{
"name": "<string>",
"label": "<string>",
"required": true,
"type": "text",
"example": "<string>",
"key": true,
"references": "units",
"choices": [
"<string>"
]
}
]
}
]
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}Autorizaciones
apiKeyoauth2
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
El ID de la migración cuyas columnas reciben sugerencias.
La entidad cuyas columnas reciben sugerencias, como items o boms.
Cuerpo
application/json
Pide al asignador de columnas con IA que sugiera campos de destino para una entidad.
Si se envían sin enmascarar los valores de muestra de las columnas que parecen datos de personas. Una vez en true, se queda activado para esta migración, y la elección queda registrada en el historial de auditoría. El valor predeterminado es false.
Respuesta
MigrationResource
Una migración: un traslado de registros a la organización desde archivos CSV o una conexión, con su estado e informe de verificación. Sus entidades se enumeran solo cuando se muestra una migración.
Show child attributes
Show child attributes
¿Esta página le ayudó?