Ricerca delle DDT

Effettua la ricerca di una o più DDT.

Effettua la ricerca di DDT in base alla data.

Risponde a richieste GET verso: /vendorOutbound/bol

Come filtri di ricerca, è possibile passare in query string i seguenti parametri opzionali:

• vendorCode: di tipo string. Rappresenta il codice editore per cui effettuare la ricerca.
• startDate: data minima della DDT, di tipo date (es. 2021-01-09).
• endDate: data massima della DDT, di tipo date (es. 2021-01-09).
• number: di tipo string. Indica il numero della DDT per cui si desidera ottenere informazioni. Se non fornito, l’API restituisce i dati corrispondenti a tutte le DDT visibili dal chiamante.
• type: di tipo string. Indica la tipologia di fornitura. Può assumere i seguenti valori:
  • ED: Rese Editore
  • EG: Rese Guasti
  • EN: Rese Macero
  • 94: Conto lavorazione
• state: di tipo Indica lo stato di consegna della DDT, può assumere i seguenti valori:
  • shipped: in arrivo
  • received: ricevuto
  • error: riscontrate anomalie
  • lost: smarrito
• orderDirection: tipo di ordinamento. Può assumere come valore asc o desc (valore predefinito: asc).
• orderBy: campo su cui effettuare l’ordinamento. Può assumere i seguenti valori:
  • vendorCode (ordinamento per codice editore)
  • vendorDescription (ordinamento per descrizione editore)
  • plant (ordinamento per codice magazzino di spedizione)
  • number (ordinamento per numero DDT)
  • date (ordinamento per data DDT)
  • state (ordinamento per stato di consegna della DDT)
  • type (ordinamento per codice tipologia fornitura)
  • receiveDate (ordinamento per data di ricezione della DDT)
  • packagesCount (ordinamento per numero colli della DDT)
  • confirmedPackagesCount (ordinamento per numero colli della DDT di cui è confermata la ricezione)
  • packedQuantity (ordinamento per numero di copie contenute nella DDT)
  • confirmedQuantity (ordinamento per numero di copie confermate nella DDT)
  • shipTo (ordinamento per nome destinatario merce)
• pageIndex: numero della pagina da restituire (partendo da 1).
• pageSize: quanti record restituire per pagina (valore predefinito: 50).

L’operazione restituisce uno o più oggetti JSON contenente i seguenti campi:

• totalCount: numero totale di DDT trovate in base ai parametri di ricerca
• totalPages: numero totale di pagine
• page: informazioni sulla pagina corrente, contiene:
  • index: indice della pagina corrente (partendo da 1).
  • size: dimensione della pagina
  • from: indice del primo elemento contenuto nella pagina (partendo da 1).
  • to: indice dell’ultimo elemento contenuto nella pagina
• bols: elenco delle DDT contenute nella pagina di risultati corrente, è una lista di oggetti contenenti i seguenti campi:
  • plant: codice impianto da cui proviene la consegna. Può assumere i valori ME60 o ME61.
  • city: città dell'impianto
  • number: numero della DDT
    • date: data della DDT
    • vendor: editore destinatario della DDT, contiene:
      • code: codice editore
      • description: descrizione editore
    • type: tipologia fornitura, contiene:
      • code: codice della tipologia fornitura
      • description: descrizione della tipologia fornitura
    • shipTo: informazioni sul destinatario merce, contiene:
      • name: nome del destinatario merce
      • city: città del destinatario merce
      • province: provincia del destinatario merce
      • country: paese del destinatario merce
      • postalCode: cap del destinatario merce
      • address: indirizzo del destinatario merce
    • state: stato di consegna della DDT, può assumere i seguenti valori:
      • shipped: in arrivo
      • received: ricevuto
      • error: riscontrate anomalie
      • lost: smarrito
    • receiveDate: data di ricezione della DDT
    • receiptNotes: note di ricezione della DDT
    • packed: riassunto del contenuto dichiarato della DDT, contiene:
      • packages: numero colli contenuti nella DDT
      • quantity: numero di copie contenute nella DDT
    • confirmed: riassunto del contenuto confermato della DDT, contiene:
      • packages: numero colli confermati nella DDT
      • quantity: numero copie confermate nella DDT

Esempio richiesta:

GET https://api.messaggerielibri.it/vendorOutbound/bol?pageIndex=1&pageSize=50&startDate=2022-06-09&orderBy=confirmedPackagesCount&orderDirection=asc

Authorization: Bearer [TOKEN JWT]

Esempio risposta colli multipli: 

{
    "totalCount": 2,
    "totalPages": 1,
    "page": {
        "index": 1,
        "size": 50,
        "from": 1,
        "to": 2
    },
    "bols": [
        {
            "plant": "ME60",
            "number": "166934",
            "date": "2022-06-09",
            "vendor": {
                "code": "0000000015",
                "description": "IL MULINO"
            },
            "state": "shipped",
            "type": {
                "code": "EG",
                "description": "Rese Guasti"
            },
            "shipTo": {
                "name": "Ianieri Edizioni Srls presso Di Pasquale"
            },
            "courier": {
                "code": "00010648",
                "description": "BRT SPA"
            },
            "packed": {
                "packages": 1,
                "quantity": 30
            }
        },
        {
            "plant": "ME60",
            "number": "166954",
            "date": "2022-06-09",
            "vendor": {
                "code": "0000000015",
                "description": "IL MULINO"
            },
            "state": "shipped",
            "type": {
                "code": "EG",
                "description": "Rese Guasti"
            },
            "shipTo": {
                "name": "LA TORRE DI I.GALBUSERA"
            },
            "courier": {
                "code": "00010648",
                "description": "BRT SPA"
            },
            "packed": {
                "packages": 1,
                "quantity": 30
            }
        }
    ]
}

Features

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

• vendor_delivery_read

altrimenti viene restituito 403 (Forbidden)

Elenco colli DDT

Ottiene l'elenco dei colli associati ad una o più DDT.

Risponde a richieste GET verso: 

• /vendorOutbound/plant/{plant}/bol/{year}?number={billOfLading} (DDT multiple) 

Per identificare la DDT recuperare sono utilizzati i seguenti parametri: 

• plant: codice dell’impianto da cui proviene la consegna. Può assumere i valori ME60 o ME61. 
• year: anno di riferimento della DDT. 
• number: numero della DDT (nel caso di DDT multiple, inserito in query string, può essere passato più volte). 

Per la consultazione di DDT multiple, nel caso ai parametri forniti non corrispondano DDT presenti a sistema è restituita una lista vuota. 

L’operazione restituisce uno o più oggetti JSON contenente i seguenti campi: 

• plant: codice dell’impianto da cui proviene la consegna. Può assumere i valori ME60 o ME61. 
• number: numero della DDT. 
• date: data della DDT. 
• customerCode: codice cliente destinatario della DDT. 
• state: stato di consegna della DDT, può assumere i seguenti valori: 
  • shipped: in arrivo 
  • received: ricevuto 
  • error: riscontrate anomalie 
  • lost: smarrito 
• type: tipologia fornitura, contiene:
  • code: codice della tipologia di fornitura
  • description: descrizione della tipologia di fornitura
• receiveDate: data di ricezione della DDT
• receiptNotes: note di ricezione della DDT
• packages: elenco dei colli associati alla DDT, è una lista di oggetti contenenti i seguenti campi: 
  • id: identificativo collo
  • state: stato di consegna del collo, può assumere i seguenti valori: 
    • shipped: in arrivo 
    • received: ricevuto 
    • error: riscontrate anomalie 
    • lost: smarrito
  • packedQuantity: numero copie dichiarate
  • confirmedQuantity: numero copie confermate 

Esempio richiesta DDT singola:

GET https://api.messaggerielibri.it/vendorOutbound/plant/ME60/bol/2022?number=166934

Authorization: Bearer [TOKEN JWT]

Esempio risposta DDT singola:

[
    {
        "plant": "ME60",
        "number": "166934",
        "date": "2022-06-09",
        "customerCode": "R015",
        "state": "shipped",
        "type": {
            "code": "EG",
            "description": "Rese Guasti"
        },
        "packages": [
            {
                "id": "MEL053105736",
                "state": "shipped",
                "packedQuantity": 30
            }
        ]
    }
]

Esempio richiesta DDT multiple: 

GET
https://api.messaggerielibri.it/vendorOutbound/plant/ME60/bol/2022?number=166934&number=166954

Authorization: Bearer [TOKEN JWT]

Esempio risposta DDT multiple: 

[
    {
        "plant": "ME60",
        "number": "166954",
        "date": "2022-06-09",
        "customerCode": "R015",
        "state": "shipped",
        "type": {
            "code": "EG",
            "description": "Rese Guasti"
        },
        "packages": [
            {
                "id": "MEL053105736",
                "state": "shipped",
                "packedQuantity": 30
            }
        ]
    },
    {
        "plant": "ME60",
        "number": "166934",
        "date": "2022-06-09",
        "customerCode": "R015",
        "state": "shipped",
        "type": {
            "code": "EG",
            "description": "Rese Guasti"
        },
        "packages": [
            {
                "id": "MEL053105736",
                "state": "shipped",
                "packedQuantity": 30
            }
        ]
    }
]

Features

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

• vendor_delivery_read

altrimenti viene restituito 403 (Forbidden)

Elenco titoli

Ottiene l'elenco dei titoli presenti in uno o più colli di una DDT.

Risponde a richieste GET verso: 

• /vendorOutbound/plant/{plant}/bol/{year}/{billOfLading}/package/{packageId} (Collo singolo) 
• /vendorOutbound/plant/{plant}/bol/{year}/{billOfLading}/package (Colli multipli) 

Per identificare il collo da recuperare sono utilizzati i seguenti parametri: 

• plant: codice dell’impianto da cui proviene la consegna. Può assumere i valori ME60 o ME61. 
• year: anno di riferimento della DDT. 
• billOfLading: numero della DDT (nel caso di DDT singola). 
• packageId: identificativo del collo (nel caso di Collo singolo).
• id: identificativo del collo (nel caso di Colli multipli, inserito in query string, può essere passato più volte). 

Per la consultazione di un collo singolo, nel caso ai parametri forniti non corrisponda un Collo presente a sistema è restituito codice errore 404 (Not Found). 

Per la consultazione di Colli multipli, nel caso ai parametri forniti non corrispondano Colli presenti a sistema è restituita una lista vuota. 

L’operazione restituisce uno o più oggetti JSON contenente i seguenti campi: 

• id: identificativo del collo 
• state: stato di consegna del collo, può assumere i seguenti valori: 
  • shipped: in arrivo
  • received: ricevuto
  • error: riscontrate anomalie 
  • lost: smarrito
• titles: elenco dei titoli contenuti nel collo, è una lista di oggetti contenenti i seguenti campi: 
  • ean: codice EAN del titolo 
  • title: titolo 
  • vendor: 
    • code: codice editore 
    • description: descrizione editore
  • price: prezzo di copertina
  • packedQuantity: numero copie dichiarate
  • confirmedPackedQuantity: numero copie confermate 

Esempio richiesta collo singolo: 

GET
https://api.messaggerielibri.it/vendorOutbound/plant/ME61/bol/2022/0000505746/package/00000000000004313876

Authorization: Bearer[TOKEN JWT]

Esempio risposta collo singolo: ​

{
    "id": "00000000000004313876",
    "state": "shipped",
    "titles": [
        {
            "ean": "9788815000033",
            "title": "SEGMENTAZIONE DEL LAVORO E DOPPIA OCCUPAZIONE",
            "vendor": {
                "code": "015",
                "description": "IL MULINO"
            },
            "price": 12.91,
            "packedQuantity": 2
        },
        {
            "ean": "9788815000231",
            "title": "CORPO A SCUOLA. EDUCAZIONE MOTORIA SCUOLA ELEMENTARE",
            "vendor": {
                "code": "015",
                "description": "IL MULINO"
            },
            "price": 2.58,
            "packedQuantity": 1
        },
        {
            "ean": "9788815000361",
            "title": "LE BELLI ARTI RICONDOTTE A UN UNICO PRINCIPIO",
            "vendor": {
                "code": "015",
                "description": "IL MULINO"
            },
            "price": 7.75,
            "packedQuantity": 6
        },
        {
            "ean": "9788815001528",
            "title": "V E STORIA CULTURA GIURIDICA MODERNA VOL.01",
            "vendor": {
                "code": "015",
                "description": "IL MULINO"
            },
            "price": 30.99,
            "packedQuantity": 1
        },
        {
            "ean": "9788815001689",
            "title": "TERRORISMO E VIOLENZA POLITICA",
            "vendor": {
                "code": "015",
                "description": "IL MULINO"
            },
            "price": 7.75,
            "packedQuantity": 6
        },
        {
            "ean": "9788815001726",
            "title": "LA PERCEZIONE",
            "vendor": {
                "code": "015",
                "description": "IL MULINO"
            },
            "price": 15.49,
            "packedQuantity": 4
        },
        {
            "ean": "9788815001825",
            "title": "IL SISTEMA AMMINISTRATIVO ITALIANO",
            "vendor": {
                "code": "015",
                "description": "IL MULINO"
            },
            "price": 22.72,
            "packedQuantity": 4
        },
        {
            "ean": "9788897417088",
            "title": "D'ANNUNZIO E L'ALDILA'",
            "vendor": {
                "code": "481",
                "description": "IANIERI EDIZIONI"
            },
            "price": 16.00,
            "packedQuantity": 2
        }
    ]
}

Esempio richiesta colli multipli: 

GET 
https://ml-api-dev-mgmt.azure-api.net/vendorOutbound/plant/ME61/bol/2022/0000505746/package?id=000000008815000046&id=00000000000004313870

Authorization: Bearer [TOKEN JWT]

Esempio risposta colli multipli: 

[
    {
        "id": "000000008815000046",
        "state": "shipped",
        "titles": [
            {
                "ean": "9788815000279",
                "title": "VYGOTSKIJ ANTOLOGIA DI SCRITTI DI PSICOLOGIA",
                "vendor": {
                    "code": "015",
                    "description": "IL MULINO"
                },
                "price": 12.91,
                "packedQuantity": 4
            }
        ]
    },
    {
        "id": "00000000000004313870",
        "state": "shipped",
        "titles": [
            {
                "ean": "9788815000279",
                "title": "VYGOTSKIJ ANTOLOGIA DI SCRITTI DI PSICOLOGIA",
                "vendor": {
                    "code": "015",
                    "description": "IL MULINO"
                },
                "price": 12.91,
                "packedQuantity": 1
            },
            {
                "ean": "9788815000583",
                "title": "V.E.TRANSIZIONE DELL'ECONOMIA DI GUERRA E DI PACE",
                "vendor": {
                    "code": "015",
                    "description": "IL MULINO"
                },
                "price": 20.66,
                "packedQuantity": 9
            },
            {
                "ean": "9788815001542",
                "title": "V E LA SCIENZA NEL MEDIOEVO",
                "vendor": {
                    "code": "015",
                    "description": "IL MULINO"
                },
                "price": 7.75,
                "packedQuantity": 7
            },
            {
                "ean": "9788815001719",
                "title": "DISPLAY UPM (MURRAY GRANT WOOLF)",
                "vendor": {
                    "code": "015",
                    "description": "IL MULINO"
                },
                "price": 61.97,
                "packedQuantity": 4
            },
            {
                "ean": "9788815001832",
                "title": "V E PSICOLOGIA COGNITIVISTA",
                "vendor": {
                    "code": "015",
                    "description": "IL MULINO"
                },
                "price": 17.56,
                "packedQuantity": 3
            },
            {
                "ean": "9788815001849",
                "title": "GLI STATI UNITI FRA PRIMATO E INCERTEZZA",
                "vendor": {
                    "code": "015",
                    "description": "IL MULINO"
                },
                "price": 10.33,
                "packedQuantity": 3
            },
            {
                "ean": "9788897417125",
                "title": "MANGA E IL FANTASMA DELL'ABATE LEONATE.",
                "vendor": {
                    "code": "481",
                    "description": "IANIERI EDIZIONI"
                },
                "price": 9.50,
                "packedQuantity": 1
            },
            {
                "ean": "9788897417217",
                "title": "MANGA CONTRO ERCOLE",
                "vendor": {
                    "code": "481",
                    "description": "IANIERI EDIZIONI"
                },
                "price": 11.50,
                "packedQuantity": 2
            },
            {
                "ean": "9788897417774",
                "title": "LA RELIGIONE DI D'ANNUNZIO.",
                "vendor": {
                    "code": "481",
                    "description": "IANIERI EDIZIONI"
                },
                "price": 16.00,
                "packedQuantity": 3
            },
            {
                "ean": "9788897417897",
                "title": "L'AUTOMA E I SUOI AUTOMI",
                "vendor": {
                    "code": "481",
                    "description": "IANIERI EDIZIONI"
                },
                "price": 10.00,
                "packedQuantity": 1
            }
        ]
    }
]

Features

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

• vendor_delivery_read

altrimenti viene restituito 403 (Forbidden)

Recupero DDT in formato PDF

Ottiene un documento della DDT Editore in formato PDF.

Risponde a richieste GET verso: /vendorOutbound/plant/{plant}/bol/{year}/{billOfLading}/pdf

Per identificare la DDT da recuperare sono utilizzati i seguenti parametri:

• plant: codice dell’impianto da cui proviene la consegna. Può assumere i valori ME60 o ME61.
• year: anno di riferimento della DDT.
• billOfLading: numero della DDT.

Nel caso ai parametri forniti non corrisponda una DDT con relativo documento PDF è restituito codice errore 404 (Not Found).

Il metodo restituisce uno stream binario contenente il PDF del documento di trasporto.

Esempio richiesta :

GET 
https://api.messagerielibri.it/vendorOutbound/plant/ME60/bol/2018/259183/pdf
Authorization: Bearer [TOKEN JWT]

Features

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

• vendor_delivery_read

altrimenti viene restituito 403 (Forbidden)