Introduzione
Il primo gestionale su smartphone che vende online, anche su Amazon, e comunica con i tuoi clienti.
Con NegozioPerfetto puoi:
-
Gestire il tuo negozio direttamente dallo smartphone
-
Semplificare ed automatizzare tutti i processi di codifica, inventario, carico, vendita e molto altro ancora
-
Avere In 48 ore avrai un e-commerce online, personale, completamente sincronizzato con il tuo negozio fisico
-
Accedere ad una dashboard accessibile da qualsiasi dispositivo, con cui monitorare tutto il flusso di vendita, gestire i tuoi clienti, fornitori ed anche i commessi in negozio.
Per permettere ad altri software terzi di interfacciarsi con la piattaforma, abbiamo implementato e rilasciato una serie di API REST, elencate in questo documento.
Nota che l'accesso alle API è strettamente legato dall'avere attivo una licenza in NegozioPerfetto https://www.NegozioPerfetto.it/prezzi/ | |
Il numero di richieste API disponibili sono limitate ad un numero giornaliero in base al tipo di abbonamento che si è scelto |
HTTP status codes
Di seguito sono riportate gli HTTP status code che possono essere ricevuti da un client dell’API di NegozioPerfetto.
Status code | Significato |
---|---|
|
Risposta standard per le richieste HTTP andate a buon fine. |
|
La richiesta è valida ma il server si rifiuta di soddisfarla. L’utente potrebbe non disporre delle autorizzazioni necessarie per accedere alla risorsa. In tal caso, seguire il paragrafo Autenticazione |
|
La richiesta è valida ma il numero di richieste effettuate ha sforato il limite di richieste previste dall'account. |
Autenticazione
Per poter accedere al servizio API di NegozioPerfetto è necessario procedere con l’autenticazione, che consiste nell'includere nella richiesta effettuata una chiave API.
Sarà necessario accedere al pannello cloud e generare una chiave API dall'apposito menu |
Dopodichè, inserire il token generato nella HEADER della richiesta, con parametro di nome x-api-key
Gestione CORS Policy
Il Cross-Origin Resource Sharing (CORS) è un meccanismo che usa header HTTP addizionali per indicare a un browser che un'applicazione Web in esecuzione su un'origine (dominio) dispone dell'autorizzazione per accedere alle risorse selezionate da un server di origine diversa. Un'applicazione web invia una cross-origin HTTP request quando richiede una risorsa che ha un'origine (protocollo, dominio e porta) differente dalla propria.
Riferimento o altre informazioni: Qui |
NegozioPerfetto gestisce tali controlli nel modo seguente:
Quando la fonte della richiesta HTTP viene giudicata come non sicura, viene inviata una richiesta di handshake (preflight) con metodo OPTION, che elencherà tutte le caratteristiche richieste per validare il chiamante. La validazione avverrà tramite i seguenti passaggi:
-
Validazione del metodo: (Access-Control-Allow-Methods) metodi HTTP fuori dall'elenco dei metodi permessi verranno scartati. I metodi HTTP accettati varieranno in base alla API invocata, ma che comunque ciclano tra GET, POST, OPTION.
-
Validazione dell'header: (Access-Control-Allow-Headers) se la richiesta inviata contiene headers non supportati, allora la richiesta non verrà soddisfatta. Al momento, la lista di header supportati ed accettati è la seguente:
- Content-Type
- X-Amz-Date
- Authorization
- X-Api-Key
- X-Amz-Security-Token
Se viene inserito un header non supportato, l'errore generato e visibile nella console del browser sarà simile al seguente: Access to XMLHttpRequest at 'https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/X/Y' from origin 'ORIGIN' has been blocked by CORS policy: Request header field CAMPO_NON_SUPPORTATO is not allowed by Access-Control-Allow-Headers in preflight response. -
Validazione dell'origine: (Access-Control-Allow-Origin) lista dei domini di provenienza accettati, settati a Tutti (*)
Articoli
Questa sezione elenca tutti i metodi disponibili per la gestione della risorsa Articolo.
A1. ottieniArticoli
Ottiene la lista delle anagrafiche articoli create in NegozioPerfetto.
Richiesta HTTP
GET https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/get/article HTTP/1.1
Accept-Encoding: gzip,deflate
x-api-key: Your-API-Key
Connection: Keep-Alive
Parametri Richiesta
Campo | Tipo | Descrizione | Vincoli |
---|---|---|---|
|
|
Intero che indica quanti risultati massimi ritornare |
Minimo 1Default 25Max 100 |
|
|
Indica il numero di pagina richiesto dall'utente. Utile per eventuali paginazioni |
Maggiore di zeroDefault 1 |
|
|
Eventuale chiave di ricerca da applicare alla ricerca |
|
|
|
Eventuale timestamp da applicare per ottenere le righe modificate da una certa data in poi |
Risposta HTTP
HTTP/1.1 200 OK
Date: Thu, 23 May 2019 13:35:40 GMT
Content-Type: application/json
Content-Length: 96
Connection: keep-alive
x-amzn-RequestId: a4da5d82-7d5f-11e9-8897-19a42a5e3db5
x-amz-apigw-id: aI4yIG5mDoEFnGQ=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-5ce6a1a7-6fa0dac81921f322a865c51c;Sampled=0
{
"result" : true,
"message" : "Procedura conclusa con successo",
"response" : {
"items" : [],
"message" : "",
"counters" : {
"max_pages" : X,
"used_limit" : X,
"total_number" : X
}
}
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato finale |
|
|
Lista dei risultati che la procedura ha prodotto |
|
|
ID dell'articolo |
|
|
Barcode (EAN) dell'articolo |
|
|
Codice primario dell'articolo |
|
|
Codice secondario dell'articolo |
|
|
Codice terziario / produttore dell'articolo |
|
|
ID del brand (marca) dell'articolo |
|
|
Brand (marca) dell'articolo |
|
|
Lista dei fornitori (ragione sociale) dell'articolo |
|
|
Descrizione dell'articolo |
|
|
Lista delle categorie dell'articoloDettagli |
|
|
Eventuale collezione / stagione associata all'articolo.Dettagli |
|
|
Unità di misura primaria dell'articolo |
|
|
Unità di misura secondario dell'articolo |
|
|
Numero di pezzi per confezione dell'articolo |
|
|
Costo d'acquisto (imponibile) dell'articolo |
|
|
Prezzo di vendita (imponibile) dell'articolo |
|
|
Aliquota IVA applicata nelle transazioni dell'articolo |
|
|
Lista delle foto associate all'articolo.Dettagli |
|
|
Peso (in grammi) dell'articolo |
|
|
Altezza (cm) dell'articolo |
|
|
Larghezza (cm) dell'articolo |
|
|
Profondità volumetrica (cm) dell'articolo |
|
|
Volume dell'articolo |
|
|
Scorta minima dell'articolo |
|
|
Eventuale ID dell'articolo padre nel caso di articoli a varianti |
|
|
Eventuali variazioni rilevate dall'articolo |
|
|
L'attributo indica se l'articolo è da pubblicare sull'eventuale sito o meno.0: da NON pubblicare1: da pubblicare |
|
|
Eventuale ID dell'articolo generato dall'eventuale sito |
|
|
L'attributo indica il prezzo online (per il sito) relativo all'articolo |
|
|
Descrizione lunga dell'articolo, usata ad esempio per rappresentare una scheda tecnica |
|
|
Data di ultima modifica eseguita sull'articolo |
|
|
Eventule messaggio accompagnatorio ai risultati |
|
|
Contatori addizionali utili a paginazioni terze |
|
|
Numero massimo di pagine ottenibile tramite gli input ricevuti. |
|
|
Limite usato nelle ricerche. |
|
|
Numero massimo di record ottenibile tramite gli input inseriti. |
Parametri categorie
Campo | Tipo | Descrizione |
---|---|---|
|
|
ID della categoria |
|
|
Ramo completo rilevato dalla categoria |
Parametri foto
Campo | Tipo | Descrizione |
---|---|---|
|
|
Posizione numerica della foto |
|
|
URL della foto |
Parametri collezione
Campo | Tipo | Descrizione |
---|---|---|
|
|
ID della collezione |
|
|
Anno della collezione |
|
|
Stagione legata alla collezione |
|
|
Descrizione della collezione |
A2. creaArticolo
La procedura esegue la creazione di un articolo. Ovviamente, prima di creare l'istanza, viene eseguito un controllo di esistenza sul codice primario indicato.
Nota 1: Questa API supporta (per ora) solo la creazione di articoli Semplici.
Nota 2: Questa API NON supporta (per ora) l'aggiunta di foto in fase di creazione.
Nota 3: Questa API NON supporta (per ora) l'aggiornamento di eventuali ecommerce legati all'account.
Richiesta HTTP
POST https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/create/article HTTP/1.1
Accept-Encoding: gzip,deflate
x-api-key: Your-API-Key
Connection: Keep-Alive
Parametri Richiesta
Campo | Tipo | Descrizione | Vincoli |
---|---|---|---|
|
|
Codice primario dell'articolo. Utile anche per verificare l'esistenza di un duplicato |
Obbligatorio |
|
|
Barcode / Codice a barre dell'articolo |
Default: stringa vuota |
|
|
Codice secondario dell'articolo |
Default: stringa vuota |
|
|
Codice terziario o codice produttore dell'articolo |
Default: stringa vuota |
|
|
Brand / marca dell'articolo |
Default: stringa vuota |
|
|
Fornitore (Ragione sociale) dell'articolo |
Default: stringa vuota |
|
|
Descrizione dell'articolo |
Default: stringa vuota |
|
|
Categoria dell'articolo |
Default: stringa vuota |
|
|
Unità di misura dell'articolo |
Default: NR (Numero) |
|
|
Unità di misura alternativa / secondaria dell'articolo |
Default: stringa vuota |
|
|
Unità di conversione tra l'unità di misura principale e quella alternativa. Esempio: valore di conversione tra metri e metri quadrati |
Default: 1.00 |
|
|
Numero di pezzi per confezione dell'articolo |
Default: 1 |
|
|
Costo d'acquisto (imponibile) dell'articolo |
Default: 0 |
|
|
Prezzo di vendita (imponibile) dell'articolo |
Default: 0 |
|
|
Array di json indicante le ubicazioni per i vari depositi |
Default: [] |
|
|
ID del deposito in cui memorizzare l'ubicazionePer info sui depositi, leggi questo paragrafo |
Default: stringa vuota |
|
|
Valore d'ubicazione da memorizzare. |
Default: stringa vuota |
|
|
Aliquota Iva da impostare all'articolo |
Default: 22 |
|
|
Booleano indicante se attivare la gestione a seriali sull'articolo |
Default: False |
|
|
Peso dell'articolo |
Default: 0 |
|
|
Valore di scorta minima da impostare all'articolo |
Default: 0 |
|
|
Volume da impostare all'articolo |
Default: 0 |
Risposta HTTP
HTTP/1.1 200 OK
Date: Thu, 04 Nov 2019 13:35:40 GMT
Content-Type: application/json
Content-Length: 96
Connection: keep-alive
x-amzn-RequestId: a4da5d82-7d5f-11e9-8897-19a42a5e3db5
x-amz-apigw-id: aI4yIG5mDoEFnGQ=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-5ce6a1a7-6fa0dac81921f322a865c51c;Sampled=0
{
"result": true,
"message": "API processata con successo",
"response": {
"info": "Procedura completata con successo",
"created_id": "X.X.X.X",
"result": true
}
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato finale |
|
|
Messaggio rappresentante l'esito finale |
|
|
ID dell'articolo creato |
|
|
Booleano rappresentante l'esito finale |
A3. aggiornaArticolo
La procedura esegue l'aggiornamento di un articolo. La procedura aggiornerà solo i campi indicati nella lista dei parametri.
Nota 1: Questa API NON supporta (per ora) l'aggiornamento delle foto.
Nota 2: Questa API NON supporta (per ora) l'aggiornamento di eventuali ecommerce legati all'account.
Richiesta HTTP
POST https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/update/article HTTP/1.1
Accept-Encoding: gzip,deflate
x-api-key: Your-API-Key
Connection: Keep-Alive
Parametri Richiesta
Campo | Tipo | Descrizione | Vincoli |
---|---|---|---|
|
|
ID dell'articolo da aggiornare. |
Obbligatorio |
|
|
Codice primario dell'articolo. |
|
|
|
Barcode / Codice a barre dell'articolo |
|
|
|
Codice secondario dell'articolo |
|
|
|
Codice terziario o codice produttore dell'articolo |
|
|
|
Brand / marca dell'articolo |
|
|
|
Fornitore (Ragione sociale) dell'articolo |
|
|
|
Descrizione dell'articolo |
|
|
|
Categoria dell'articolo |
|
|
|
Unità di misura dell'articolo |
|
|
|
Unità di misura alternativa / secondaria dell'articolo |
|
|
|
Unità di conversione tra l'unità di misura principale e quella alternativa. Esempio: valore di conversione tra metri e metri quadrati |
|
|
|
Numero di pezzi per confezione dell'articolo |
|
|
|
Costo d'acquisto (imponibile) dell'articolo |
|
|
|
Prezzo di vendita (imponibile) dell'articolo |
|
|
|
Array di json indicante le ubicazioni per i vari depositi |
|
|
|
ID del deposito in cui memorizzare l'ubicazionePer info sui depositi, leggi questo paragrafo |
|
|
|
Valore d'ubicazione da memorizzare. |
|
|
|
Aliquota Iva da impostare all'articolo |
|
|
|
Booleano indicante se attivare la gestione a seriali sull'articolo |
|
|
|
Peso dell'articolo |
|
|
|
Valore di scorta minima da impostare all'articolo |
|
|
|
Volume da impostare all'articolo |
Risposta HTTP
HTTP/1.1 200 OK
Date: Thu, 04 Nov 2019 13:35:40 GMT
Content-Type: application/json
Content-Length: 96
Connection: keep-alive
x-amzn-RequestId: a4da5d82-7d5f-11e9-8897-19a42a5e3db5
x-amz-apigw-id: aI4yIG5mDoEFnGQ=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-5ce6a1a7-6fa0dac81921f322a865c51c;Sampled=0
{
"result": true,
"message": "API processata con successo",
"response": {
"info": "Procedura completata con successo",
"result": true
}
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato finale |
|
|
Messaggio rappresentante l'esito finale |
|
|
Booleano rappresentante l'esito finale |
A4. eliminaArticolo
La procedura esegue la cancellazione di un articolo.
Nota 1: Se l'account prevede un sito collegato e l'articolo è pubblicato su di esso, allora la API provvederà anche alla rimozione dell'articolo dal sito.
Nota 2: Se l'articolo è di tipo variante padre, verranno eliminati a catena anche tutti gli articoli figli.
Richiesta HTTP
DELETE https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/delete/article?id=1 HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
x-api-key: Your-API-Key
Content-Length: 0
Host: 1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Risposta HTTP
{
"result" : true,
"message" : "API processata con successo",
"response" :
{
"body" :
{
"id" : "DDI214647.164",
...
},
"result" : true,
"statusCode" : [200]
}
}
Clienti
Questa sezione elenca tutti i metodi disponibili per la gestione della risorsa Cliente.
C1. ottieniClienti
Ottiene la lista dei clienti creati in NegozioPerfetto.
Richiesta HTTP
GET https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/get/customer HTTP/1.1
Accept-Encoding: gzip,deflate
x-api-key: Your-API-Key
Connection: Keep-Alive
Parametri Richiesta
Campo | Tipo | Descrizione | Vincoli |
---|---|---|---|
|
|
Intero che indica quanti risultati massimi ritornare |
Minimo 1Default 25Max 100 |
|
|
Indica il numero di pagina richiesto dall'utente. Utile per eventuali paginazioni |
Maggiore di zeroDefault 1 |
|
|
Eventuale chiave di ricerca da applicare alla ricerca |
Risposta HTTP
HTTP/1.1 200 OK
Date: Thu, 23 May 2019 13:35:40 GMT
Content-Type: application/json
Content-Length: 96
Connection: keep-alive
x-amzn-RequestId: a4da5d82-7d5f-11e9-8897-19a42a5e3db5
x-amz-apigw-id: aI4yIG5mDoEFnGQ=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-5ce6a1a7-6fa0dac81921f322a865c51c;Sampled=0
{
"result" : true,
"message" : "Procedura conclusa con successo",
"response" : {
"items" : [],
"message" : "",
"counters" : {
"max_pages" : X,
"used_limit" : X,
"total_number" : X
}
}
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato finale |
|
|
Lista dei risultati che la procedura ha prodotto |
|
|
Eventule messaggio accompagnatorio ai risultati |
|
|
Contatori addizionali utili a paginazioni terze |
|
|
Numero massimo di pagine ottenibile tramite gli input ricevuti. |
|
|
Limite usato nelle ricerche. |
|
|
Numero massimo di record ottenibile tramite gli input inseriti. |
C2. creaCliente
La funzione crea un nuovo cliente nella piattaforma.
Richiesta HTTP
POST https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/create/customer HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
x-api-key: Your-API-Key
Content-Length: 50
Host: 1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Parametri Richiesta
Campo | Tipo | Descrizione | Vincoli |
---|---|---|---|
|
|
Ragione sociale del cliente |
Obbligatorio |
|
|
Codice generico da assegnare al cliente |
|
|
|
Nome anagrafico del cliente |
|
|
|
Cognome del cliente |
|
|
|
Indirizzo del cliente |
|
|
|
CAP (Zipcode) del cliente |
|
|
|
Codice fiscale del cliente |
|
|
|
Partita IVA del cliente |
|
|
|
Sigla della nazione del cliente |
Esempio IT, EN, ES, .. |
|
|
Comune di residenza del cliente |
|
|
|
Provincia di residenza del cliente |
|
|
|
Data di nascita del cliente |
Formato richiesto: YYYY-MM-DD |
Risposta HTTP
HTTP/1.1 200 OK
Date: Fri, 16 Apr 2020 07:33:02 GMT
Content-Type: application/json
Content-Length: 239
Connection: keep-alive
x-amzn-RequestId: 088c570c-6769-4b9c-bad0-eb0ae12a1cbf
Access-Control-Allow-Origin: *
x-amz-apigw-id: d3aTJEsJDoEF7VQ=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-60793dad-2a123db1480ebb400f8f06ac;Sampled=0
{
"result":true,
"message":"API processata con successo",
"response":
{
"body":
{
"codice":"1",
"idAzienda":"paolino.angeletti@advise.it",
"nascita":"1995-01-01",
"ragioneSociale":"pablo_srl_2",
"id":"C.21.9067.14"
},
"result":true,
"statusCode":[200]
}
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano della API |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato della procedura |
|
|
Lista dei dati inseriti. Da qui è possibile reperire l'id generato. |
|
|
Esito booleano della procedura |
|
|
Stato HTTP della procedura |
C3. aggiornaCliente
La funzione aggiorna un cliente nella piattaforma.
Richiesta HTTP
POST https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/update/customer?id=XXX HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
x-api-key: Your-API-Key
Content-Length: 120
Host: 1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Esempio richiesta
ENDPOINT https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/update/customer?id=1
POST
{
"fields" :
{
"name" : "Mario",
"vat_number" : "012547856320"
}
}
Parametri POST
Campo | Tipo | Descrizione | Vincoli |
---|---|---|---|
|
|
Ragione sociale del cliente |
Obbligatorio |
|
|
Codice generico da assegnare al cliente |
|
|
|
Nome anagrafico del cliente |
|
|
|
Cognome del cliente |
|
|
|
Indirizzo del cliente |
|
|
|
CAP (Zipcode) del cliente |
|
|
|
Codice fiscale del cliente |
|
|
|
Partita IVA del cliente |
|
|
|
Sigla della nazione del cliente |
Esempio IT, EN, ES, .. |
|
|
Comune di residenza del cliente |
|
|
|
Provincia di residenza del cliente |
|
|
|
Data di nascita del cliente |
Formato richiesto: YYYY-MM-DD |
Risposta HTTP
HTTP/1.1 200 OK
Date: Thu, 22 Apr 2020 09:32:03 GMT
Content-Type: application/json
Content-Length: 193
Connection: keep-alive
x-amzn-RequestId: 70fc922c-fe5f-4f09-ac21-69e5e4239828
Access-Control-Allow-Origin: *
x-amz-apigw-id: eLdV5EnbjoEFQ2Q=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-6081428c-1e80e9612897adf73a47322f;Sampled=0
{
"result" : true,
"message" : "API processata con successo",
"response"
:
{
"body" :
{
"nome" : "Mario"
"id" : "XXXX"
},
"result" : true,
"statusCode" : [200]
}
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano della API |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato della procedura |
|
|
Lista dei dati inseriti. Da qui è possibile reperire l'id generato. |
|
|
Esito booleano della procedura |
|
|
Stato HTTP della procedura |
C4. eliminaCliente
La funzione elimina un cliente dal sistema.
Richiesta HTTP
DELETE https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/delete/customer?id=1 HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
x-api-key: Your-API-Key
Content-Length: 0
Host: 1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Risposta HTTP
HTTP/1.1 200 OK
Date: Thu, 22 Apr 2020 10:23:28 GMT
Content-Type: application/json
Content-Length: 141
Connection: keep-alive
x-amzn-RequestId: 2fe6727a-d065-4ad7-9422-bba5bfa437a2
Access-Control-Allow-Origin: *
x-amz-apigw-id: eLk5AFiBjoEFwrQ=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-60814e9f-6dc2043b1cdd6acb235e7a71;Sampled=0
{
"result" : true,
"message" : "API processata con successo",
"response" :
{
"body" :
{
"stato" : "1",
"id" : "1"
},
"result" : true,
"statusCode" : [200]
}
}
Depositi
Questa sezione elenca tutti i metodi disponibili per la gestione della risorsa Deposito / Destinazione Merce.
D1. contaDepositi
Questa funzione ritorna il numero di depositi aziendali presenti nella piattaforma NegozioPerfetto
Richiesta HTTP
GET https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/get/warehouse/count HTTP/1.1
Accept-Encoding: gzip,deflate
x-api-key: Your-API-Key
Connection: Keep-Alive
Risposta HTTP
HTTP/1.1 200 OK
Date: Fri, 28 Jun 2019 07:20:36 GMT
Content-Type: application/json
Content-Length: 84
Connection: keep-alive
x-amzn-RequestId: 365e1703-9975-11e9-9e2b-4fde437c1ac3
Access-Control-Allow-Origin: *
x-amz-apigw-id: b-rl5F63DoEFTLA=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-5d15bfbf-11d6bd257b534f803a1ec095;Sampled=0
{
"result" : true,
"message" : "Procedura conclusa con successo",
"response" : [
{
"count" : 6
}
]
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato finale |
|
|
Numero dei depositi rilevati |
D2. ottieniDepositi
Questa funzione ritorna i depositi (o destinazioni merci) presenti nella piattaforma NegozioPerfetto
Richiesta HTTP
GET https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/get/warehouse?search_key=Napoli HTTP/1.1
Accept-Encoding: gzip,deflate
x-api-key: Your-API-Key
Connection: Keep-Alive
Parametri Richiesta
Campo | Tipo | Descrizione | Vincoli |
---|---|---|---|
|
|
Intero che indica quanti risultati massimi ritornare |
Minimo 1Default 25Max 100 |
|
|
Indica il numero di pagina richiesto dall'utente. Utile per eventuali paginazioni |
Maggiore di zero Default 1 |
|
|
Eventuale chiave di ricerca da applicare alla ricerca |
Risposta HTTP
HTTP/1.1 200 OK
Date: Wed, 29 May 2019 08:08:04 GMT
Content-Type: application/json
Content-Length: 96
Connection: keep-alive
x-amzn-RequestId: e21d0833-81e8-11e9-9db8-bd50b4af1cd4
x-amz-apigw-id: ab6blG8aDoEF2zA=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-5cee3de3-5619f42ed98b3d73cf6eee0b;Sampled=0
{
"result" : true,
"message" : "Procedura conclusa con successo",
"response" : {
"items" : [
{
"item_id": "X.X.X.X",
"item_code": 1,
"item_name": "Test Warehouse",
"item_country": "Italy",
"item_city": "Rome",
"item_address": "Address address",
"item_state": "",
"item_zone": "",
"item_note": "First warehouse"
}
],
"message" : "",
"counters" : {
"max_pages" : X,
"used_limit" : X,
"total_number" : X
}
}
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato finale |
|
|
Lista dei risultati che la procedura ha prodotto |
|
|
ID dell'i-esimo elemento trovato |
|
|
Codice dell'i-esimo elemento trovato |
|
|
Ragione sociale dell'i-esimo elemento trovato |
|
|
Nazione dell'i-esimo elemento trovato |
|
|
Città / Comune / Località dell'i-esimo elemento trovato |
|
|
Indirizzo dell'i-esimo elemento trovato |
|
|
Provincia dell'i-esimo elemento trovato |
|
|
CAP dell'i-esimo elemento trovato |
|
|
Eventuali note aggiuntive dell'i-esimo elemento trovato |
|
|
Eventule messaggio accompagnatorio ai risultati |
|
|
Contatori addizionali utili a paginazioni terze |
|
|
Numero massimo di pagine ottenibile tramite gli input ricevuti. |
|
|
Limite usato nelle ricerche. |
|
|
Numero massimo di record ottenibile tramite gli input inseriti. |
Fornitori
Questa sezione elenca tutti i metodi disponibili per la gestione della risorsa Fornitore.
F1. ottieniFornitori
Ottiene la lista dei fornitori creati in NegozioPerfetto.
Richiesta HTTP
GET https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/get/supplier?max_results=1&page_number=1 HTTP/1.1
Accept-Encoding: gzip,deflate
x-api-key: Your-API-Key
Connection: Keep-Alive
Parametri Richiesta
Campo | Tipo | Descrizione | Vincoli |
---|---|---|---|
|
|
Intero che indica quanti risultati massimi ritornare |
Minimo 1Default 25Max 100 |
|
|
Indica il numero di pagina richiesto dall'utente. Utile per eventuali paginazioni |
Maggiore di zero Default 1 |
|
|
Eventuale chiave di ricerca da applicare alla ricerca |
Risposta HTTP
HTTP/1.1 200 OK
Date: Thu, 23 May 2019 13:35:40 GMT
Content-Type: application/json
Content-Length: 96
Connection: keep-alive
x-amzn-RequestId: a4da5d82-7d5f-11e9-8897-19a42a5e3db5
x-amz-apigw-id: aI4yIG5mDoEFnGQ=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-5ce6a1a7-6fa0dac81921f322a865c51c;Sampled=0
{
"result" : true,
"message" : "Procedura conclusa con successo",
"response" : {
"items" : [],
"message" : "",
"counters" : {
"max_pages" : X,
"used_limit" : X,
"total_number" : X
}
}
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato finale |
|
|
Lista dei risultati che la procedura ha prodotto |
|
|
Eventule messaggio accompagnatorio ai risultati |
|
|
Contatori addizionali utili a paginazioni terze |
|
|
Numero massimo di pagine ottenibile tramite gli input ricevuti. |
|
|
Limite usato nelle ricerche. |
|
|
Numero massimo di record ottenibile tramite gli input inseriti. |
F2. creaFornitore
La funzione crea un nuovo fornitore nella piattaforma.
Richiesta HTTP
POST https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/create/customer HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
x-api-key: Your-API-Key
Content-Length: 104
Host: 1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Parametri Richiesta
Campo | Tipo | Descrizione | Vincoli |
---|---|---|---|
|
|
Ragione sociale del cliente |
Obbligatorio |
|
|
Codice generico da assegnare al cliente |
|
|
|
Nome anagrafico del cliente |
|
|
|
Cognome del cliente |
|
|
|
Indirizzo del cliente |
|
|
|
CAP (Zipcode) del cliente |
|
|
|
Codice fiscale del cliente |
|
|
|
Partita IVA del cliente |
|
|
|
Sigla della nazione del cliente |
Esempio IT, EN, ES, .. |
|
|
Comune di residenza del cliente |
|
|
|
Provincia di residenza del cliente |
|
|
|
Data di nascita del cliente |
Formato richiesto: YYYY-MM-DD |
Risposta HTTP
HTTP/1.1 200 OK
Date: Fri, 16 Apr 2020 07:53:56 GMT
Content-Type: application/json
Content-Length: 261
Connection: keep-alive
x-amzn-RequestId: 167e43cc-a555-43a6-af27-e827c013970b
Access-Control-Allow-Origin: *
x-amz-apigw-id: d3dXDGWIDoEF99w=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-60794293-04be1dea4c5b75432e15cf7d;Sampled=0
{
"result":true,
"message":"API processata con successo",
"response":{
"body":
{
"codice":"1",
"idAzienda":"paolino.angeletti@advise.it",
"nascita":"1995-01-01",
"codiceFiscale":"aaa",
"ragioneSociale":"pablo_srl_2",
"id":"C.21.9067.18"
},
"result":true,
"statusCode":[200]
}
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano della API |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato della procedura |
|
|
Lista dei dati inseriti. Da qui è possibile reperire l'id generato. |
|
|
Esito booleano della procedura |
|
|
Stato HTTP della procedura |
F3. aggiornaFornitore
La funzione aggiorna un fornitore nella piattaforma.
Richiesta HTTP
POST https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/update/supplier?id=XXX HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
x-api-key: Your-API-Key
Content-Length: 120
Host: 1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Esempio richiesta
ENDPOINT https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/update/supplier?id=1
POST
{
"fields" :
{
"name" : "Mario",
"vat_number" : "012547856320"
}
}
Parametri POST
Campo | Tipo | Descrizione | Vincoli |
---|---|---|---|
|
|
Ragione sociale del cliente |
Obbligatorio |
|
|
Codice generico da assegnare al cliente |
|
|
|
Nome anagrafico del cliente |
|
|
|
Cognome del cliente |
|
|
|
Indirizzo del cliente |
|
|
|
CAP (Zipcode) del cliente |
|
|
|
Codice fiscale del cliente |
|
|
|
Partita IVA del cliente |
|
|
|
Sigla della nazione del cliente |
Esempio IT, EN, ES, .. |
|
|
Comune di residenza del cliente |
|
|
|
Provincia di residenza del cliente |
|
|
|
Data di nascita del cliente |
Formato richiesto: YYYY-MM-DD |
Risposta HTTP
HTTP/1.1 200 OK
Date: Thu, 22 Apr 2020 09:32:03 GMT
Content-Type: application/json
Content-Length: 193
Connection: keep-alive
x-amzn-RequestId: 70fc922c-fe5f-4f09-ac21-69e5e4239828
Access-Control-Allow-Origin: *
x-amz-apigw-id: eLdV5EnbjoEFQ2Q=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-6081428c-1e80e9612897adf73a47322f;Sampled=0
{
"result" : true,
"message" : "API processata con successo",
"response"
:
{
"body" :
{
"nome" : "Mario"
"id" : "XXXX"
},
"result" : true,
"statusCode" : [200]
}
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano della API |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato della procedura |
|
|
Lista dei dati inseriti. Da qui è possibile reperire l'id generato. |
|
|
Esito booleano della procedura |
|
|
Stato HTTP della procedura |
C4. eliminaFornitore
La funzione elimina un fornitore dal sistema.
Richiesta HTTP
DELETE https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/delete/supplier?id=1 HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
x-api-key: Your-API-Key
Content-Length: 0
Host: 1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Risposta HTTP
HTTP/1.1 200 OK
Date: Thu, 22 Apr 2020 10:23:28 GMT
Content-Type: application/json
Content-Length: 141
Connection: keep-alive
x-amzn-RequestId: 2fe6727a-d065-4ad7-9422-bba5bfa437a2
Access-Control-Allow-Origin: *
x-amz-apigw-id: eLk5AFiBjoEFwrQ=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-60814e9f-6dc2043b1cdd6acb235e7a71;Sampled=0
{
"result" : true,
"message" : "API processata con successo",
"response" :
{
"body" :
{
"stato" : "1",
"id" : "1"
},
"result" : true,
"statusCode" : [200]
}
}
Magazzino
Questa sezione elenca tutti i metodi disponibili per la gestione della risorsa Magazzino, intesa come gestione dei progressivi di magazzino, quali esistenza, ordinato da clienti, ecc..
M1. ottieniDatiMagazzino
La funzione restituisce la lista degli ARTICOLI MOVIMENTATI, nonchè i vari progressivi di magazzino ad essi associati.
Richiesta HTTP
GET https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/get/counters?max_results=5&page_number=1&search_item=libro HTTP/1.1
Accept-Encoding: gzip,deflate
x-api-key: Your-API-Key
Connection: Keep-Alive
Parametri Richiesta
Campo | Tipo | Descrizione | Vincoli |
---|---|---|---|
|
|
Intero che indica quanti risultati massimi ritornare |
Maggiore di zeroDefault: 25Massimo: 100 |
|
|
Indica il numero di pagina richiesto dall'utente. Utile per eventuali paginazioni |
Maggiore di zero Default: 1 |
|
|
Eventuale chiave di ricerca da applicare. Tale chiave filtrerà cercando un ID articolo oppure un codice articolo oppure una descrizione articolo |
|
|
|
Eventuale ID del deposito da filtrare.Per info sui depositi, leggi questo paragrafo |
|
|
|
Data minima da applicare nella ricerca documenti. |
Formato: yyyy-MM-dd |
|
|
Data massima da applicare nella ricerca documenti. |
Formato: yyyy-MM-dd |
Risposta HTTP
HTTP/1.1 200 OK
Date: Tue, 28 May 2019 15:32:00 GMT
Content-Type: application/json
Content-Length: 83
Connection: keep-alive
x-amzn-RequestId: b9f603a9-815d-11e9-aa93-a7efb415d2d8
x-amz-apigw-id: aZog7HzfjoEFVRQ=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-5ced546c-1a89158fd4dad7b268d39960;Sampled=0
{
"result" : true,
"message" : "Procedura conclusa con successo",
"response" : {
"items" : [],
"counters" : {
"max_pages" : X,
"used_limit" : X,
"total_number" : X
}
}
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato finale |
|
|
Lista dei risultati che la procedura ha prodotto |
|
|
ID dell'i-esimo articolo rilevato |
|
|
Codice a barre dell'i-esimo articolo rilevato |
|
|
Esistenza dell'i-esimo articolo rilevato |
|
|
Quantità di Ordinato-Da-Clienti dell'i-esimo articolo rilevato |
|
|
Quantità di Ordinato-A-Fornitori dell'i-esimo articolo rilevato |
|
|
Esistenza positiva (carico) dell'i-esimo articolo rilevato |
|
|
Codice primario dell'i-esimo articolo rilevato |
|
|
Ubicazioni dell'i-esimo articolo rilevatoNB: Ciascuna riga sarà composta da IDDeposito e Ubicazione. Esempio: |
|
|
Quantità trasferita positiva (DDT Trasferimento IN) dell'i-esimo articolo rilevato |
|
|
Scorta minima dell'i-esimo articolo rilevato |
|
|
Quantità trasferita negativa (DDT Trasferimento OUT) dell'i-esimo articolo rilevato |
|
|
Esistenza negativa (scarico) dell'i-esimo articolo rilevato |
|
|
Descrizione dell'i-esimo articolo rilevato |
|
|
Contatori addizionali utili a paginazioni terze |
|
|
Numero massimo di pagine ottenibile tramite gli input ricevuti. |
|
|
Limite usato nelle ricerche. |
|
|
Numero massimo di record ottenibile tramite gli input inseriti. |
Storico articolo
Questa sezione elenca tutti i metodi disponibili per la gestione della risorsa Storico articolo, intesa come lista di documenti che coinvolgono uno specifico articolo codificato nella piattaforma.
S1. ottieniStoricoArticolo
La funzione restituisce la lista dei documenti che coinvolgono uno specifico articolo.
Richiesta HTTP
GET https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/get/historical?article_id=X.X.X.X HTTP/1.1
Accept-Encoding: gzip,deflate
x-api-key: Your-API-Key
Connection: Keep-Alive
Parametri Richiesta
Campo | Tipo | Descrizione | Vincoli |
---|---|---|---|
|
|
ID dell'articolo da processare |
Obbligatorio |
|
|
Ragione sociale del cliente da filtrare |
Il valore ricevuto verrà processato in modalità di contenimento, applicando la classica clausola LIKE |
|
|
Ragione sociale del fornitore da filtrare |
Il valore ricevuto verrà processato in modalità di contenimento, applicando la classica clausola LIKE |
|
|
Data iniziale da applicare nella ricerca dei documenti | Formato dd/MM/yyyy |
|
|
Data finale da applicare nella ricerca dei documenti | Formato dd/MM/yyyy |
|
|
Eventuale ID del deposito da filtrare.Per info sui depositi, leggi questo paragrafo |
|
|
|
Intero che indica quanti risultati massimi ritornare |
Maggiore di zero Default: 25 |
|
|
Indica il numero di pagina richiesto dall'utente. Utile per eventuali paginazioni |
Maggiore di zero Default: 1 |
Risposta HTTP
HTTP/1.1 200 OK
Date: Tue, 21 Feb 2020 14:48:12 GMT
Content-Type: application/json
Content-Length: 586
Connection: keep-alive
x-amzn-RequestId: b9f603a9-815d-11e9-aa93-a7efb415d2d8
x-amz-apigw-id: aZog7HzfjoEFVRQ=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-5ced546c-1a89158fd4dad7b268d39960;Sampled=0
{
"result" : true,
"message" : "API processata con successo",
"response" : {
"result" : true,
"info" : "Some text ..",
"items" : [
{
"customer" : X ,
"supplier" : X ,
"document_id" : X ,
"total_amount" : X ,
"warehouse_id" : X ,
"document_date" : X ,
"document_user" : X ,
"document_type" : X ,
"document_number" : X ,
"article_quantity" : X ,
"last_update_time" : X ,
"previous_document_id" : X
},
{
..
}
],
"counters" : {
"max_pages": X,
"used_limit": X,
"total_number": X,
"initial_stock": X,
"used_start_date": X
}
}
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato finale |
|
|
Esito booleano della procedura |
|
|
Esito testuale della procedura |
|
|
Contenitore dei documenti rilevati |
|
|
Ragione sociale dell'eventuale cliente del documento |
|
|
Ragione sociale dell'eventuale fornitore del documento |
|
|
ID del documento rilevato |
|
|
Totale del documento |
|
|
ID del deposito coinvolto nel documento |
|
|
Nome rappresentativo del deposito coinvolto nel documento |
|
|
Data di rilascio del documento |
|
|
Operatore creatore del documento |
|
|
Tipologia del documento rilevatoPer info, leggi questo paragrafo |
|
|
Descrizione della sigla documento ricevuta |
|
|
URL che identifica il file PDF del documento rilevato |
|
|
Numero assegnato al documento |
|
|
Quantità dell'articolo presente nel documento |
|
|
Timestamp dell'ultima modifica eseguita sul documento rilevato |
|
|
ID dell'eventuale documento padre che ha generato il documento rilevato |
|
|
Contenitore di ulteriori informazioni riguardo la richiesta |
|
|
Numero totale dei documenti associati all'articolo |
|
|
Numero massimo di pagine visualizzabili in base al limit ricevuto |
|
|
Data iniziale usata nella ricerca documenti |
|
|
Limite di risultati usato nella richiesta effettuata |
|
|
Se viene ricevuta una data iniziale, la API ritorna lo stock iniziale a quella data. Negli altri casi, verrà ritornato 0. |
Documento
Questa sezione elenca tutti i metodi disponibili per la gestione della risorsa Documento.
DOC1. ottieniTipologiaDocumenti
La funzione restituisce tutte le tipologie di documenti previsiti e gestibili in NegozioPerfetto.
Richiesta HTTP
GET https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/get/document/type HTTP/1.1
Accept-Encoding: gzip,deflate
x-api-key: Your-API-Key
Connection: Keep-Alive
Risposta HTTP
HTTP/1.1 200 OK
Date: Tue, 21 Feb 2020 14:48:12 GMT
Content-Type: application/json
Content-Length: 586
Connection: keep-alive
x-amzn-RequestId: b9f603a9-815d-11e9-aa93-a7efb415d2d8
x-amz-apigw-id: aZog7HzfjoEFVRQ=
x-custom-header: header_api
X-Amzn-Trace-Id: Root=1-5ced546c-1a89158fd4dad7b268d39960;Sampled=0
{
"result" : true,
"message" : "API processata con successo",
"response" : [
{
"document_type": "DDT",
"desc_ita": "Documento di trasporto",
"desc_eng": "Transport document"
},
{
..
}
]
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato finale |
|
|
Sigla della tipologia del documento |
|
|
Descrizione testuale italiana del tipo documento |
|
|
Descrizione testuale inglese del tipo documento |
OF1. creaOrdineFornitore
La funzione provvede alla creazione di un nuovo ordine fornitore in NegozioPerfetto.
Richiesta HTTP
POST https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/create/document/supplier-order HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
x-api-key: Your-API-Key
Content-Length: 371
Host: 1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Esempio richiesta
{
"document":{
"number" : "test_doc_01",
"date": "2020-04-16",
"subject_id" : "XXX",
"warehouse_id" : "XXX"
},
"rows":[
{
"quantity" : "1",
"article_id": "XXX",
"tax_rate" : "22",
"unit_price" :"16.84"
},
{
"quantity" : "12",
"article_id": "XXX",
"discount_perc" : "45",
"unit_price" :"8"
}
]
}
Parametri Richiesta
Campo | Tipo | Descrizione | Vincoli |
---|---|---|---|
|
|
Dati del documento da creare |
Obbligatorio |
|
|
Numero del documento da creare |
Obbligatorio |
|
|
Data del documento |
Obbligatorio e nel formato YYYY-MM-DD |
|
|
Data di consegna dell'ordine |
Formato YYYY-MM-DD |
|
|
ID del deposito |
Obbligatorio |
|
|
Costi di spedizione previsti per l'ordine.Il valore deve contenere eventuali imposte aggiuntive (Es. IVA) |
|
|
|
Aliquota di imposta da applicare alla spedizione |
Compreso tra 0 e 100 |
|
|
Note applicate all'ordine |
Lunghezza massima: 255 |
|
|
Numero di colli previsti dall'ordine |
Il valore deve essere intero positivo |
|
|
ID del fornitore a cui associare l'ordine |
Obbligatorio |
|
|
Righe da inserire nell'ordine |
Obbligatorio e con almeno un elemento |
|
|
Quantità della riga |
Obbligatorio e maggiore di zero |
|
|
ID dell'articolo ordinato |
Obbligatorio |
|
|
Eventuale collo specifico della transazione |
Lunghezza massima 15 |
|
|
Percentuale di sconto applicato all'articolo |
Valore compreso tra 0 e 100 |
|
|
Aliquota d'imposta applicata alla transazione |
Valore compreso tra 0 e 100. Se assente, il default usato è 22 |
|
|
Prezzo unitario dell'articolo ordinato. |
Questo prezzo dovrà essere ESCLUSO da tasse e sconti |
|
|
Numero di riga dell'ordine |
Valore intero positivo |
Risposta HTTP
{
"result": true,
"message": "API processata con successo",
"response": {
"body": {
"movimenti": [{
"id": "D.21.4610.15.0",
...
},{
"id": "D.21.4610.15.1",
...
}],
"dati_documento": {
"id": "D.21.4610.15",
...
}
},
"result": true,
"statusCode": [200]
}
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano della API |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato finale della procedura |
OC1. creaOrdineCliente
La funzione provvede alla creazione di un nuovo ordine cliente in NegozioPerfetto.
Richiesta HTTP
POST https://1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com/create/document/customer-order HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
x-api-key: Your-API-Key
Content-Length: 371
Host: 1v7y6w1ki1.execute-api.eu-west-1.amazonaws.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Esempio richiesta
{
"document":{
"number" : "test_doc_01",
"date": "2020-04-16",
"subject_id" : "XXX",
"warehouse_id" : "XXX"
},
"rows":[
{
"quantity" : "1",
"article_id": "XXX",
"tax_rate" : "22",
"unit_price" :"16.84"
},
{
"quantity" : "12",
"article_id": "XXX",
"discount_perc" : "45",
"unit_price" :"8"
}
]
}
Parametri Richiesta
Campo | Tipo | Descrizione | Vincoli |
---|---|---|---|
|
|
Dati del documento da creare |
Obbligatorio |
|
|
Numero del documento da creare |
Obbligatorio |
|
|
Data del documento |
Obbligatorio e nel formato YYYY-MM-DD |
|
|
Data di consegna dell'ordine |
Formato YYYY-MM-DD |
|
|
ID del deposito |
Obbligatorio |
|
|
Costi di spedizione previsti per l'ordine.Il valore deve contenere eventuali imposte aggiuntive (Es. IVA) |
|
|
|
Aliquota di imposta da applicare alla spedizione |
Compreso tra 0 e 100 |
|
|
Note applicate all'ordine |
Lunghezza massima: 255 |
|
|
Numero di colli previsti dall'ordine |
Il valore deve essere intero positivo |
|
|
ID del cliente a cui associare l'ordine |
Obbligatorio |
|
|
Righe da inserire nell'ordine |
Obbligatorio e con almeno un elemento |
|
|
Quantità della riga |
Obbligatorio e maggiore di zero |
|
|
ID dell'articolo ordinato |
Obbligatorio |
|
|
Eventuale collo specifico della transazione |
Lunghezza massima 15 |
|
|
Percentuale di sconto applicato all'articolo |
Valore compreso tra 0 e 100 |
|
|
Aliquota d'imposta applicata alla transazione |
Valore compreso tra 0 e 100. Se assente, il default usato è 22 |
|
|
Prezzo unitario dell'articolo ordinato. |
Questo prezzo dovrà essere ESCLUSO da tasse e sconti |
|
|
Numero di riga dell'ordine |
Valore intero positivo |
Risposta HTTP
{
"result": true,
"message": "API processata con successo",
"response": {
"body": {
"movimenti": [{
"id": "D.21.4610.15.0",
...
},{
"id": "D.21.4610.15.1",
...
}],
"dati_documento": {
"id": "D.21.4610.15",
...
}
},
"result": true,
"statusCode": [200]
}
}
Parametri risposta
Campo | Tipo | Descrizione |
---|---|---|
|
|
Indica un esito in stile booleano della API |
|
|
Eventuale informazione che ha prodotto l'esito ricevuto in 'result' |
|
|
Contenitore del risultato finale della procedura |