API
Update Stocks
Version ≥ 3.8La chiamata consente di creare o aggiornare i ProductStock. La struttura del body della richiesta deve seguire l’esempio fornito.
- Permesso generale per accesso alla risorsa:
Objects - Permesso per l'accesso al tipo di DataObject:
ProductStock
Headers: Autenticazione
Query Params Parametri non presenti
Dettaglio dei ProductStocks
Per ciascun ProductStock, è possibile configurare i seguenti campi:
| Campo | Tipo | Descrizione |
|---|---|---|
sku | string | Codice di riferimento del prodotto |
onHandQuantity | number | Quantità del prodotto a disposizione. Deve essere numerico e ≥ 0. |
warehouseCode | string | Codice di riferimento del magazzino in SOH. |
Body Request 200 OK
{
"stocks": [
{
"productFieldName": "sku",
"productFieldValue": "0004BK",
"onHandQuantity": 100,
"warehouseCode": "AR",
},
{
"productFieldName": "sku",
"productFieldValue": "0004SV",
"onHandQuantity": 90,
"warehouseCode": "MIL",
}
]
}
In caso di esito positivo della chiamata avremo un body della response come il seguente.
Se lo stock di alcuni prodotti non fosse stato aggiornato, perchè lo stock passato è uguale a quello presente, avremo un messaggio che indicherà proprio questo.
Body Response 200 OK
[
{
"productFieldName": "sku",
"productFieldValue": "0004BK",
"onHandQuantity": 100,
"warehouseCode": "AR",
"result": "OK"
},
{
"productFieldName": "sku",
"productFieldValue": "0004SV",
"onHandQuantity": 90,
"warehouseCode": "MIL",
"result": "OK"
}
]
La chiamata restituirà errore in due situazioni:
-
mancanza della chiave stocks 400 Bad Request
-
errore generico durante il processo 500 Internal Server Error
Create Shipment
Version ≥ 3.9La chiamata consente di creare una spedizione e le relative etichette a partire dalla/e dimensione/i dei pacchi da inviare dal negozio fisico.
- Permesso generale per accesso alla risorsa:
Objects
Headers: Autenticazione
Query Params Parametri non presenti
Dettaglio della chiamta
| Campo | Tipo | Descrizione |
|---|---|---|
shipFromStoreId | int | ID di riferimento dell'ordine |
packages | array | Dimensioni di uno o più pacchi da spedire |
Body Request 200 OK
{
"shipFromStoreId": 9375,
"packages": [
{
"weight": 10,
"length": 40,
"height": 30,
"width": 30
}
]
}
In caso di esito positivo della chiamata avremo un body della response come il seguente. Sarà presente il percorso dell'etichetta/e create durante la richiesta di spedizione.
Body Response 200 OK
{
"success": true,
"labelAssetUrl": "/ShipFromStore/2025/11/20/SFS_MI_-1345/Mbe/IT0577-0L-00000090Z2.pdf"
}
In caso di errore, il body della response restituirà sempre 200 ma sarà specificato l'errore.
Body Response 200 OK
{
"success": false,
"error": "Cannot create shipping label. ShipFromStore with ID: '73' not found"
}