Iscrizione titoli a piano di lancio

Questa API consente di consultare e creare le iscrizioni dei titoli a piano di lancio.

Per gestire le API di iscrizione titoli a piano di lancio tramite autenticazione è necessario utilizzare lo scope: title_api_scope.

Operazioni

L'API espone i seguenti metodi:

Ricerca dei lanci

Consente di  effettuare la ricerca dei lanci.

Risponde a richieste GET verso: /titoli/launch

E' possibile passare in querystring i seguenti parametri opzionali per filtrare la ricerca:

  • launchNumber: numero del lancio
  • launchYear: anno del lancio
  • saleDateFrom: limite inferiore per la data di consegna in libreria
  • saleDateTo: limite superiore per la data di consegna in libreria
  • launchStatus: stato del lancio (open / closed)
  • deliveryCreated: consegna creata (true/false)
  • orderBy: campo su cui effettuare l’ordinamento. Può assumere i seguenti valori:
    • year
    • number
    • registrationLimit
    • deliveryLimit
    • saleDate
    • saleDateBy
    • billingMonth
    • titlesCount
    • plantCode
    • storageLocation
  • 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 lanci 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)
  • launches: elenco dei lanci trovati. Contiene:
    • launchStatus: stato del lancio (chiuso/aperto)
    • launchYear: anno del lancio
    • launchNumber: numero del lancio
    • registrationLimit: data limite per l'iscrizione al lancio
    • deliveryLimit: data consegna in magazzino
    • saleDate: data messa in vendita
    • saleDateBy: data di vendita entro
    • billingMonth: mese di fatturazione
    • titlesCount: numero di titoli iscritti al lancio
    • deliveryCreated: consegna creata (true/false)
    • plant: impianto. Contiene:
      • code: codice impianto
      • description: descrizione impianto
    • storage: magazzino. Contiene:
      • code: codice magazzino
      • description: descrizione magazzino

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/launch?pageIndex=1&launchStatus=open&orderDirection=asc&launchYear=2023&saleDateFrom=2023-08-01
Authorization: Bearer [TOKEN JWT]

Esempio risposta

{
	"totalCount": 5,
	"totalPages": 1,
	"page": {
		"index": 1,
		"size": 50,
		"from": 1,
		"to": 5
	},
	"launches": [
		{
			"launchStatus": "open",
			"launchYear": 2023,
			"launchNumber": "31.0",
			"registrationLimit": "2023-07-13T00:00:00",
			"deliveryLimit": "2023-07-20T00:00:00",
			"saleDate": "2023-08-01T00:00:00",
			"saleDateBy": "2023-08-04T00:00:00",
			"billingMonth": "07",
			"titlesCount": 0,
"deliveryCreated": true, "plant": { "code": "ME60", "description": "C&M Book Logistics" }, "storage": { "code": "86", "description": "Novità" } }, { "launchStatus": "open", "launchYear": 2023, "launchNumber": "32.0", "registrationLimit": "2023-07-20T00:00:00", "deliveryLimit": "2023-07-27T00:00:00", "saleDate": "2023-08-08T00:00:00", "saleDateBy": "2023-08-11T00:00:00", "billingMonth": "08", "titlesCount": 0,
"deliveryCreated": true, "plant": { "code": "ME60", "description": "C&M Book Logistics" }, "storage": { "code": "86", "description": "Novità" } }, { "launchStatus": "open", "launchYear": 2023, "launchNumber": "33.0", "registrationLimit": "2023-07-27T00:00:00", "deliveryLimit": "2023-08-03T00:00:00", "saleDate": "2023-08-15T00:00:00", "saleDateBy": "2023-08-18T00:00:00", "billingMonth": "08", "titlesCount": 0,
"deliveryCreated": true, "plant": { "code": "ME60", "description": "C&M Book Logistics" }, "storage": { "code": "86", "description": "Novità" } }, { "launchStatus": "open", "launchYear": 2023, "launchNumber": "34.0", "registrationLimit": "2023-08-03T00:00:00", "deliveryLimit": "2023-08-10T00:00:00", "saleDate": "2023-08-22T00:00:00", "saleDateBy": "2023-08-25T00:00:00", "billingMonth": "08", "titlesCount": 0,
"deliveryCreated": true, "plant": { "code": "ME60", "description": "C&M Book Logistics" }, "storage": { "code": "86", "description": "Novità" } }, { "launchStatus": "open", "launchYear": 2023, "launchNumber": "35.0", "registrationLimit": "2023-08-10T00:00:00", "deliveryLimit": "2023-08-17T00:00:00", "saleDate": "2023-08-29T00:00:00", "saleDateBy": "2023-09-01T00:00:00", "billingMonth": "08", "titlesCount": 0,
"deliveryCreated": true, "plant": { "code": "ME60", "description": "C&M Book Logistics" }, "storage": { "code": "86", "description": "Novità" } } ] }

Features

Per utilizzare il metodo API è necessario possedere una o più delle seguenti features:

  • launch_read

altrimenti viene restituito 403 (Forbidden)

Recupero dettagli di un lancio

Consente di ottenere il dettaglio di un lancio con i suoi titoli iscritti.

Risponde a richieste GET verso: /launch/{year}/{launchNumber} , dove {year} rappresenta l'anno del lancio e {launchNumber} il numero del lancio.

L’operazione restituisce un oggetto JSON contenente i seguenti campi:

  • launch: lancio. Contiene:
    • launchStatus: stato del lancio (chiuso/aperto). Può assumere i seguenti valori: closed, opened
    • launchYear: anno del lancio
    • launchNumber: numero del lancio
    • registrationLimit: data limite per l'iscrizione al lancio
    • deliveryLimit: data consegna in magazzino
    • saleDate: data messa in vendita
    • saleDateBy: data di vendita entro
    • billingMonth: mese di fatturazione
    • titlesCount: numero di titoli iscritti al lancio
    • deliveryCreated: consegna creata (true/false)
    • plant: impianto. Contiene:
      • code: codice impianto
      • description: descrizione impianto
    • storage: magazzino. Contiene:
      • code: codice magazzino
      • description: descrizione magazzino
  • titles: titoli. Contiene:
    • eanCode: codice EAN
    • vendorCode: codice editore
    • vendor: editore
    • shortArticleTitle: titolo breve
    • longArticleTitle: titolo lungo
    • author: autore
    • vatCode: codice IVA
    • vatDescription: descrizione dell’aliquota IVA
    • priceList: prezzo
    • orderedCopies: copie ordinate
    • orderedAmount: importo ordinato
    • articleSaleStatusCode: codice stato di vendita
    • articleSaleStatusDescription: descrizione stato vendita
    • articleStatusCode: codice risposta editore
    • articleStatusDescription: descrizione risposta editore

L’API può restituire i seguenti codici di errore: 

  • 400 (Bad Request): query malformata.
  • 401 (Unauthorized)il token di autenticazione non è valido oppure è scaduto.
  • 404 (Not Found)ai parametri forniti non corrisponde alcun lancio.

 

Esempio richiesta: 

GET
https://api.messaggerielibri.it/titoli/launch/2023/190
Authorization: Bearer[TOKEN JWT]

 

Esempio risposta: 

{
	"launch": {
		"launchStatus": "opened",
		"launchYear": 2023,
		"launchNumber": "19.0",
		"registrationLimit": "2023-04-20T00:00:00",
		"deliveryLimit": "2023-04-27T00:00:00",
		"saleDate": "2023-05-09T00:00:00",
		"saleDateBy": "2023-05-12T00:00:00",
		"billingMonth": "05",
		"titlesCount": 0,
"deliveryCreated": true, "plant": { "code": "ME60" }, "storage": { "code": "86" } }, "titles": [] }

Features

Per utilizzare il metodo API è necessario possedere una o più delle seguenti features:

  • launch_read

altrimenti viene restituito 403 (Forbidden)

Iscrizione di una lista di titoli al lancio

Consente di iscrivere una lista di titoli al lancio.

Risponde a richieste POST verso: /titoli/launch/{year}/{launchNumber}/titles, dove {year} rappresenta l'anno del lancio e {launchNumber} il numero del lancio.

Per identificare i titoli da iscrivere al lancio viene richiesto un oggetto JSON contenente una lista di ean.

Se l’esecuzione è terminata con successo, l’API restituisce 204 No Content senza alcun body.

L’API può restituire i seguenti codici di errore: 

  • 400 (Bad Request): query malformata.
  • 401 (Unauthorized)il token di autenticazione non è valido oppure è scaduto.
  • 404 (Not Found)ai parametri forniti non corrisponde alcun lancio.
  • 409 (Conflict): titolo già iscritto al lancio.

Esempio richiesta: 

POST
https://api.messaggerielibri.it/titoli/launch/2023/600/titles
Authorization: Bearer[TOKEN JWT]

Esempio body richiesta

["9788831460347"]

Features

Per utilizzare il metodo API è necessario possedere una o più delle seguenti features:

  • launch_registration

altrimenti viene restituito 403 (Forbidden)

Iscrizione di un singolo titolo al lancio

Consente di iscrivere un titolo al lancio.

Risponde a richieste PUT verso: /titoli/launch/{year}/{launchNumber}/titles/{eanCode}, dove {year} rappresenta l'anno del lancio, {launchNumber} il numero del lancio, {eanCode} l'ean del titolo da iscrivere

Se l’esecuzione è terminata con successo, l’API restituisce 204 No Content senza alcun body.

L’API può restituire i seguenti codici di errore: 

  • 400 (Bad Request): query malformata.
  • 401 (Unauthorized)il token di autenticazione non è valido oppure è scaduto.
  • 404 (Not Found)ai parametri forniti non corrisponde alcun lancio o titolo.
  • 409 (Conflict): titolo già iscritto al lancio.

Esempio richiesta: 

PUT
https://api.messaggerielibri.it/titoli/launch/2023/600/titles/0012345678905
Authorization: Bearer[TOKEN JWT]

Features

Per utilizzare il metodo API è necessario possedere una o più delle seguenti features:

  • launch_registration

altrimenti viene restituito 403 (Forbidden)

Rimozione di una lista di titoli da un lancio

Consente di rimuovere una lista di titoli da un lancio.

Risponde a richieste POST verso: /titoli/launch/{year}/{launchNumber}/titlesDelete, dove {year} rappresenta l'anno del lancio e {launchNumber} il numero del lancio.

Per identificare i titoli da rimuovere dal lancio viene richiesto un oggetto JSON contenente una lista di ean.

Se l’esecuzione è terminata con successo, l’API restituisce 204 No Content senza alcun body.

L’API può restituire i seguenti codici di errore: 

  • 400 (Bad Request): query malformata.
  • 401 (Unauthorized)il token di autenticazione non è valido oppure è scaduto.
  • 404 (Not Found)ai parametri forniti non corrisponde alcun lancio o alcun titolo.

Esempio richiesta: 

POST
https://api.messaggerielibri.it/titoli/launch/2023/600/titlesDelete
Authorization: Bearer[TOKEN JWT]

Esempio body richiesta

["9788831460347"]

Features

Per utilizzare il metodo API è necessario possedere una o più delle seguenti features:

  • launch_registration

altrimenti viene restituito 403 (Forbidden)

Rimozione di un singolo titolo da un lancio

Consente di rimuovere un titolo dal lancio.

Risponde a richieste DELETE verso: /titoli/launch/{year}/{launchNumber}/titles/{eanCode}, dove {year} rappresenta l'anno del lancio, {launchNumber} il numero del lancio, {eanCode} l'ean del titolo da rimuovere.

Se l’esecuzione è terminata con successo, l’API restituisce 204 No Content senza alcun body.

L’API può restituire i seguenti codici di errore: 

  • 400 (Bad Request): query malformata.
  • 401 (Unauthorized)il token di autenticazione non è valido oppure è scaduto.
  • 404 (Not Found)ai parametri forniti non corrisponde alcun lancio o titolo.

Esempio richiesta: 

DELETE
https://api.messaggerielibri.it/titoli/launch/2023/600/titles/0012345678905
Authorization: Bearer[TOKEN JWT]

Features

Per utilizzare il metodo API è necessario possedere una o più delle seguenti features:

  • launch_registration

altrimenti viene restituito 403 (Forbidden)