Passa al contenuto principale

API

Update Stocks

Version ≥ 3.8

La chiamata consente di creare o aggiornare i ProductStock. La struttura del body della richiesta deve seguire l’esempio fornito.

Permessi Ruolo o Utente
  • Permesso generale per accesso alla risorsa: Objects
  • Permesso per l'accesso al tipo di DataObject: ProductStock
POST/api/oms/update-stocks

Headers: Autenticazione

Query Params Parametri non presenti

Dettaglio dei ProductStocks

Per ciascun ProductStock, è possibile configurare i seguenti campi:

CampoTipoDescrizione
skustringCodice di riferimento del prodotto
onHandQuantitynumberQuantità del prodotto a disposizione. Deve essere numerico e ≥ 0.
warehouseCodestringCodice 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.9

La chiamata consente di creare una spedizione e le relative etichette a partire dalla/e dimensione/i dei pacchi da inviare dal negozio fisico.

Permessi Ruolo o Utente
  • Permesso generale per accesso alla risorsa: Objects
POST/api/o2o/ship-from-store/create-shipping-label

Headers: Autenticazione

Query Params Parametri non presenti

Dettaglio della chiamta

CampoTipoDescrizione
shipFromStoreIdintID di riferimento dell'ordine
packages arrayDimensioni 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"
}