Questa API consente di consultare e confermare le richieste di approvvigionamento.
Per gestire le API di approvvigionamento tramite autenticazione è necessario utilizzare lo scope: title_api_scope.
Ricerca proposte di approvvigionamento
Consente di ottenere le proposte di approvvigionamento di titoli a magazzino.
Risponde a richieste GET verso: /titoli/supplyProposal
E' possibile passare in querystring i seguenti parametri opzionali per filtrare la ricerca:
- vendor: codice editore. Può essere passato più volte.
- ean: codice EAN. Può essere passato più volte.
- showAll: parametro opzionale che restituisce (false) o meno (true) anche i dati degli EAN che non hanno una RdA in SAP.
- orderBy: campo su cui effettuare l'ordinamento. Può assumere uno dei seguenti valori:
- ean
- title
- publisher
- quantity
- stock
- saleOrders
- supplyOrders
- suppliedM
- suppliedT
- suppliedY
- orderDirection: direzione dell'ordinamento. Può assumere il valore asc per l'ordinamento crescente o il valore desc per l'ordinamento decrescente.
- pageSize: numero massimo di risultati restituiti da una chiamata. Se non specificato, saranno restituiti al massimo 50 risultati.
- pageIndex: numero di pagina dei risultati da restituire. Se non specificato, è restituita la prima pagina.
L’operazione restituisce un oggetto JSON contenente i seguenti campi:
- totalCount: numero totale di titoli trovati
- totalPages: numero totale di pagine previste
- page: informazioni sulla pagina corrente. Contiene:
- index: indice della pagina corrente
- size: dimensione della pagina
- from: indice del primo elemento della pagina (se la pagina ha elementi)
- to: indice dell'ultimo elemento della pagina (se la pagina ha elementi)
- data: elenco dei titoli trovati e delle corrispondenti proposte di approvvigionamento. Contiene:
- ean: codice EAN
- title: titolo
- vendor: editore. Contiene:
- code: codice editore
- description: nome editore
- publisher: nome editore effettivo
- articleSaleStatus: stato vendita. Contiene:
- code: codice stato vendita
- description: descrizione stato vendita
- articleStatus: risposta editore. Contiene:
- code: codice riposta editore
- description: descrizione risposta editore
- publicationDate: data di pubblicazione
- launch: lancio. Contiene:
- year: anno di lancio
- number: numero di lancio
- date: data di lancio
- quantity: copie da ordinare proposte
- stock: copie in stock
- saleOrders: ordini di vendita
- supplyOrders: ordini di approvvigionamento
- availability: disponibilità (stock meno ordini di vendita)
- supplied: copie fornite. Contiene:
- week0: Fornito settimana 0
- week1: Fornito settimana 1
- week2: Fornito settimana 2
- week3: Fornito settimana 3
- month: valore nel mese
- trimester: valore nel trimestre
- quadrimester: valore nel quarto trimestre
- year: valore nell'anno
L'API può restituire i seguenti codici di errore:
- 400 (Bad request): query malformata.
- 401 (Unauthorized): il token di autenticazione non è valido oppure è scaduto.
Esempio richiesta
GET https://api.messaggerielibri.it/titoli/supplyProposal?vendor=595
Authorization: Bearer [TOKEN JWT]
Esempio risposta
{
"totalCount": 4,
"totalPages": 1,
"page": {
"index": 1,
"size": 50,
"from": 1,
"to": 4
},
"data": [
{
"ean": "4001648694350",
"title": "PUSTEFIX BUBBLE-PIPE 70ML 869-435",
"vendor": {
"code": "595",
"description": "CARRERA TOYS GMBH"
},
"publisher": "CARRERA TOYS GMBH",
"articleSaleStatus": {
"code": "1",
"description": "IN COMMERCIO"
},
"articleStatus": {
"code": "3",
"description": "TEMP. NON DISPONIBILE ALL'ED."
},
"publicationDate": "2016-11-04",
"quantity": 1,
"stock": 0,
"saleOrders": 0,
"supplyOrders": 0,
"availability": 0,
"supplied": {
"week0": 0,
"week1": 0,
"week2": 0,
"week3": 0,
"month": 0,
"trimester": 0,
"quadrimester": 0,
"year": 0
}
},
{
"ean": "4001648695807",
"title": "PUSTEFIX MULTI-BUBBLER GIANT BUBBLES 250 ML 869-580",
"vendor": {
"code": "595",
"description": "CARRERA TOYS GMBH"
},
"publisher": "CARRERA TOYS GMBH",
"articleSaleStatus": {
"code": "1",
"description": "IN COMMERCIO"
},
"articleStatus": {
"code": "3",
"description": "TEMP. NON DISPONIBILE ALL'ED."
},
"publicationDate": "2016-11-03",
"quantity": 5,
"stock": 2,
"saleOrders": 0,
"supplyOrders": 0,
"availability": 2,
"supplied": {
"week0": 0,
"week1": 0,
"week2": 0,
"week3": 0,
"month": 0,
"trimester": 9,
"quadrimester": 0,
"year": 15
}
},
{
"ean": "4007486630154",
"title": "FIRST FERRARI 20063015",
"vendor": {
"code": "595",
"description": "CARRERA TOYS GMBH"
},
"publisher": "CARRERA TOYS GMBH",
"articleSaleStatus": {
"code": "1",
"description": "IN COMMERCIO"
},
"articleStatus": {
"code": "1",
"description": "DISPONIBILE"
},
"publicationDate": "2017-04-27",
"quantity": 10,
"stock": 2,
"saleOrders": 0,
"supplyOrders": 0,
"availability": 2,
"supplied": {
"week0": 0,
"week1": 1,
"week2": 0,
"week3": 0,
"month": 1,
"trimester": 35,
"quadrimester": 0,
"year": 35
}
},
{
"ean": "4007486630291",
"title": "MICKEY AND THE ROADSTER RACERS - 2.4M WITH SPINNERS",
"vendor": {
"code": "595",
"description": "CARRERA TOYS GMBH"
},
"publisher": "CARRERA TOYS GMBH",
"articleSaleStatus": {
"code": "1",
"description": "IN COMMERCIO"
},
"articleStatus": {
"code": "1",
"description": "DISPONIBILE"
},
"publicationDate": "2019-11-13",
"quantity": 10,
"stock": 4,
"saleOrders": 0,
"supplyOrders": 0,
"availability": 4,
"supplied": {
"week0": 0,
"week1": 0,
"week2": 0,
"week3": 0,
"month": 1,
"trimester": 12,
"quadrimester": 5,
"year": 25
}
}
]
}
Features
Per utilizzare il metodo API è necessario possedere una o più delle seguenti
features:
altrimenti viene restituito 403 (Forbidden)
Conferma richieste di approvvigionamento
Consente di Conferma le richieste di approvvigionamento corrispondenti ai titoli specificati.
Risponde a richieste POST verso: /titoli/supplyConfirmation
Per identificare la lista dei titoli per cui confermare le richieste di approvvigionamento viene richiesto un oggetto JSON contenente i seguenti campi:
- ean: codice EAN
- quantity: numero di copie
L'operazione restituisce un oggetto JSON contenente i seguenti campi:
- referenceDocument: ID della conferma di approvvigionamento
- vendor: editore. Contiene:
- code: codice editore
- description: nome editore
- confirmationDate: data di conferma
- eanCount: numero di EAN confermati
- confirmedQuantity: quantità confermata
L'API può restituire i seguenti codici di errore:
- 400 (Bad request): query malformata.
- 401 (Unauthorized): il token di autenticazione non è valido oppure è scaduto.
- 409 (Conflict): richiesta di approvvigionamento già confermata.
Esempio richiesta
POST https://api.messaggerielibri.it/titoli/supplyConfirmation
Authorization: Bearer [TOKEN JWT]
Esempio body richiesta
[
{
"ean":"9788899381011",
"quantity":1
}
]
Esempio risposta
[
{
"referenceDocument": "1000000069",
"vendor": {
"code": "299",
"description": "AD EST DELL'EQUATORE"
},
"confirmationDate": "2023-03-29T00:00:00",
"eanCount": 1,
"confirmedQuantity": 1
}
]
Features
Per utilizzare il metodo API è necessario possedere una o più delle seguenti
features:
altrimenti viene restituito 403 (Forbidden)