API Adapter

Get List

Version ≥ 3.6

Chiamata per ottenere una lista di dataobject dalla classe indicata, con supporto a paginazione incrementale e campi espandibili. L'endpoint restituisce l'oggetto configurabile con le varianti e sostituisce il campo utilizzato come incrementale prendendo il valore più grande tra gli oggetti e le varianti restituite (in modo che l'aggiornamento di una variabile restituisca tutto l'oggetto).

Download Flow Adapter: Scarica

GET/api/adp/ingress/{className}

Permessi Ruolo o Utente

• Permesso generale per accesso alla risorsa: Objects
• Permesso per l'accesso al tipo di dataobject: {className}
• Permesso per l'accesso al workspace dello specifico path: list

Headers: Autenticazione

Query Params

Nome	Tipo	Default	Descrizione
limit	int	10	Numero massimo di record da restituire
incrementalField	string	-	Campo su cui applicare la paginazione incrementale (es: modificationDate, creationDate)
inheritanceAllowed	bool	true	Se true, consente di ereditare i campi da oggetto configurabile
incrementalValue	string	-	Valore di partenza per la paginazione incrementale (es: 2025-01-15T10:30:28+00:00)
fieldsToExpand	string	null	I campi della classe richiesti separati da virgola, se vuoto sono restituiti tutti i campi. Per le relazioni è necessario separare il campo con il . es.: color.name
relationsToExpand	string	null	Le relazioni da espandere della classe separati da virgola (es.: color )
query	string	-	Filtro di ricerca (es: isVirtualProduct = true AND isGiftCard = true)

Body Response 200 OK

[
    {
        "id": 5432,
        "sku": "67878e2af3e36",
        "modificationDate": "2025-09-23T07:14:43+00:00",
        "creationDate": "2025-01-15T10:29:59+00:00",
        "variants": []
    },
    {
        "id": 5433,
        "sku": "67878e2af3e37",
        "modificationDate": "2025-09-23T07:14:43+00:00",
        "creationDate": "2025-01-15T10:29:59+00:00",
        "variants": []
    }
  ]

---

Upsert Bulk

Version ≥ 3.6

Chiamata per creare o aggiornare dataobject appartenenti alla classe indicata e con i parametri indicati.

POST/api/adp/egress/{class_name}/bulk

Permessi Ruolo o Utente

• Permesso generale per accesso alla risorsa: Objects
• Permesso per l'accesso al tipo di dataobject: {class_name}
• Permesso per l'accesso al workspace dello specifico path: list, save

Headers: Autenticazione

Path Params

Nome	Descrizione
class_name	Nome della classe del data object da recuperare (es: Product, Category)

Query Params

Nome	Tipo	Default	Descrizione
onlyUpdate	bool	false	Se true, aggiorna l’oggetto se esiste. Altrimenti darà eccezione
versioning	bool	false	Se true, abilita il versioning dell’oggetto per mantenere uno storico delle modifiche.
singleTransaction	bool	false	Se true, esegue tutte le operazioni in un'unica transazione SQL.
disableValidation	bool	false	Se true, disabilita la validazione del salvataggio del dataobject.
disableCache	bool	true	Se true, forza il recupero dei dati senza utilizzare la cache.
disableLog	bool	true	Se true, disabilita la generazione di log per l’operazione.
surrogate	string	null	Nome campo univoco per aggiornamento del dataobject, è restituito nella risposta.
garbageSize	int	100	Dimensione massima del batch per operazioni di garbage collection.
output	string	result	Definisce l'output restituito dall’operazione (es. result = OK o KO, full = intero dataobject).

Body Request

{
    "action": "execute",
    "messages": [
        {
            "msgId": "640ee776f545844f1472f0bc",
            "msg": {
                "isGiftCard": false,
                "sku": "67878e279a2fe",
                .... altri campi
            },
            "meta": {}
        },
        {
            "msgId": "643aa776f545844f1472f0bc",
            "msg": {
            ... body altro prodotto
            },
            "meta": {}
        }
    ],
    "requestId": "da7314de6b50407c9bf1b99acdadf65f",
    "meta": {}
}

Body Response 200 OK

{
    "requestId": "da7314de6b50407c9bf1b99acdadf65f",
    "isAsync": false,
    "messages": [
        {
            "msgId": "640ee776f545844f1472f0bc",
            "status": "Success",
            "date": "2025-10-13T07:04:22+00:00",
            "errorMessage": null
        },
        {
            "msgId": "643aa776f545844f1472f0bc",
            "status": "Success",
            "date": "2025-10-13T07:04:22+00:00",
            "errorMessage": null
        }
    ]
}