Standard API v2
Le Standard API (SAPI) servono come interfaccia per la comunicazione con il backend di Tsuite, permettono il recupero di dati e anche la loro modifica o eliminazione.
Dichiarazione
Filtro
type filter = {
aggregate: AND_o_OR,
conditions: ({
obj: tipo_oggetto,
field: fields,
operator: operators,
value: valore_filtro
} |
self)[]
}
/*
Estraggo tutti gli articoli che hanno "maglietta" nella descrizione o nel marchio,
800123 come barcode e rientrano nella lista di articoli \["a1", "a2", "a3"]
*/
const filtro: filter =
{
aggregate: AND,
conditions: [
{
field: "barcode",
operator: EQUAL,
value: "800123"
},
{
field: "id",
operator: IN,
value: ["a1", "a2", "a3"]
},
{
aggregate: OR,
conditions: [
{
field: "descrizione",
operator: LIKE,
value: "maglietta"
},
{
field: "marchio",
operator: LIKE,
value: "maglietta"
}
]
}
]
}Esempio
Chiamata
/articles?fields=id,descrizione&includes[barcode]=id,codice,type&includes[vat]=id,aliquotaRisposta
{
data: [
{
key: "a1",
id: "a1",
descrizione: "pollo"
},
{
key: "a2",
id: "a2",
descrizione: "carote"
},
],
included: {
barcode: [
{
key: "b1",
id: "b1",
codice: "barcode1",
type: "EAN8"
},
{
key: "b2",
id: "b2",
codice: "barcode2",
type: "EAN13"
},
{
key: "b3",
id: "b3",
codice: "barcode2",
type: "Code128"
}
],
vat: [
{
key: "v1",
id: "v1",
aliquota: "4%"
}
]
},
relationship: [
{
key: "a1",
barcode: ["b1", "b3"],
vat: ["v1"],
},
{
key: "a2",
barcode: ["b2"],
vat: ["v1"],
}
]
}Endpoint
Qui la lista degli endpoint disponibili