-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathufficiopostale.openapi.json
More file actions
1 lines (1 loc) · 222 KB
/
Copy pathufficiopostale.openapi.json
File metadata and controls
1 lines (1 loc) · 222 KB
1
{"openapi":"3.0.1","info":{"title":"Ufficio Postale","version":"1.1.0","description":"This web service allows the delivery of postal products like Raccomandate, Telegrammi, Posta Prioritaria through Poste Italiane <ol><li>Create a new mail with a POST request</li><li>Check the prices and confirm it with a PATCH, or use <em>autoconfirm: true</em></li><li>Receive the status updates of your mail by providing a <em>callback</em> url</li></ol> <br> <strong>Note: </strong> There are some limitations regarding the size of a PDF document. Please read the 'document' field in the description of the endpoint that you want to use. <br><br> <h2>Error handling</h2> When a sending error occurs, the response will include a <code>message</code> and a <code>data.wrong_fields: []</code>: each element of <code>wrong_fields</code> is a string which indicates where the error was generated from. This makes it very easy to integrate in your front-end form, where you can highlight the wrong entries<h2>Testing</h2>When using the Sandbox environment, you will receive update callbacks a short time after creating the request with placeholder content. It is also possible, for some products, to force the execution of the callback in the sandbox environment.","termsOfService":"https://openapi.it/en/terms-and-conditions","contact":{"url":"https://openapi.it/en/support","name":"Support"},"x-logo":{"url":"https://ws.ufficiopostale.com/img/logo.png"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://ws.ufficiopostale.com","description":"Production"},{"url":"https://test.ws.ufficiopostale.com","description":"Sandbox"}],"paths":{"/telegrammi/{id}":{"get":{"tags":["Telegrammi"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"If the option has been set, it returns a specifc schema with state equal to the one requested","schema":{"type":"string","example":"NEW"}}],"summary":"Get information about a telegram","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"stati":{"$ref":"#/components/schemas/ExampleState"},"mittente":{"type":"object","properties":{"nome":{"type":"string"},"cognome":{"type":"string"},"email":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"}}},"destinatari":{"type":"array","items":{"type":"object","properties":{"nome":{"type":"string"},"cognome":{"type":"string"},"email":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"IdRicevuta":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"}}}},"callback":{"$ref":"#/components/schemas/callback"},"opzioni":{"type":"object","properties":{"fronteretro":{"type":"boolean"},"colori":{"type":"boolean"},"autoconfirm":{"type":"boolean"},"mittente":{"type":"boolean"}}},"creation_timestamp":{"type":"number"},"update_timestamp":{"type":"number"},"confirmed":{"type":"boolean"},"id":{"type":"string"}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{}}},"example":{"data":{"mittente":{"nome":"Mario","cognome":"Rossi","dug":"via","indirizzo":"Dante Alighieri","civico":"4","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","email":"john.doe@openapi.it"},"destinatari":[{"nome":"PRIMO","cognome":"ROSSI","dug":"VIA","indirizzo":"PRIMO MAGGIO","civico":"6","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","id":"609d43e457d71a5b600ee17c","state":"NEW","IdRicevuta":"WG55505B956001"}],"documento":["Test document"],"opzioni":{"ar_c":{"nome":"Mario","cognome":"Rossi","dug":"via","indirizzo":"Dante Alighieri","civico":"4","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","email":"john.doe@openapi.it"},"fronteretro":false,"colori":false,"autoconfirm":true,"mittente":false,"ar_e":false,"timestamp_invio":1620919269},"prodotto":"telegramma","creation_timestamp":1620919268,"update_timestamp":1620919779,"username":"john.doe@openapi.it","confirmed":true,"state":"SENT","documento_validato":{"pdf":"https://ws.ufficiopostale.com/Up/pdf/0000000eeaaaa11111111xxxxx.pdf","jpg":"https://ws.ufficiopostale.com/Up/jpg/0000000eeaaaa11111111xxxxx.jpg","parole":2,"size":11},"pricing":{"dettaglio":[{"codice_servizio":"RicevutaRitornoCartacea","descrizione_servizio":"Ricevuta cartacea","percentuale_iva":22,"quantita":1,"importo_unitario_totale":7.93,"importo_unitario_netto":6.5,"importo_unitario_iva":1.4300000000000002},{"codice_servizio":"parole","descrizione_servizio":"Tariffa Postale parole","percentuale_iva":22,"quantita":1,"importo_unitario_totale":4.27,"importo_unitario_netto":3.5,"importo_unitario_iva":0.77},{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","percentuale_iva":22,"quantita":1,"importo_unitario_totale":0,"importo_unitario_netto":0,"importo_unitario_iva":0},{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","percentuale_iva":22,"quantita":1,"importo_unitario_totale":0,"importo_unitario_netto":0,"importo_unitario_iva":0}],"totale":{"importo_totale_netto":10,"importo_totale_iva":2.2,"importo_totale":12.2}},"confirmed_timestamp":1620919269,"GuidUtente":"xxxxxx-ae90-48b5-bec1-abcdefg","IDRichiesta":"xxxxxx-ae90-48b5-bec1-abcdefg","sending_timestamp":1620919746,"substate":"SENT","error":null,"error_timestamp":1620919356,"sent_timestamp":1620919779,"id":"xxxxxxxe557d71a5b600ee17d"},"message":"","success":true,"error":null}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"Id Specificato non valido","error":3010,"data":null}}}}}},"patch":{"summary":"Confirm send of a telegram","description":"Confirm sending a telegram that was created with \"autoconfirm = false\"","tags":["Telegrammi"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"confirmed":{"type":"boolean"}}},"examples":{"0":{"value":{"confirmed":true}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExampleResponseTelegram"},"example":{"data":[{"mittente":{"ragione_sociale":"Mario Rossi Srl","dug":"Viale","indirizzo":"dei Giardini","civico":"82","comune":"san dona' di piave","cap":"30027","provincia":"VE","nazione":"IT","email":"test@test.com"},"destinatari":[{"ragione_sociale":"prova spa","dug":"viale","indirizzo":"rossi mario","civico":"82","comune":"san dona' di piave","cap":"30027","provincia":"VE","nazione":"IT","id":"649998d25b295d43ac0f1e78","state":"NEW"}],"documento":["tmpfiles.org/dl/980693/br223_compressed.pdf"],"opzioni":{"fronteretro":true,"ar_c":false,"ar_e":false,"ricevuta":false,"autoconfirm":false,"timestamp_invio":1687787732},"prodotto":"telegramma","creation_timestamp":1687787729,"update_timestamp":1687787742,"username":"prova-tests@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://test.ws.ufficiopostale.com/Up/pdf/telegrammaUBLwd2TfrzVnSTMymTi5SnmAo.pdf","jpg":"https://test.ws.ufficiopostale.com/Up/jpg/telegrammaUBLwd2TfrzVnSTMymTi5SnmAo.jpg","filename":"telegrammaUBLwd2TfrzVnSTMymTi5SnmAo.pdf","parole":25,"size":176},"callback":{"method":"JSON","url":"https://your-webhook.site/","user_id":"","username":"","field":"","headers":{"chiave":"valore"},"data":{},"retry":0,"scope":null,"domain":null,"custom":null},"pricing":{"dettaglio":[{"codice_servizio":"parole","descrizione_servizio":"Tariffa postale parole","percentuale_iva":0,"quantita":25,"importo_unitario_netto":6.92,"importo_unitario_iva":0,"importo_unitario_totale":6.92},{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","percentuale_iva":0,"quantita":1,"importo_unitario_netto":0.32,"importo_unitario_iva":0,"importo_unitario_totale":0.32},{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","percentuale_iva":0,"quantita":1,"importo_unitario_netto":0.12,"importo_unitario_iva":0,"importo_unitario_totale":0.12}],"totale":{"importo_totale_netto":5.21,"importo_totale_iva":0,"importo_totale":5.21}},"confirmed_timestamp":1687787742,"id":"649998d45b295d43ac0f1e79"}],"success":true,"message":"","error":null}}}},"421":{"description":"Misdirected Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"example":{"success":false,"message":"Telegramma non specificato","error":3030,"data":null}}}}}}},"/telegrammi/{id}/accettazione":{"get":{"tags":["Telegrammi"],"description":"Download the \"accettazione\" receipt if requested at the time of submission . \n - Acceptance is the process that certifies the acknowledgment of a request by the system. During this phase, the data provided by the user is validated, and if correct, an acceptance receipt is generated. This receipt is a digital document that formally confirms the acceptance of the request and marks the starting point for subsequent processing.\n\n The acceptance receipt includes:\n \n - The date and time of acceptance.\n - Details about the requested service, the sender, and the recipient.","summary":"Download accettazione Telegrammi","parameters":[{"name":"id","description":"ID of request","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/pdf":{"example":"pdf"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"data":[],"success":true,"message":"","error":null}}}}}}},"/telegrammi/":{"get":{"summary":"List your telegrams","tags":["Telegrammi"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"mittente":{"type":"object","properties":{"nome":{"type":"string"},"cognome":{"type":"string"},"email":{"type":"string"}}},"creation_timestamp":{"type":"number"},"update_timestamp":{"type":"number"},"confiermed":{"type":"boolean"},"id":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{}}},"example":{"data":[{"mittente":{"nome":"Mario","cognome":"Rossi","email":"john.doe@openapi.it"},"creation_timestamp":1620919268,"update_timestamp":1620919779,"confirmed":true,"state":"SENT","error":null,"id":"xxxxxxxe557d71a5b600ee17d"}],"message":"1 Risultati","success":true,"error":null}}}}}},"post":{"summary":"Create your request","tags":["Telegrammi"],"description":"Send a telegram. You should provide information about the sender and the receiver(s) in the post body. Additionally, the \"autoconfirm\" parameter can be set to false to save the telegram for a later confirmation with a PATCH request, while you do custom logic with the response.\n\n\n\nThis endpoint now supports sending foreign telegrams. Here are the key details:\n\n- **Foreign Telegram Support**: You can now send telegrams to international destinations.\n- **Single Recipient**: Foreign telegrams are limited to one recipient only.\n- **Address Format**: For foreign telegrams, it's crucial to write the complete address within the 'indirizzo' (address) field as shown in the example.\n- **Province Setting**: The 'provincia' (province) field will be automatically set to 'EE' (estero/foreign) for foreign addresses.\n- **Pricing Information**: To check the rates for foreign telegrams, you can use the [/pricing/ endpoint](https://console.openapi.com/it/apis/ufficiopostale/documentation#/Ufficio%20Postale/get_pricing_).\n- **Available Options**: All options specific to foreign telegrams are listed in the schema. Any additional options not listed will be ignored.\n- **List of Countries**: For a list of countries to which you can send foreign telegrams, please refer to the [/nazioni/ endpoint](https://console.openapi.com/it/apis/ufficiopostale/documentation#/Ufficio%20Postale/get_nazioni_). \n\nPlease refer to the schema for the complete list of fields and options available for both domestic and foreign telegrams.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"opzioni":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/telegramma_options"},{"$ref":"#/components/schemas/telegramma_foreign_options"}]}},"mittente":{"type":"object","properties":{"titolo":{"type":"string"},"nome":{"type":"string"},"cognome":{"type":"string"},"ragione_sociale":{"$ref":"#/components/schemas/ragione_sociale_object"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"cap":{"type":"string"},"comune":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"email":{"type":"string"}},"required":["nome","cognome","cap","comune","dug","indirizzo","nazione","civico","provincia"]},"destinatari":{"type":"array","items":{"oneOf":[{"type":"object","title":"recipient","properties":{"titolo":{"type":"string","example":"Mr/Mrs"},"nome":{"type":"string"},"cognome":{"type":"string"},"ragione_sociale":{"$ref":"#/components/schemas/ragione_sociale_object"},"cap":{"type":"string"},"comune":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"nazione":{"type":"string"},"civico":{"type":"string"},"provincia":{"type":"string"},"co":{"type":"string","description":"Presso (c/o)"}},"required":["nome","cognome","cap","comune","dug","indirizzo","nazione","civico","provincia"]},{"$ref":"#/components/schemas/telegramma_foreign_recipient_object"}]}},"callback":{"$ref":"#/components/schemas/callback"},"documento":{"$ref":"#/components/schemas/documentoTelegramma"}}},"examples":{"telegrammaItalia":{"summary":"telegramma","value":{"mittente":{"ragione_sociale":"openapi spa","dug":"piazza","indirizzo":"cavur '","civico":"43","comune":"roma","cap":"00121","provincia":"rm","email":"prova.******@gmail.com","nazione":"IT"},"destinatari":[{"nome":"Giacomo","cognome":"Rossi","dug":"VIA","indirizzo":"PROVA","civico":"8","comune":"MIlano","cap":"20123","provincia":"MI","nazione":"IT","id":"664228bbbf*****01b0815f2","state":"NEW"}],"documento":["XX XXXXXX XXXXXXXXXXXXXXX XXXXX XXXXXXXX XXXXXXXXX XXXXXXXXX XXXXX XXXXXXXX XXX, XX XXXXXXXX XXXXX X XXX XXXXX XX XXXXXXX XXX 18 XXXXX 2023,XXXXXXX XX XXXXX XX XXXXXXX XXXXXXXX XX XXXXXXXX XXXXXXX XX 250.000 XXXX, XXXXXX XX XXXXXXX XX X. 3 XXXXXXX XXX XX XXXXXX XX 30000 XXXX. XX XXXXXXXX XXXXXXXX XXXXXXX XXXXXX XXXXX XX 30 XXXXXXXXX 2023, XXXXXXXXXX XX XXXXX XXXXXXXXXXXXXX XX XXXXX XX XXXXXXXXXXXXXX XXXXXX X XXXXXX XX XXXXXXXXX XXXXXX XX XXXX XXXXXXXXXXX. XX XXXXXXXXX XX XX XXXXXXXX XXXX XXXXXXXX XXXXXXXX; XX XXXX XXXXXXXXX, XX XXXXXXXXX XXXXX XXXXXXXXXXXX X XXXXXXXXXXXX XX XXXXXX XXXXXXXXXXXXX XXXXX XXXX XXXXXXXXX, XXXXXXXXXXXX XX XXXXXXXXXX XX XXXXXXXXXXXX XX XXXX XXXXX XXXXXX."],"opzioni":{"autoconfirm":false,"mittente":true,"ar_c":false,"ar_e":false},"callback":{"url":"https://your-server.site/123232","custom":123}}},"telegrammaEstero":{"summary":"Foreign Telegram","value":{"data":{"mittente":{"ragione_sociale":"openapi spa","dug":"viale","indirizzo":"cavur'","civico":"221","comune":"roma","cap":"00143","provincia":"rm","email":"prova.******@gmail.com","nazione":"IT"},"destinatari":[{"nome":"Tony","cognome":"Stark","indirizzo":"99 **** Avenue","comune":"Wycombe","cap":"NP131AA","provincia":"ee","nazione":"GB","state":"NEW","id":"664228bbbf1*****1b081123"}],"documento":["XX XXXXXX XXXXXXXXXXXXXXX XXXXX XXXXXXXX XXXXXXXXX XXXXXXXXX XXXXX XXXXXXXX XXX, XX XXXXXXXX XXXXX X XXX XXXXX XX XXXXXXX XXX 18 XXXXX 2023,XXXXXXX XX XXXXX XX XXXXXXX XXXXXXXX XX XXXXXXXX XXXXXXX XX 250.000 XXXX, XXXXXX XX XXXXXXX XX X. 3 XXXXXXX XXX XX XXXXXX XX 30000 XXXX. XX XXXXXXXX XXXXXXXX XXXXXXX XXXXXX XXXXX XX 30 XXXXXXXXX 2023, XXXXXXXXXX XX XXXXX XXXXXXXXXXXXXX XX XXXXX XX XXXXXXXXXXXXXX XXXXXX X XXXXXX XX XXXXXXXXX XXXXXX XX XXXX XXXXXXXXXXX. XX XXXXXXXXX XX XX XXXXXXXX XXXX XXXXXXXX XXXXXXXX; XX XXXX XXXXXXXXX, XX XXXXXXXXX XXXXX XXXXXXXXXXXX X XXXXXXXXXXXX XX XXXXXX XXXXXXXXXXXXX XXXXX XXXX XXXXXXXXX, XXXXXXXXXXXX XX XXXXXXXXXX XX XXXXXXXXXXXX XX XXXX XXXXX XXXXXX."],"opzioni":{"mittente":true,"ricevuta":true,"autoconfirm":true},"callback":{"url":"https://your-server.site/123232","custom":123}}}}}}}},"callbacks":{"callback":{"{$request.body#/opzioni/callback_url}":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCallback"}}}},"responses":{"200":{"description":"OK"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostalServiceResponse"},"examples":{"0":{"value":{"data":{"mittente":{"ragione_sociale":"openapi spa","dug":"piazza","indirizzo":"cavur '","civico":"43","comune":"roma","cap":"00121","provincia":"rm","email":"prova.******@gmail.com","nazione":"IT","destinatari":[{"nome":"Giacomo","cognome":"Rossi","dug":"VIA","indirizzo":"PROVA","civico":"8","comune":"MIlano","cap":"20123","provincia":"MI","nazione":"IT","id":"664228bbbf1239901b0815f2","state":"NEW"},{"nome":"Mario","cognome":"Rossi","co":"OPENAPI SRL","dug":"PIAZZA","indirizzo":"San Giovanni","civico":"6","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","id":"61041dc0ac2b1f63327e92d1","state":"NEW"}],"documento":"lorem ipsum","opzioni":{"autoconfirm":true,"mittente":false,"ar_c":false,"ar_e":false,"timestamp_invio":1627659712},"prodotto":"telegramma","creation_timestamp":1627659712,"update_timestamp":1627659712,"username":"john.doe@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://ws.ufficiopostale.com/Up/pdf/test-document.pdf","jpg":"https://ws.ufficiopostale.com/Up/jpg/test-document.jpg","parole":1,"txt":"L","size":1},"pricing":{"dettaglio":[{"codice_servizio":"parole","descrizione_servizio":"Tariffa Postale parole","percentuale_iva":22,"quantita":2,"importo_unitario_totale":4.27,"importo_unitario_netto":3.5,"importo_unitario_iva":0.77},{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","percentuale_iva":22,"quantita":2,"importo_unitario_totale":0,"importo_unitario_netto":0,"importo_unitario_iva":0},{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","percentuale_iva":22,"quantita":2,"importo_unitario_totale":0,"importo_unitario_netto":0,"importo_unitario_iva":0}],"totale":{"importo_totale_netto":7,"importo_totale_iva":1.54,"importo_totale":8.54}},"lock":false,"confirmed_timestamp":1627659712,"id":"61041dc0ac2b1f63327e92d2"}},"success":true,"message":"","error":null}}}}}},"421":{"description":"Misdirected Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"example":{"success":false,"message":"Impossibile Modificare oggetto","error":3020,"data":null}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"examples":{"0":{"value":{"success":false,"message":"Dati obbligatori 'ragione_sociale' o 'nome' e 'cognome'","error":11020,"data":{"wrong_fields":["mittente.nome","mittente.cognome","mittente.ragione_sociale"]}}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"},"execution_time":{"type":"number"}}},"example":{"success":false,"message":"Errore inizializzazione file temporaneo","error":13080,"data":null}}}}}}},"/pricing/":{"get":{"tags":["Ufficio Postale"],"summary":"Get pricings","description":"Returns a list of prices for various kinds of services","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"tipologia":{"type":"string"},"prodotto":{"type":"string"},"descrizione":{"type":"string"},"riferimento_prezzo":{"type":"string"},"accetta_allegati":{"type":"boolean"},"attivo":{"type":"boolean"},"tariffe":{"type":"array","items":{"type":"object","properties":{"iva_tariffa_postale":{"type":"number"},"iva_stampa_imbustamento":{"type":"number"},"tipologia":{"type":"string"},"da":{"type":"number"},"a":{"type":"number"},"tariffa_postale":{"type":"number"},"zona":{"oneOf":[{"type":"string"},{"type":"number"}]},"stampa":{"type":"number"},"imbustamento":{"type":"number"}}}},"options":{"type":"object","properties":{"<Option_Key>":{"type":"object","properties":{"nome_option":{"type":"string"},"nome_option_invio":{"type":"string"},"prezzo_option":{"type":"number"},"iva":{"type":"number"},"attivo":{"type":"boolean"},"valore_option":{"type":"string","description":"The value of the option in the <code>opzioni</code> property of a product (es: <code>colori</code>, <code>fronteretro</code> etc)"}}}}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{}}},"examples":{"200":{"description":"OK","value":{"data":[{"tipologia":"raccomandata","prodotto":"raccomandata","descrizione":"Raccomandata","riferimento_prezzo":"pagina","accetta_allegati":1,"attivo":1,"tariffe":[{"iva_tariffa_postale":0,"iva_stampa_imbustamento":0,"tipologia":"pagine","da":0,"a":1,"tariffa_postale":3.4,"zona":0,"stampa":0.1,"imbustamento":0},{"iva_tariffa_postale":0,"iva_stampa_imbustamento":0,"tipologia":"pagine","da":2,"a":2,"tariffa_postale":3.4,"zona":0,"stampa":0.2,"imbustamento":0},{"iva_tariffa_postale":0,"iva_stampa_imbustamento":0,"tipologia":"pagine","da":3,"a":3,"tariffa_postale":3.4,"zona":0,"stampa":0.3,"imbustamento":0},{"iva_tariffa_postale":0,"iva_stampa_imbustamento":0,"tipologia":"pagine","da":4,"a":5,"tariffa_postale":4.55,"zona":0,"stampa":0.3,"imbustamento":0},{"iva_tariffa_postale":0,"iva_stampa_imbustamento":0,"tipologia":"pagine","da":6,"a":9,"tariffa_postale":4.55,"zona":0,"stampa":0.35,"imbustamento":0},{"iva_tariffa_postale":0,"iva_stampa_imbustamento":0,"tipologia":"pagine","da":10,"a":13,"tariffa_postale":4.55,"zona":0,"stampa":0.4,"imbustamento":0},{"iva_tariffa_postale":0,"iva_stampa_imbustamento":0,"tipologia":"pagine","da":14,"a":18,"tariffa_postale":4.55,"zona":0,"stampa":0.45,"imbustamento":0},{"iva_tariffa_postale":0,"iva_stampa_imbustamento":0,"tipologia":"pagine","da":19,"a":10000000,"tariffa_postale":4.55,"zona":0,"stampa":0.45,"imbustamento":0}],"options":{"StampaColori":{"nome_option":"Stampa Colori","nome_option_invio":"StampaColori","prezzo_option":0.8,"iva":0,"attivo":1},"RicevutaRitorno":{"nome_option":"Ricevuta di Ritorno","nome_option_invio":"RicevutaRitorno","prezzo_option":0.8,"iva":0,"attivo":1},"FronteRetro":{"nome_option":"Stampa Fronte/Retro","nome_option_invio":"FronteRetro","prezzo_option":0.3,"iva":0,"attivo":1}},"username":null}],"success":true,"message":"","error":null}}}}}}}}},"/pricing/{service}":{"get":{"tags":["Ufficio Postale"],"summary":"Get pricing for a specific service","description":"Returns pricing information for the specified postal service.","parameters":[{"in":"path","name":"service","required":true,"schema":{"type":"string","enum":["atti_giudiziari","raccomandate","telegrammi","ordinarie","prioritarie","telegrammi_estero","raccomandate_estero","ordinarie_estero","prioritarie_estero","raccomandate_smart","posta_massiva","posta_massiva_top"]},"description":"The specific postal service to get pricing for."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricingResponseSchema"},"examples":{"TelegrammaEsteroPricing":{"value":{"data":{"tipologia":"telegramma","prodotto":"telegramma_estero","descrizione":"Telegramma_estero","riferimento_prezzo":"parole","accetta_allegati":1,"attivo":1,"tariffe":[{"iva_tariffa_postale":0,"iva_imbustamento":0,"iva_stampa_imbustamento":0,"tipologia":"parole","zona":"A","tariffa_postale":0.32,"stampa":0.32,"imbustamento":0.12,"prezzo_fisso":7.23,"iva_prezzo_fisso":0},{"iva_tariffa_postale":0,"iva_imbustamento":0,"iva_stampa_imbustamento":0,"tipologia":"parole","zona":"G","tariffa_postale":0.77,"stampa":0.32,"imbustamento":0.12}]},"success":true,"message":"","error":null}},"RaccomandataEsteroPricing":{"value":{"data":{"tipologia":"raccomandata","prodotto":"raccomandata_estero","descrizione":"Raccomandata_estero","riferimento_prezzo":"pagina","accetta_allegati":1,"attivo":1,"tariffe":[{"iva_tariffa_postale":0,"iva_imbustamento":0,"iva_stampa_imbustamento":0,"tipologia":"pagine","da":1,"a":1,"tariffa_postale":7.57,"zona":1,"stampa":0.94,"imbustamento":0.12},{"iva_tariffa_postale":0,"iva_imbustamento":0,"iva_stampa_imbustamento":0,"tipologia":"pagine","da":2,"a":2,"tariffa_postale":7.63,"zona":1,"stampa":0.95,"imbustamento":0.12},{"iva_tariffa_postale":0,"iva_imbustamento":0,"iva_stampa_imbustamento":0,"tipologia":"pagine","da":3,"a":3,"tariffa_postale":7.69,"zona":1,"stampa":0.96,"imbustamento":0.12},{"iva_tariffa_postale":0,"iva_imbustamento":0,"iva_stampa_imbustamento":0,"tipologia":"pagine","da":4,"a":4,"tariffa_postale":7.75,"zona":1,"stampa":0.97,"imbustamento":0.12}]},"success":true,"message":"","error":null}}}}}}}}},"/nazioni/{service}":{"get":{"tags":["Ufficio Postale"],"summary":"Get countries list","description":"Returns a list of countries with available postal services. \nYou can optionally filter by service type by adding a path parameter.\nAvailable service types are: telegramma_estero, raccomandata_estero, ordinaria_estero, prioritaria_estero.\n\nExample: /nazioni/telegramma_estero\n\nThis will return only countries where the specified service is available, including the pricing zone.\n\nZone information:\n- For raccomandata_estero, ordinaria_estero, and prioritaria_estero: Zones range from 1 to 3.\n- For telegramma_estero: Zones range from A to H.\n\nThe zone determines the pricing tier for each country and service.\nFor detailed pricing information, please refer to the /pricing/ endpoint.\n","parameters":[{"in":"path","name":"service","required":true,"schema":{"type":"string","enum":["telegramma_estero","raccomandata_estero","ordinaria_estero","prioritaria_estero"]},"description":"Optional. Filter countries by specific postal service."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CountriesServiceResponse"}},"success":{"type":"boolean","description":"Indicates if the request was successful"},"message":{"type":"string","description":"Additional information about the response"},"error":{"type":"object","nullable":true,"description":"Error details, if any"}}},"examples":{"raccomandata_estero":{"summary":"Response for raccomandata_estero","value":{"data":{"AL":{"nome":"Albania","name":"Albania","zona":1},"DZ":{"nome":"Algeria","name":"Algeria","zona":1},"AD":{"nome":"Andorra","name":"Andorra","zona":1},"AO":{"nome":"Angola","name":"Angola","zona":2}},"success":true,"message":"","error":null}},"telegramma_estero":{"summary":"Response for telegramma_estero","value":{"data":{"AL":{"nome":"Albania","name":"Albania","zona":"C"},"DZ":{"nome":"Algeria","name":"Algeria","zona":"A"},"AD":{"nome":"Andorra","name":"Andorra","zona":"A"},"AO":{"nome":"Angola","name":"Angola","zona":"G"}},"success":true,"message":"","error":null}}}}}}}}},"/nazioni/":{"get":{"tags":["Ufficio Postale"],"summary":"Get full countries list","description":"Returns a list of all countries with their available postal services.","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountriesResponse"},"example":{"data":{"AL":{"nome":"Albania","name":"Albania","products":{"telegramma_estero":true,"raccomandata_estero":true,"ordinaria_estero":true,"prioritaria_estero":true}},"DZ":{"nome":"Algeria","name":"Algeria","products":{"telegramma_estero":true,"raccomandata_estero":true,"ordinaria_estero":true,"prioritaria_estero":true}},"IC":{"nome":"Isole Canarie","name":"Canary Islands","products":{"telegramma_estero":true}},"CC":{"nome":"Isole Cocos","name":"Cocos (Keeling) Islands","products":{"telegramma_estero":true}}},"success":true,"message":"","error":null}}}}}}},"/covers/":{"get":{"tags":["Ufficio Postale"],"summary":"Get all cover configurations","description":"Retrieves a list of all cover configurations created","responses":{"200":{"description":"Successful response","content":{"application/json":{"example":{"data":[{"header":"text header","mittente":"yourbase64","dettaglioMittente":"yourbase64","body":"yourbase64","footer":"text footer","dettaglioLettera":"text","creation_timestamp":1725895605,"update_timestamp":1725896412,"status":"READY","error":"","id":"66df13b5e19ee05eb800234a"},{"header":"yourbase64","mittente":"yourbase64","dettaglioMittente":"yourbase64","body":"yourbase64","footer":"base64","dettaglioLettera":"base64","creation_timestamp":1728658590,"update_timestamp":1728658590,"status":"ERROR CREATE","error":"\"Errore in creaCover: Code: a:InternalServiceFault, String: Error in deserializing body of request message for operation 'CreaCover'., Detail: The maximum string content length quota (8192) has been exceeded while reading XML data. This quota may be increased by changing the MaxStringContentLength property on the XmlDictionaryReaderQuotas object used when creating the XML reader. Line 1, position 2321.\",\n","last_callback_status\"":{"status_code":200,"responde_data":""},"callback":{"url":"https://your-server.site/123232","custom":123},"id":"67093c9e46d1398aa40c64a2"},{"header":"yourbase64","mittente":"yourbase64","dettaglioMittente":"yourbase64","body":"yourbase64","footer":"base64","dettaglioLettera":"base64","creation_timestamp":1728658590,"update_timestamp":1728658590,"status":"NEW","callback":{"url":"https://your-server.site/123232","custom":123},"id":"67093c9e46d1398aa40c64a2"}],"success":true,"message":"","error":null}}}}}},"post":{"tags":["Ufficio Postale"],"summary":"Create a new cover","description":"Create a new cover for postal services including Registered Mail, Priority Mail, and Ordinary Mail.\n\nYou can insert either custom text or an image, the image must be in a supported format (e.g., JPEG, PNG)\n\n\nYou can find details and examples of the individual field in the schema \n\n\n[Example Cover PDF](https://storage.googleapis.com/docs-openapi-it-bucket/copertina-def.pdf)\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoverRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoverResponse"},"example":{"data":{"header":"yourbase64","mittente":"yourbase64","dettaglioMittente":"yourbase64","body":"yourbase64","footer":"base64","dettaglioLettera":"base64","creation_timestamp":1728658590,"update_timestamp":1728658590,"status":"NEW","callback":{"url":"https://your-server.site/123232","custom":123},"id":"67093c9e46d1398aa40c64a2"},"success":true,"message":"","error":null}}}},"400":{"description":"Successful response","content":{"application/json":{"example":{"success":false,"message":"Invalid fields detected: {*****}. Only the following fields are allowed: 'header', 'mittente', 'dettaglioMittente', 'body', 'footer', 'opzioni', 'dettaglioLettera'","error":1050,"data":null}}}}}}},"/covers/{id}":{"get":{"tags":["Ufficio Postale"],"summary":"Get specific cover configuration","description":"Retrieves the configuration of a specific cover by its ID. Optionally can download the preview if the status is READY.","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"Unique identifier of the cover"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoverDetailResponse"},"example":{"data":{"header":"yourbase64","mittente":"yourbase64","dettaglioMittente":"yourbase64","body":"yourbase64","footer":"base64","dettaglioLettera":"base64","creation_timestamp":1728658590,"update_timestamp":1728658590,"status":"NEW","callback":{"url":"https://your-server.site/123232","custom":123},"id":"67093c9e46d1398aa40c64a2"},"success":true,"message":"","error":null}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"No configuration found","error":1045,"data":null}}}}}}},"/covers/{id}/preview":{"get":{"tags":["Ufficio Postale"],"summary":"Get specific cover preview","description":"Retrieves the configuration of a specific cover by its ID. Optionally can download the preview if the status is READY.If the cover status is READY, returns the preview for download instead of the configuration","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"Unique identifier of the cover"}],"responses":{"200":{"description":"Successful response","content":{"application/pdf":{"schema":{"type":"string","format":"binary","description":"Preview PDF file (only when preview=true and status is READY)"}}}},"404":{"description":"Not Found","content":{"application/json":{"example":{"success":false,"message":"No configuration found","error":1045,"data":null}}}}}}},"/dug/":{"get":{"tags":["Ufficio Postale"],"summary":"List of all available dugs","description":"(denomiazioni urbanistiche generiche)","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"dug":{"type":"string"},"codice_dug":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{}}},"examples":{"0":{"value":{"data":[{"codice_dug":"BGO","dug":"Borgo"}],"message":"1 Risultato","success":true,"error":null}}}}}}}}},"/posta_massiva_top/":{"get":{"tags":["Posta Massiva Top"],"summary":"List your Posta Massiva Top","description":"List your Posta Massiva Top","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExempleResponseMassivaTop1"},"example":{"data":[{"mittente":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi"},"creation_timestamp":1657169682,"update_timestamp":1676901090,"confirmed":false,"state":"SENT","id":"xxxxxxxe557d71a5b600ee11d"},{"mittente":{"nome":"Fabio","email":"fabio@openapi.com","cognome":"verdi"},"creation_timestamp":1657169682,"update_timestamp":1676901090,"confirmed":false,"state":"NEW","id":"xxxxxxxe557d71a5b600ee14d"},{"mittente":{"nome":"Sara","email":"sara@openapi.com","cognome":"Rossi"},"creation_timestamp":1657169682,"update_timestamp":1676901090,"confirmed":false,"state":"NEW","id":"xxxxxxxe557d71a5b6005e13d"}],"message":"3 Risultati","success":true,"error":null}}}}}},"post":{"summary":"Create your request","tags":["Posta Massiva Top"],"description":"Send a Posta Massiva Top. You should provide information about the sender and the receiver(s) in the post body. Additionally, the \"autoconfirm\" parameter can be set to false to save it for a later confirmation with a PATCH request, while you do custom logic with the response.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opzioni":{"allOf":[{"$ref":"#/components/schemas/posta_massiva_top_options"}]},"mittente":{"type":"object","properties":{"titolo":{"type":"string","description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"nome":{"type":"string","maxLength":44,"description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"cognome":{"type":"string","maxLength":44,"description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"co":{"type":"string","maxLength":44,"description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"ragione_sociale":{"$ref":"#/components/schemas/ragione_sociale_object"},"dug":{"type":"string","description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"indirizzo":{"type":"string","maxLength":43,"description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"civico":{"type":"string","maxLength":5,"description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"comune":{"type":"string","maxLength":37,"description":"comune + cap + provincia must not exceed 44 characters (including spaces)"},"provincia":{"type":"string","maxLength":2,"description":"comune + cap + provincia must not exceed 44 characters (including spaces)"},"cap":{"type":"string","maxLength":5,"description":"comune + cap + provincia must not exceed 44 characters (including spaces)"},"nazione":{"type":"string"},"email":{"type":"string"}},"required":["nome","cognome","cap","comune","dug","indirizzo","nazione","civico","provincia","email"]},"destinatari":{"description":"It is mandatory to enter the full name(nome, cognome) or business name(ragione sociale).","type":"object","title":"Recipient or Casella postale","oneOf":[{"type":"object","title":"Recipient","allOf":[{"$ref":"#/components/schemas/generic_recipient_object"},{"type":"object","properties":{"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"provincia":{"type":"string"},"cap":{"type":"string"},"nazione":{"type":"string"},"co":{"type":"string","description":"Presso (c/o)"}},"required":["cap","comune","dug","indirizzo","nazione","civico","provincia"]}]},{"type":"object","title":"Casella postale","required":["casella_postale","ufficio_postale","comune","provincia","cap"],"allOf":[{"$ref":"#/components/schemas/generic_recipient_object"},{"type":"object","properties":{"casella_postale":{"type":"string","description":"The code of your 'Casella Postale': <a href=\"https://www.poste.it/prodotti/caselle-postali.html\">https://www.poste.it/prodotti/caselle-postali.html</a>"},"comune":{"type":"string"},"ufficio_postale":{"type":"string","description":"The Postal Office to send your mail to"},"provincia":{"type":"string","description":"The Postal Office to send your mail to"},"cap":{"type":"string","description":"The Postal Office to send your mail to"}}}]}]},"documento":{"$ref":"#/components/schemas/documento"},"callback":{"$ref":"#/components/schemas/callback"}}},"example":{"mittente":{"nome":"Mario","cognome":"Rossi","dug":"Via","indirizzo":"Dante Alighieri","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"Italia","email":"john.doe@openapi.it"},"destinatari":[{"nome":"Mario","cognome":"Rossi","dug":"via","indirizzo":"Morandi","civico":"6","comune":"Roma","cap":"00101","provincia":"RM","nazione":"Italia"}],"documento":["Example document"],"opzioni":{"fronteretro":false,"colori":false,"autoconfirm":false}}}}},"callbacks":{"callback":{"{$request.body#/opzioni/callback_url}":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCallback"}}}},"responses":{"200":{"description":"OK"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExempleResponseMassivaTop2"},"example":{"data":[{"mittente":{"nome":"Mario","email":"john.doe@openapi.it","cognome":"Rossi","dug":"via","indirizzo":"Dante Alighieri","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi"},"destinatari":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi","dug":"via","indirizzo":"Morandi","civico":"6","comune":"Roma","cap":"00101","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi","id":"xxxxxxxe557d71a5b600ee17d","state":"NEW"},"documento":["Example document"],"opzioni":{"fronteretro":false,"colori":true,"autoconfirm":false},"prodotto":"posta_massiva_top","creation_timestamp":1687169678,"update_timestamp":1687169682,"username":"gcloud-tests@openapi.it","confirmed":false,"state":"CONFIRMED","documento_validato":{"pdf":"https://test.ws.ufficiopostale.com/Up/pdf/posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.pdf","jpg":"https://test.ws.ufficiopostale.com/Up/jpg/posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.jpg","filename":"posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.pdf","pagine":1,"size":6849,"pricing":{"totale":{"importo_totale":0.74},"dettaglio":[{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","importo_unitario_totale":0.29,"importo_unitario_netto":0.23,"importo_unitario_iva":0.06,"quantita":1},{"codice_servizio":"spedizione","descrizione_servizio":"Spedizione","importo_unitario_totale":0.45,"importo_unitario_netto":0.45,"importo_unitario_iva":0,"quantita":1}]},"id":"xxxxxxxe557d71a5b600ee13d"}}],"success":true,"message":"","error":null}}}},"421":{"description":"Misdirected Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"example":{"success":false,"message":"Impossibile Modificare oggetto","error":52020,"data":null}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"Oggetto Mittente assente","error":11010,"data":null}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"trace":{"type":"string"},"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"Errore durante il calcolo del prezzo","error":13080,"data":null}}}}}}},"/posta_massiva_top/{id}":{"get":{"tags":["Posta Massiva Top"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"If the option has been set, it returns a specifc schema with state equal to the one requested","schema":{"type":"string","example":"NEW"}}],"summary":"List your single Posta Massiva Top","description":"List your single Posta Massiva Top","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ExempleResponseMassivaTop2"}]},"example":{"data":[{"mittente":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi","dug":"via","indirizzo":"trastevere","civico":"8","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi"},"destinatari":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi","dug":"via","indirizzo":"ener bettica","civico":"7","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi","id":"xxxxxxxe557d71a5b600ee17d","state":"NEW"},"documento":["test prova"],"opzioni":{"fronteretro":false,"colori":true,"autoconfirm":true,"timestamp_invio":1687169681},"callback":{"url":"https://your-server.site/123232","custom":123},"prodotto":"posta_massiva_top","creation_timestamp":1687169678,"update_timestamp":1687169682,"username":"gcloud-tests@openapi.it","confirmed":false,"state":"CONFIRMED","documento_validato":{"pdf":"https://test.ws.ufficiopostale.com/Up/pdf/posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.pdf","jpg":"https://test.ws.ufficiopostale.com/Up/jpg/posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.jpg","filename":"posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.pdf","pagine":1,"size":6849,"pricing":{"totale":{"importo_totale":0.74},"dettaglio":[{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","importo_unitario_totale":0.29,"importo_unitario_netto":0.23,"importo_unitario_iva":0.06,"quantita":1},{"codice_servizio":"spedizione","descrizione_servizio":"Spedizione","importo_unitario_totale":0.45,"importo_unitario_netto":0.45,"importo_unitario_iva":0,"quantita":1}]},"id":"xxxxxxxe557d71a5b600ee13d"}}],"success":true,"message":"","error":null}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"Id Specificato non valido","error":54010,"data":null}}}}}},"patch":{"summary":"Confirm send Posta Massiva Top","tags":["Posta Massiva Top"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Confirm sending a mail that was created with \"autoconfirm = false\"","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"confirmed":{"type":"boolean"}}},"example":{"confirmed":true}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExempleResponseMassivaTop2"},"example":{"data":[{"mittente":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi","dug":"via","indirizzo":"ener bettica","civico":"7","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi"},"destinatari":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi","dug":"via","indirizzo":"umbria","civico":"10","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi","id":"xxxxxxxe557d71a5b600ee17d","state":"NEW"},"documento":["test prova"],"opzioni":{"fronteretro":false,"colori":true,"autoconfirm":true,"timestamp_invio":1687169681},"callback":{"method":"JSON","url":"https://your-webhook.site/","user_id":"","username":"","field":"","headers":{"chiave":"valore"},"data":{},"retry":0,"scope":null,"domain":null,"custom":null},"prodotto":"posta_massiva_top","creation_timestamp":1687169678,"update_timestamp":1687169682,"username":"gcloud-tests@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://test.ws.ufficiopostale.com/Up/pdf/posta_massivayvSPArFg2S7ccrrK99YIuyItJ.pdf","jpg":"https://test.ws.ufficiopostale.com/Up/jpg/posta_massivayvSPArFg2S7ccrrK99YIuyItJ.jpg","filename":"posta_massivayvSPArFg2S7ccrrK99YIuyItJ.pdf","pagine":1,"size":6840,"callback":{"method":"JSON","url":"https://your-webhook.site/","user_id":"","username":"","field":"","headers":{"chiave":"valore"},"data":{},"retry":0,"scope":null,"domain":null,"custom":null},"pricing":{"totale":{"importo_totale":2.2},"dettaglio":[{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","importo_unitario_totale":0.29,"importo_unitario_netto":0.23,"importo_unitario_iva":0.06,"quantita":1},{"codice_servizio":"spedizione","descrizione_servizio":"spedizione","importo_unitario_totale":1.91,"importo_unitario_netto":1.91,"importo_unitario_iva":0,"quantita":1}]},"confirmed_timestamp":"1687169682,","id":"xxxxxxxe557d71a5b600ee13d"}}],"success":true,"message":"","error":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"examples":{"52050":{"value":{"success":false,"message":"Conferma non revocabile","error":52050,"data":null}},"52060":{"value":{"success":false,"message":"Elemento già confermato o non confermabile","error":52060,"data":null}}}}}},"421":{"description":"Misdirected Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"examples":{"52030":{"value":{"success":false,"message":"Elemento non specificato","error":52030,"data":null}},"52040":{"value":{"success":false,"message":"Elemento errato","error":52040,"data":null}}}}}}}}},"/posta_massiva_top/{id}/accettazione":{"get":{"tags":["Posta Massiva Top"],"description":"Download the \"accettazione\" receipt if requested at the time of submission . \n - Acceptance is the process that certifies the acknowledgment of a request by the system. During this phase, the data provided by the user is validated, and if correct, an acceptance receipt is generated. This receipt is a digital document that formally confirms the acceptance of the request and marks the starting point for subsequent processing.\n\n The acceptance receipt includes:\n \n - The date and time of acceptance.\n - Details about the requested service, the sender, and the recipient.","summary":"Download accettazione Posta Massiva Top","parameters":[{"name":"id","description":"ID of request","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/pdf":{"example":"pdf"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"data":[],"success":true,"message":"","error":null}}}}}}},"/posta_massiva/":{"get":{"tags":["Posta Massiva"],"summary":"List your Posta Massiva","description":"List your Posta Massiva","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExempleResponseMassiva1"},"example":{"data":[{"mittente":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi"},"creation_timestamp":1657169682,"update_timestamp":1676901090,"confirmed":false,"state":"SENT","id":"xxxxxxxe557d71a5b600ee11d"},{"mittente":{"nome":"Fabio","email":"fabio@openapi.com","cognome":"verdi"},"creation_timestamp":1657169682,"update_timestamp":1676901090,"confirmed":false,"state":"NEW","id":"xxxxxxxe557d71a5b600ee14d"},{"mittente":{"nome":"Sara","email":"sara@openapi.com","cognome":"Rossi"},"creation_timestamp":1657169682,"update_timestamp":1676901090,"confirmed":false,"state":"NEW","id":"xxxxxxxe557d71a5b6005e13d"}],"message":"3 Risultati","success":true,"error":null}}}}}},"post":{"summary":"Create your request","tags":["Posta Massiva"],"description":"Send a posta_massiva. You should provide information about the sender and the receiver(s) in the post body. Additionally, the \"autoconfirm\" parameter can be set to false to save it for a later confirmation with a PATCH request, while you do custom logic with the response.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opzioni":{"allOf":[{"$ref":"#/components/schemas/posta_p_options"}]},"mittente":{"type":"object","properties":{"titolo":{"type":"string","description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"nome":{"type":"string","maxLength":44,"description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"cognome":{"type":"string","maxLength":44,"description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"co":{"type":"string","maxLength":44,"description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"ragione_sociale":{"$ref":"#/components/schemas/ragione_sociale_object"},"dug":{"type":"string","description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"indirizzo":{"type":"string","maxLength":43,"description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"civico":{"type":"string","maxLength":5,"description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"comune":{"type":"string","maxLength":37,"description":"comune + cap + provincia must not exceed 44 characters (including spaces)"},"provincia":{"type":"string","maxLength":2,"description":"comune + cap + provincia must not exceed 44 characters (including spaces)"},"cap":{"type":"string","maxLength":5,"description":"comune + cap + provincia must not exceed 44 characters (including spaces)"},"nazione":{"type":"string"},"email":{"type":"string"}},"required":["nome","cognome","cap","comune","dug","indirizzo","nazione","civico","provincia","email"]},"destinatari":{"description":"It is mandatory to enter the full name(nome, cognome) or business name(ragione sociale).","type":"object","title":"Recipient or Casella postale","oneOf":[{"type":"object","title":"Recipient","allOf":[{"$ref":"#/components/schemas/generic_recipient_object"},{"type":"object","properties":{"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"provincia":{"type":"string"},"cap":{"type":"string"},"nazione":{"type":"string"},"co":{"type":"string","description":"Presso (c/o)"}},"required":["cap","comune","dug","indirizzo","nazione","civico","provincia"]}]},{"type":"object","title":"Casella postale","required":["casella_postale","ufficio_postale","comune","provincia","cap"],"allOf":[{"$ref":"#/components/schemas/generic_recipient_object"},{"type":"object","properties":{"casella_postale":{"type":"string","description":"The code of your 'Casella Postale': <a href=\"https://www.poste.it/prodotti/caselle-postali.html\">https://www.poste.it/prodotti/caselle-postali.html</a>"},"comune":{"type":"string"},"ufficio_postale":{"type":"string","description":"The Postal Office to send your mail to"},"provincia":{"type":"string","description":"The Postal Office to send your mail to"},"cap":{"type":"string","description":"The Postal Office to send your mail to"}}}]}]},"documento":{"$ref":"#/components/schemas/documento"},"callback":{"$ref":"#/components/schemas/callback"}}},"example":{"mittente":{"nome":"Mario","cognome":"Rossi","dug":"Via","indirizzo":"Dante Alighieri","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"Italia","email":"john.doe@openapi.it"},"destinatari":[{"nome":"Mario","cognome":"Rossi","dug":"via","indirizzo":"Morandi","civico":"6","comune":"Roma","cap":"00101","provincia":"RM","nazione":"Italia"}],"documento":["Example document"],"opzioni":{"fronteretro":false,"colori":false,"autoconfirm":false}}}}},"callbacks":{"callback":{"{$request.body#/opzioni/callback_url}":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCallback"}}}},"responses":{"200":{"description":"OK"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExempleResponseMassiva2"},"example":{"data":[{"mittente":{"nome":"Mario","email":"john.doe@openapi.it","cognome":"Rossi","dug":"via","indirizzo":"Dante Alighieri","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi"},"destinatari":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi","dug":"via","indirizzo":"Morandi","civico":"6","comune":"Roma","cap":"00101","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi","id":"xxxxxxxe557d71a5b600ee17d","state":"NEW"},"documento":["Example document"],"opzioni":{"fronteretro":false,"colori":true,"autoconfirm":false},"prodotto":"posta_massiva","creation_timestamp":1687169678,"update_timestamp":1687169682,"username":"gcloud-tests@openapi.it","confirmed":false,"state":"CONFIRMED","documento_validato":{"pdf":"https://test.ws.ufficiopostale.com/Up/pdf/posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.pdf","jpg":"https://test.ws.ufficiopostale.com/Up/jpg/posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.jpg","filename":"posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.pdf","pagine":1,"size":6849,"pricing":{"totale":{"importo_totale":0.74},"dettaglio":[{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","importo_unitario_totale":0.29,"importo_unitario_netto":0.23,"importo_unitario_iva":0.06,"quantita":1},{"codice_servizio":"spedizione","descrizione_servizio":"Spedizione","importo_unitario_totale":0.45,"importo_unitario_netto":0.45,"importo_unitario_iva":0,"quantita":1}]},"id":"xxxxxxxe557d71a5b600ee13d"}}],"success":true,"message":"","error":null}}}},"421":{"description":"Misdirected Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"example":{"success":false,"message":"Impossibile Modificare oggetto","error":52020,"data":null}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"Oggetto Mittente assente","error":11010,"data":null}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"trace":{"type":"string"},"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"Errore durante il calcolo del prezzo","error":13080,"data":null}}}}}}},"/posta_massiva/{id}":{"get":{"tags":["Posta Massiva"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"If the option has been set, it returns a specifc schema with state equal to the one requested","schema":{"type":"string","example":"NEW"}}],"summary":"List your single Posta Massiva","description":"List your single Posta Massiva","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ExempleResponseMassiva2"}]},"example":{"data":[{"mittente":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi","dug":"via","indirizzo":"trastevere","civico":"8","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi"},"destinatari":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi","dug":"via","indirizzo":"ener bettica","civico":"7","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi","id":"xxxxxxxe557d71a5b600ee17d","state":"NEW"},"documento":["test prova"],"opzioni":{"fronteretro":false,"colori":true,"autoconfirm":true,"timestamp_invio":1687169681},"callback":{"url":"https://your-server.site/123232","custom":123},"prodotto":"posta_massiva","creation_timestamp":1687169678,"update_timestamp":1687169682,"username":"gcloud-tests@openapi.it","confirmed":false,"state":"CONFIRMED","documento_validato":{"pdf":"https://test.ws.ufficiopostale.com/Up/pdf/posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.pdf","jpg":"https://test.ws.ufficiopostale.com/Up/jpg/posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.jpg","filename":"posta_massivaCw4wGmsHe9ddsD2RAB2ZyMdUm.pdf","pagine":1,"size":6849,"pricing":{"totale":{"importo_totale":0.74},"dettaglio":[{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","importo_unitario_totale":0.29,"importo_unitario_netto":0.23,"importo_unitario_iva":0.06,"quantita":1},{"codice_servizio":"spedizione","descrizione_servizio":"Spedizione","importo_unitario_totale":0.45,"importo_unitario_netto":0.45,"importo_unitario_iva":0,"quantita":1}]},"id":"xxxxxxxe557d71a5b600ee13d"}}],"success":true,"message":"","error":null}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"Id Specificato non valido","error":54010,"data":null}}}}}},"patch":{"summary":"Confirm send Posta Massiva","tags":["Posta Massiva"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Confirm sending a mail that was created with \"autoconfirm = false\"","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"confirmed":{"type":"boolean"}}},"example":{"confirmed":true}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExempleResponseMassiva2"},"example":{"data":[{"mittente":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi","dug":"via","indirizzo":"ener bettica","civico":"7","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi"},"destinatari":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi","dug":"via","indirizzo":"umbria","civico":"10","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi","id":"xxxxxxxe557d71a5b600ee17d","state":"NEW"},"documento":["test prova"],"opzioni":{"fronteretro":false,"colori":true,"autoconfirm":true,"timestamp_invio":1687169681},"callback":{"method":"JSON","url":"https://your-webhook.site/","user_id":"","username":"","field":"","headers":{"chiave":"valore"},"data":{},"retry":0,"scope":null,"domain":null,"custom":null},"prodotto":"posta_massiva","creation_timestamp":1687169678,"update_timestamp":1687169682,"username":"gcloud-tests@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://test.ws.ufficiopostale.com/Up/pdf/posta_massivayvSPArFg2S7ccrrK99YIuyItJ.pdf","jpg":"https://test.ws.ufficiopostale.com/Up/jpg/posta_massivayvSPArFg2S7ccrrK99YIuyItJ.jpg","filename":"posta_massivayvSPArFg2S7ccrrK99YIuyItJ.pdf","pagine":1,"size":6840,"callback":{"method":"JSON","url":"https://your-webhook.site/","user_id":"","username":"","field":"","headers":{"chiave":"valore"},"data":{},"retry":0,"scope":null,"domain":null,"custom":null},"pricing":{"totale":{"importo_totale":2.2},"dettaglio":[{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","importo_unitario_totale":0.29,"importo_unitario_netto":0.23,"importo_unitario_iva":0.06,"quantita":1},{"codice_servizio":"spedizione","descrizione_servizio":"spedizione","importo_unitario_totale":1.91,"importo_unitario_netto":1.91,"importo_unitario_iva":0,"quantita":1}]},"confirmed_timestamp":"1687169682,","id":"xxxxxxxe557d71a5b600ee13d"}}],"success":true,"message":"","error":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"examples":{"52050":{"value":{"success":false,"message":"Conferma non revocabile","error":52050,"data":null}},"52060":{"value":{"success":false,"message":"Elemento già confermato o non confermabile","error":52060,"data":null}}}}}},"421":{"description":"Misdirected Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"examples":{"52030":{"value":{"success":false,"message":"Elemento non specificato","error":52030,"data":null}},"52040":{"value":{"success":false,"message":"Elemento errato","error":52040,"data":null}}}}}}}}},"/posta_massiva/{id}/accettazione":{"get":{"tags":["Posta Massiva"],"description":"Download the \"accettazione\" receipt if requested at the time of submission . \n - Acceptance is the process that certifies the acknowledgment of a request by the system. During this phase, the data provided by the user is validated, and if correct, an acceptance receipt is generated. This receipt is a digital document that formally confirms the acceptance of the request and marks the starting point for subsequent processing.\n\n The acceptance receipt includes:\n \n - The date and time of acceptance.\n - Details about the requested service, the sender, and the recipient.","summary":"Download accettazione Posta Massiva","parameters":[{"name":"id","description":"ID of request","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/pdf":{"example":"pdf"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"data":[],"success":true,"message":"","error":null}}}}}}},"/raccomandate_smart/":{"get":{"tags":["Raccomandata Smart"],"summary":"List your raccomandate_smart","description":"List your raccomandate_smart","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"mittente":{"type":"object","properties":{"ragione_sociale":{"type":"string"},"nome":{"type":"string"},"email":{"type":"string"},"cognome":{"type":"string"}}},"creation_timestamp":{"type":"integer"},"update_timestamp":{"type":"integer"},"confirmed":{"type":"boolean"},"state":{"type":"string"},"id":{"type":"string"}}}},"message":{"type":"string"},"success":{"type":"boolean"},"error":{}}},"example":{"data":[{"mittente":{"ragione_sociale":"openapi srl","nome":"Mario","email":"mario@openapi.com","cognome":"Rossi"},"creation_timestamp":1657169682,"update_timestamp":1676901090,"confirmed":false,"state":"SENT","id":"xxxxxxxe557d71a5b600ee11d"}],"message":"1 Risultati","success":true,"error":null}}}}}},"post":{"summary":"Create your request","tags":["Raccomandata Smart"],"description":"Send a Raccomandata Smart. You should provide information about the sender and the receiver(s) in the post body. Additionally, the \"autoconfirm\" parameter can be set to false to save it for a later confirmation with a PATCH request, while you do custom logic with the response.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opzioni":{"allOf":[{"$ref":"#/components/schemas/raccomandata_s_options"}]},"mittente":{"type":"object","properties":{"titolo":{"type":"string","description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"nome":{"type":"string","maxLength":44,"description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"cognome":{"type":"string","maxLength":44,"description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"co":{"type":"string","maxLength":44,"description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"ragione_sociale":{"$ref":"#/components/schemas/ragione_sociale_object"},"dug":{"type":"string","description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"indirizzo":{"type":"string","maxLength":43,"description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"civico":{"type":"string","maxLength":5,"description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"comune":{"type":"string","maxLength":37,"description":"comune + cap + provincia must not exceed 44 characters (including spaces)"},"provincia":{"type":"string","maxLength":2,"description":"comune + cap + provincia must not exceed 44 characters (including spaces)"},"cap":{"type":"string","maxLength":5,"description":"comune + cap + provincia must not exceed 44 characters (including spaces)"},"nazione":{"type":"string"},"email":{"type":"string"}},"required":["nome","cognome","cap","comune","dug","indirizzo","nazione","civico","provincia","email"]},"destinatari":{"description":"It is mandatory to enter the full name(nome, cognome) or business name(ragione sociale).","type":"object","title":"Recipient or Casella postale","oneOf":[{"type":"object","title":"Recipient","allOf":[{"$ref":"#/components/schemas/generic_recipient_object"},{"type":"object","properties":{"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"provincia":{"type":"string"},"cap":{"type":"string"},"nazione":{"type":"string"},"co":{"type":"string","description":"Presso (c/o)"}},"required":["cap","comune","dug","indirizzo","nazione","civico","provincia"]}]},{"type":"object","title":"Casella postale","required":["casella_postale","ufficio_postale","comune","provincia","cap"],"allOf":[{"$ref":"#/components/schemas/generic_recipient_object"},{"type":"object","properties":{"casella_postale":{"type":"string","description":"The code of your 'Casella Postale': <a href=\"https://www.poste.it/prodotti/caselle-postali.html\">https://www.poste.it/prodotti/caselle-postali.html</a>"},"comune":{"type":"string"},"ufficio_postale":{"type":"string","description":"The Postal Office to send your mail to"},"provincia":{"type":"string","description":"The Postal Office to send your mail to"},"cap":{"type":"string","description":"The Postal Office to send your mail to"}}}]}]},"documento":{"$ref":"#/components/schemas/documento"},"callback":{"$ref":"#/components/schemas/callback"}}},"example":{"mittente":[{"ragione_sociale":"Openapi SRL","civico":"221","comune":"roma","dug":"via","indirizzo":"Filippo tommaso marinetti","cap":"00143","provincia":"RM","nazione":"IT","email":"l.paderi@openapi.it"}],"destinatari":[{"nome":"Mario","cognome":"Rossi","dug":"via","indirizzo":"Dante Alighieri","civico":"6","comune":"Roma","cap":"00143","provincia":"RM","nazione":"Italia"}],"documento":["https://www.soundczech.cz/temp/lorem-ipsum.pdf"],"opzioni":{"fronteretro":false,"colori":false,"ar":true,"autoconfirm":false},"callback":{"url":"https://your-server.site/123232","custom":123}}}}},"callbacks":{"callback":{"{$request.body#/opzioni/callback_url}":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCallback"}}}},"responses":{"200":{"description":"OK"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExempleResponseSmart"},"example":{"data":[{"mittente":{"ragione_sociale":"Openapi SRL","civico":"221","comune":"roma","dug":"via","indirizzo":"Filippo tommaso marinetti","cap":"00143","provincia":"RM","nazione":"IT","email":"l.paderi@openapi.it","intestazione_completa":"Mario Rossi"},"destinatari":{"nome":"Mario","cognome":"Rossi","dug":"via","indirizzo":"Dante Alighieri","civico":"6","comune":"Roma","cap":"00143","provincia":"RM","nazione":"Italia","intestazione_completa":"Mario Rossi","zona":"AM","id":"xxxxxxxe557d71a5b600ee17d","state":"NEW"},"documento":["https://www.soundczech.cz/temp/lorem-ipsum.pdf"],"opzioni":{"fronteretro":false,"colori":false,"ar":true,"autoconfirm":false},"callback":{"url":"https://your-server.site/123232","custom":123},"prodotto":"raccomandata_smart","creation_timestamp":1687169678,"update_timestamp":1687169682,"username":"gcloud-tests@openapi.it","confirmed":false,"state":"NEW","documento_validato":{"pdf":"https://test.ws.ufficiopostale.com/Up/pdf/raccomandata_smartu6pccgbnFNeRA69t7hvPDOKMa.pdf","jpg":"https://test.ws.ufficiopostale.com/Up/jpg/raccomandata_smartu6pccgbnFNeRA69t7hvPDOKMa.jpg","filename":"raccomandata_smartu6pccgbnFNeRA69t7hvPDOKMa.pdf","pagine":2,"size":49553,"pricing":{"totale":{"importo_totale":0.58},"dettaglio":[{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","importo_unitario_totale":0.28,"importo_unitario_netto":0.22,"importo_unitario_iva":0.06,"quantita":1},{"codice_servizio":"spedizione","descrizione_servizio":"Spedizione","importo_unitario_totale":0.3,"importo_unitario_netto":0.3,"importo_unitario_iva":0,"quantita":1}]},"id":"xxxxxxxe557d71a5b600ee13d"}}],"success":true,"message":"","error":null}}}},"421":{"description":"Misdirected Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"example":{"success":false,"message":"Impossibile Modificare oggetto","error":52020,"data":null}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"},"execution_time":{"type":"number"}}},"examples":{"11010":{"value":{"success":false,"message":"Oggetto Mittente assente","error":11010,"data":null}},"11015":{"value":{"success":false,"message":"Dati obbligatori 'ragione_sociale'","error":11015,"data":null}},"11020":{"value":{"success":false,"message":"Dati obbligatori 'ragione_sociale' o 'nome' e 'cognome'","error":11020,"data":null}},"11030":{"value":{"success":false,"message":"Dati obbligatori 'nome' e 'cognome' con 'titolo' specificato","error":11030,"data":null}},"11040":{"value":{"success":false,"message":"Lunghezza massima di 44 caratteri raggiunta per 'ragione_sociale' specificato +'titolo'+'nome'+'cognome inviati: wrong_fields","error":11040,"data":null}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"trace":{"type":"string"},"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"},"execution_time":{"type":"number"}}},"example":{"success":false,"message":"Errore durante il calcolo del prezzo","error":13080,"data":null}}}}}}},"/raccomandate_smart/{id}":{"get":{"tags":["Raccomandata Smart"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"If the option has been set, it returns a specifc schema with state equal to the one requested","schema":{"type":"string","example":"NEW"}}],"summary":"List your single raccomandata smart","description":"List your single raccomandata smart","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"properties":{"stati":{"$ref":"#/components/schemas/ExampleState"}}},{"$ref":"#/components/schemas/ExempleResponseSmart"}]},"example":{"data":[{"mittente":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi","dug":"via","indirizzo":"ener bettica","civico":"14","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi"},"destinatari":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi","dug":"via","indirizzo":"lazio","civico":"12","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi","id":"xxxxxxxe557d71a5b600ee17d","state":"NEW"},"documento":["test prova"],"opzioni":{"fronteretro":false,"colori":true,"autoconfirm":true,"timestamp_invio":1687169681},"callback":{"method":"JSON","url":"https://your-webhook.site/","user_id":"","username":"","field":"","headers":{"chiave":"valore"},"data":{},"retry":0,"scope":null,"domain":null,"custom":null},"prodotto":"raccomandata_smart","creation_timestamp":1687169678,"update_timestamp":1687169682,"username":"gcloud-tests@openapi.it","confirmed":false,"state":"NEW","documento_validato":{"pdf":"https://test.ws.ufficiopostale.com/Up/pdf/raccomandata_smartu6pccgbnFNeRA69t7hvPDOKMa.pdf","jpg":"https://test.ws.ufficiopostale.com/Up/jpg/raccomandata_smartu6pccgbnFNeRA69t7hvPDOKMa.jpg","filename":"raccomandata_smartu6pccgbnFNeRA69t7hvPDOKMa.pdf","pagine":2,"size":49553,"pricing":{"totale":{"importo_totale":0.58},"dettaglio":[{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","importo_unitario_totale":0.28,"importo_unitario_netto":0.22,"importo_unitario_iva":0.06,"quantita":1},{"codice_servizio":"spedizione","descrizione_servizio":"Spedizione","importo_unitario_totale":0.3,"importo_unitario_netto":0.3,"importo_unitario_iva":0,"quantita":1}]},"id":"xxxxxxxe557d71a5b600ee13d"}}],"success":true,"message":"","error":null}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"Id Specificato non valido","error":54010,"data":null}}}}}},"patch":{"summary":"Confirm send Raccomandata Smart","tags":["Raccomandata Smart"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Confirm sending a mail that was created with \"autoconfirm = false\"","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"confirmed":{"type":"boolean"}}},"example":{"confirmed":true}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExempleResponseSmart"},"example":{"data":[{"mittente":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi","dug":"via","indirizzo":"romagna","civico":"12","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi"},"destinatari":{"nome":"Mario","email":"mario@openapi.com","cognome":"Rossi","dug":"via","indirizzo":"alighieri","civico":"15","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","intestazione_completa":"Mario Rossi","id":"xxxxxxxe557d71a5b600ee17d","state":"NEW"},"documento":["test prova"],"callback":{"method":"JSON","url":"https://your-webhook.site/","user_id":"","username":"","field":"","headers":{"chiave":"valore"},"data":{},"retry":0,"scope":null,"domain":null,"custom":null},"opzioni":{"fronteretro":false,"colori":true,"autoconfirm":true,"timestamp_invio":1687169681},"prodotto":"raccomandata_smart","creation_timestamp":1687169678,"update_timestamp":1687169682,"username":"gcloud-tests@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://test.ws.ufficiopostale.com/Up/pdf/raccomandata_smartyvSPArFg2S7ccrrK99YIuyItJ.pdf","jpg":"https://test.ws.ufficiopostale.com/Up/jpg/raccomandata_smartyvSPArFg2S7ccrrK99YIuyItJ.jpg","filename":"raccomandata_smartyvSPArFg2S7ccrrK99YIuyItJ.pdf","pagine":1,"size":6840,"pricing":{"totale":{"importo_totale":2.2},"dettaglio":[{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","importo_unitario_totale":0.29,"importo_unitario_netto":0.23,"importo_unitario_iva":0.06,"quantita":1},{"codice_servizio":"spedizione","descrizione_servizio":"spedizione","importo_unitario_totale":1.91,"importo_unitario_netto":1.91,"importo_unitario_iva":0,"quantita":1}]},"confirmed_timestamp":"1687169682,","id":"xxxxxxxe557d71a5b600ee13d"}}],"success":true,"message":"","error":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"examples":{"52050":{"value":{"success":false,"message":"Conferma non revocabile","error":52050,"data":null}},"52060":{"value":{"success":false,"message":"Raccomandata smart già confermata o non confermabile","error":52060,"data":null}}}}}},"421":{"description":"Misdirected Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"examples":{"52030":{"value":{"success":false,"message":"Raccomandata smart non specificata","error":52030,"data":null}},"52040":{"value":{"success":false,"message":"Raccomandata smart errata","error":52040,"data":null}}}}}}}}},"/raccomandate_smart/{id}/accettazione":{"get":{"tags":["Raccomandata Smart"],"description":"Download the \"accettazione\" receipt if requested at the time of submission . \n - Acceptance is the process that certifies the acknowledgment of a request by the system. During this phase, the data provided by the user is validated, and if correct, an acceptance receipt is generated. This receipt is a digital document that formally confirms the acceptance of the request and marks the starting point for subsequent processing.\n\n The acceptance receipt includes:\n \n - The date and time of acceptance.\n - Details about the requested service, the sender, and the recipient.","summary":"Download accettazione Raccomandata Smart","parameters":[{"name":"id","description":"ID of request","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/pdf":{"example":"pdf"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"data":[],"success":true,"message":"","error":null}}}}}}},"/raccomandate/":{"get":{"summary":"List your Raccomandate","tags":["Raccomandate"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"mittente":{"type":"object","properties":{"nome":{"type":"string"},"cognome":{"type":"string"},"email":{"type":"string"}}},"creation_timestamp":{"type":"number"},"update_timestamp":{"type":"number"},"confiermed":{"type":"boolean"},"id":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{}}},"examples":{"0":{"value":{"data":[{"mittente":{"nome":"Alberto","cognome":"Rossi","email":"john.doe@openapi.it"},"creation_timestamp":1608040424,"update_timestamp":1608040424,"confirmed":false,"state":"NEW","id":"5fd8bfeaa10b340e2e558db7"}],"message":"1 Risultati","success":true,"error":null}}}}}}}},"post":{"summary":"Create your request","tags":["Raccomandate"],"description":"Send a Raccomandata. You should provide information about the sender and the receiver(s) in the post body. Additionally, the \"autoconfirm\" parameter can be set to false to save the Raccomandata for a later confirmation with a PATCH request, while you do custom logic with the response. Check the NumeroRaccomandata field in the recipient object if you need the tracking number\n\n\n\nThis endpoint now supports sending international registered mail. Here are the key details:\n\n- **International Raccomandata Support**: You can now send registered mail to international destinations.\n- **Multiple Recipients**: Foreign Raccomandata are limited to one recipient only. recipients.\n- **Address Format**: For international registered mail, ensure you provide the complete address within the appropriate fields as shown in the example.\n- **Province Setting**: For international addresses, the 'provincia' (province) field should be left empty or set according to the destination country's format.\n- **Pricing Information**: To check the rates for international registered mail, you can use the [/pricing/ endpoint](https://console.openapi.com/it/apis/ufficiopostale/documentation#/Ufficio%20Postale/get_pricing_).\n- **Available Options**: All options specific to international registered mail are listed in the schema. Any additional options not listed will be ignored.\n- **List of Countries**: For a list of countries to which you can send international registered mail, please refer to the [/nazioni/ endpoint](https://console.openapi.com/it/apis/ufficiopostale/documentation#/Ufficio%20Postale/get_nazioni_). This endpoint provides both pricing information and the list of available countries for international services.\n\n\nPlease refer to the schema for the complete list of fields and options available for both domestic and international registered mail.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opzioni":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/raccomandata_options"},{"$ref":"#/components/schemas/ForeignRaccomandataOption"}]}},"mittente":{"$ref":"#/components/schemas/common_sender_object"},"destinatari":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/recipient_object_with_casl_postale"},{"$ref":"#/components/schemas/ForeignRecipient"}]}},"callback":{"$ref":"#/components/schemas/callback"},"documento":{"$ref":"#/components/schemas/documento"}}},"examples":{"raccomandata":{"value":{"mittente":{"titolo":"mr","nome":"Mario","cognome":"Rossi","dug":"Via","indirizzo":"Dante Alighieri","dettaglio_immobile":"scala B","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"Italia","email":"john.doe@openapi.it"},"destinatari":[{"nome":"Mario","cognome":"Rossi","co":"OPENAPI SRL","dug":"via","indirizzo":"Dante Alighieri","dettaglio_immobile":"interno A","civico":"6","comune":"Roma","cap":"00101","provincia":"RE","nazione":"Italia"},{"nome":"Mario","cognome":"Rossi","co":"OPENAPI SRL","dug":"piazza","indirizzo":"San Giovanni","civico":"6","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT"}],"documento":["Example document"],"opzioni":{"fronteretro":false,"colori":false,"ar":true,"autoconfirm":true}}},"Foreign raccomandata":{"value":{"mittente":{"titolo":"mr","nome":"Mario","cognome":"Rossi","dug":"Via","indirizzo":"Dante Alighieri","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"IT","email":"john.doe@openapi.it"},"destinatari":[{"nome":"Mario","cognome":"Rossi","indirizzo":"78 **** Avenue","civico":"6","comune":"WYCOMBE","cap":"HP136HN","provincia":"EE","nazione":"GB","email":"john.doe@openapi.it"}],"documento":["Example document"],"opzioni":{"colori":true,"autoconfirm":true}}}}}}},"callbacks":{"callback":{"{$request.body#/opzioni/callback_url}":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCallback"}}}},"responses":{"200":{"description":"OK"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostalServiceResponse"},"examples":{"0":{"value":{"data":[{"mittente":{"titolo":"mr","nome":"Mario","cognome":"Rossi","dug":"Via","indirizzo":"Dante Alighieri","dettaglio_immobile":"scala B","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"IT","email":"john.doe@openapi.it"},"destinatari":[{"nome":"Mario","cognome":"Rossi","co":"OPENAPI SRL","dug":"via","indirizzo":"Dante Alighieri","dettaglio_immobile":"interno A","civico":"6","comune":"Roma","cap":"00101","provincia":"RE","nazione":"IT","id":"6103f711dd2507415c5db6ce","state":"NEW"},{"nome":"Mario","cognome":"Rossi","co":"OPENAPI SRL","dug":"piazza","indirizzo":"San Giovanni","civico":"6","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","id":"6103f711dd2507415c5db6cf","state":"NEW"}],"documento":["Example document"],"opzioni":{"fronteretro":false,"colori":false,"ar":{"titolo":"mr","nome":"Mario","cognome":"Rossi","dug":"Via","indirizzo":"Dante Alighieri","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"IT","email":"john.doe@openapi.it"},"autoconfirm":true,"timestamp_invio":1627649810},"prodotto":"raccomandata","creation_timestamp":1627649809,"update_timestamp":1627649810,"username":"john.doe@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://ws.ufficiopostale.com/Up/pdf/f7294e76871965ea206d560d77ff079e.pdf","jpg":"https://ws.ufficiopostale.com/Up/jpg/f7294e76871965ea206d560d77ff079e.jpg","pagine":1,"size":9350},"pricing":{"dettaglio":[{"codice_servizio":"RicevutaRitorno","descrizione_servizio":"Ricevuta di Ritorno","percentuale_iva":0,"quantita":2,"importo_unitario_totale":0.8,"importo_unitario_netto":0.8,"importo_unitario_iva":0},{"codice_servizio":"pagine","descrizione_servizio":"Tariffa Postale pagine","percentuale_iva":0,"quantita":2,"importo_unitario_totale":3.4,"importo_unitario_netto":3.4,"importo_unitario_iva":0},{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","percentuale_iva":0,"quantita":2,"importo_unitario_totale":0.1,"importo_unitario_netto":0.1,"importo_unitario_iva":0},{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","percentuale_iva":0,"quantita":2,"importo_unitario_totale":0,"importo_unitario_netto":0,"importo_unitario_iva":0}],"totale":{"importo_totale_netto":8.6,"importo_totale_iva":0,"importo_totale":8.6}},"lock":false,"confirmed_timestamp":1627649810,"id":"6103f712dd2507415c5db6d0"}],"success":true,"message":"","error":null}}}}}},"421":{"description":"Misdirected Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"example":{"success":false,"message":"Impossibile Modificare oggetto","error":52020,"data":null}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"examples":{"0":{"value":{"success":false,"message":"Dati obbligatori 'ragione_sociale' o 'nome' e 'cognome'","error":11020,"data":{"wrong_fields":["mittente.nome","mittente.cognome","mittente.ragione_sociale"]}}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"trace":{"type":"string"},"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"},"execution_time":{"type":"number"}}},"example":{"success":false,"message":"Errore inizializzazione file temporaneo","error":13080,"data":null}}}}}}},"/atti_giudiziari/{id}/destinatari/{IdDestinatario}/archiviazione":{"get":{"tags":["Atti Giudiziari"],"description":"Download the archival document when it is ready. You can check the status [here](https://console.openapi.com/apis/ufficiopostale/documentation#scope=GET:ws.ufficiopostale.com/atti_giudiziari/{id}). The documents will be digitally signed by the responsible representative of Poste Italiane, timestamped, and stored in a dedicated document management system.\n\n**NB:** The client declares compliance with the provisions of **Law No. 53 of January 21, 1994**, particularly regarding the management and preservation of digitally archived documents. Specifically:\n\n- The client is responsible for downloading the digital archive of the document within **2 months** from its availability.\n- The client assumes full responsibility for retaining this copy, as it will not be stored in our archives beyond the specified timeframe.\n- Failure to download or properly retain the document will result in the loss of the archived version, and no recovery will be possible from our systems.\n\n \n","summary":"Download archiviazione Atti Giudiziari","parameters":[{"name":"id","description":"ID of request","in":"path","required":true,"schema":{"type":"string"}},{"name":"IdDestinatario","description":"You can check the destinatari.id [here](https://console.openapi.com/it/apis/ufficiopostale/documentation#/Atti Giudiziari/get_raccomandate__id_).","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/pdf":{"example":"pdf"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"path non valido ES: {id}/destinatari/{idDestinatario}/archiviazione","error":2013,"data":null}}}}}}},"/atti_giudiziari/{id}/destinatari/{IdDestinatario}/ardigitale":{"get":{"tags":["Atti Giudiziari"],"summary":"Download Digital Return Receipt (AR Digitale)","description":"Downloads the Return Receipt (Avviso di Ricevimento - AR) in digital format for a specific recipient of a Judicial Act (Atto Giudiziario).\n\nThe Digital Return Receipt (Avviso di Ricevimento Digitale - AR Digitale) is a legally valid electronic document that certifies the notification of the act. It is produced only if the digital return receipt option was enabled during submission. The returned document is digitally signed and timestamped.\n","parameters":[{"name":"id","in":"path","required":true,"description":"ID of the Judicial Act request (Atto Giudiziario).","schema":{"type":"string"}},{"name":"IdDestinatario","in":"path","required":true,"description":"ID of the recipient for whom the Digital Return Receipt (AR Digitale) is requested. It can be found in the `destinatari` object of the `GET /atti_giudiziari/{id}` response.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK. The PDF file of the Digital Return Receipt.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not Found. The Digital Return Receipt (AR Digitale) is not available or the resource was not found.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","nullable":true},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"Digital Return Receipt not found or not yet available.","error":2017,"data":null}}}}}}},"/atti_giudiziari/{id}/accettazione":{"get":{"tags":["Atti Giudiziari"],"description":"Download the \"accettazione\" receipt if requested at the time of submission . \n - Acceptance is the process that certifies the acknowledgment of a request by the system. During this phase, the data provided by the user is validated, and if correct, an acceptance receipt is generated. This receipt is a digital document that formally confirms the acceptance of the request and marks the starting point for subsequent processing.\n\n The acceptance receipt includes:\n \n - The date and time of acceptance.\n - Details about the requested service, the sender, and the recipient.\n - A digital signature and timestamp, ensuring its legal validity.\n \n Acceptance is a fundamental step to guarantee traceability, transparency, and legal compliance for the services provided.\n","summary":"Download accettazione Atti Giudiziari","parameters":[{"name":"id","description":"ID of request","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/pdf":{"example":"pdf"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"data":[],"success":true,"message":"","error":null}}}}}}},"/atti_giudiziari/{id}":{"get":{"tags":["Atti Giudiziari"],"description":"Check the <code>NumeroRaccomandata</code> field in the recipient object if you need the tracking number","summary":"Get information about a Atto Giudiziaro","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"If the option has been set, it returns a specifc schema with state equal to the one requested","schema":{"type":"string","example":"NEW"}},{"name":"callback","in":"query","required":false,"description":"Simulates the progress of the shipment status: <b>every time that this endpoint is called, your request progresses the the next shipping status</b>.<br>If specified in the request, you will receive callback updates.<br>Please note that this option is avaialble <b>ONLY for the sandbox environment</b>","schema":{"type":"string","example":"<empty string>"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"stati":{"$ref":"#/components/schemas/ExampleState"},"mittente":{"type":"object","properties":{"ragione_sociale":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"email":{"type":"string"},"nazione":{"type":"string"}}},"destinatari":{"type":"array","items":{"type":"object","properties":{"nome":{"type":"string"},"cognome":{"type":"string"},"ragione_sociale":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"},"IdRicevuta":{"type":"string"},"NumeroRaccomandata":{"type":"string"},"tracking":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"integer"},"descrizione":{"type":"string","description":"Possible values:\n- Consegnato\n- Non Consegnabile\n- In Giacenza\n- Inesitato\n- Inviato in Giacenza\n- Accettato\n- Macero per manomissione/merce sospetta\n- Mancata consegna per forza maggiore\n- Accettato CAD\n- Accettato CAN\n- Accettato Online\n- Spedizione Stampata\n"},"type":{"type":"string","description":"Possible codes:\n- 01: Consegnato\n- 03: Non Consegnabile\n- 04: In Giacenza\n- 05: Inesitato\n- 06: Inviato in Giacenza\n- 81: Accettato\n- 88: Macero per manomissione/merce sospetta\n- 91: Mancata consegna per forza maggiore\n- 93: Accettato CAD\n- 93: Accettato CAN\n- 100: Accettato Online\n- 110: Spedizione Stampata\n"},"definitivo":{"type":"boolean","description":"Indicates whether the state is final."}}}},"archiviazione":{"description":"The status of the file storage process. Possible values are 'WAITING' or 'DONE'. When the status is 'DONE', the archived file can be downloaded for free through the endpoint. To download, click [here](https://console.openapi.com/apis/ufficiopostale/documentation#/Raccomandate/get_atti_giudiziari__id__destinatari__IdDestinatario__archiviazione)","type":"string","enum":["WAITING","DONE"]}}}},"callback":{"$ref":"#/components/schemas/callback"},"documento":{"type":"array","items":{"type":"string"}},"opzioni":{"type":"object","properties":{"fronteretro":{"type":"boolean"},"colori":{"type":"boolean"},"ar":{"type":"boolean"},"ricevuta":{"type":"boolean"},"autoconfirm":{"type":"boolean"},"timestamp_invio":{"type":"integer"}}},"prodotto":{"type":"string"},"creation_timestamp":{"type":"integer"},"update_timestamp":{"type":"integer"},"username":{"type":"string"},"confirmed":{"type":"boolean"},"state":{"type":"string"},"documento_validato":{"type":"object","properties":{"pdf":{"type":"string"},"jpg":{"type":"string"},"filename":{"type":"string"},"pagine":{"type":"integer"},"size":{"type":"integer"}}},"pricing":{"type":"object","properties":{"dettaglio":{"type":"array","items":{"type":"object","properties":{"codice_servizio":{"type":"string"},"descrizione_servizio":{"type":"string"},"percentuale_iva":{"type":"number"},"quantita":{"type":"integer"},"importo_unitario_totale":{"type":"number"},"importo_unitario_netto":{"type":"number"},"importo_unitario_iva":{"type":"number"}}}},"totale":{"type":"object","properties":{"importo_totale_netto":{"type":"number"},"importo_totale_iva":{"type":"number"},"importo_totale":{"type":"number"}}}}},"confirmed_timestamp":{"type":"integer"},"id":{"type":"string"}}},"message":{"type":"string"},"success":{"type":"boolean"},"error":{}}},"example":{"data":{"mittente":{"nome":"Mario","cognome":"Bianchi","dug":"piazza","indirizzo":"italia","civico":"10","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","state":"SENT"},"destinatari":[{"nome":"Mario","cognome":"Rossi","dug":"piazza","indirizzo":"italia","civico":"10","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","id":"000000000000000000000000","state":"SENT","NumeroRaccomandata":"123412341234","archiviazione":"WAITING"}],"documento":["Test di invio"],"opzioni":{"fronteretro":false,"colori":true,"ar":{"nome":"Mario","cognome":"Bianchi","dug":"piazza","indirizzo":"italia","civico":"10","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","state":"SENT"},"ricevuta":false,"autoconfirm":false,"timestamp_invio":1662372837},"prodotto":"atto_giudiziaro","creation_timestamp":1662372836,"update_timestamp":1662372836,"username":"m.rossi@example.com","confirmed":false,"state":"NEW","documento_validato":{"pdf":"https://xxxxxxxxx.pdf","jpg":"https://xxxxxxxxx.jpg","filename":"example.pdf","pagine":1,"size":4513},"pricing":{"dettaglio":[{"codice_servizio":"RicevutaRitorno","descrizione_servizio":"Ricevuta Ritorno","percentuale_iva":0,"quantita":1,"importo_unitario_totale":0.8,"importo_unitario_netto":0.8,"importo_unitario_iva":0},{"codice_servizio":"StampaColori","descrizione_servizio":"Stampa Colori","percentuale_iva":22,"quantita":1,"importo_unitario_totale":0.976,"importo_unitario_netto":0.8,"importo_unitario_iva":0.176},{"codice_servizio":"RicevutaRitorno","descrizione_servizio":"Ricevuta di Ritorno","percentuale_iva":0,"quantita":1,"importo_unitario_totale":0.8,"importo_unitario_netto":0.8,"importo_unitario_iva":0},{"codice_servizio":"pagine","descrizione_servizio":"Tariffa Postale pagine","percentuale_iva":0,"quantita":1,"importo_unitario_totale":3.4,"importo_unitario_netto":3.4,"importo_unitario_iva":0},{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","percentuale_iva":20,"quantita":1,"importo_unitario_totale":0.12000000000000001,"importo_unitario_netto":0.1,"importo_unitario_iva":0.02},{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","percentuale_iva":22,"quantita":1,"importo_unitario_totale":1.2,"importo_unitario_netto":1,"importo_unitario_iva":0.2}],"totale":{"importo_totale_netto":6.1,"importo_totale_iva":0.396,"importo_totale":6.4959999999999996}},"id":"4242424242424242424242"},"message":"","success":true,"error":null}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"Id Specificato non valido","error":54010,"data":null}}}}}},"patch":{"summary":"Confirm send Atti Giudiziari","tags":["Atti Giudiziari"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Confirm sending a atto_giudiziaro that was created with \"autoconfirm = false\"","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"confirmed":{"type":"boolean"}}},"examples":{"0":{"value":{"confirmed":true}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExampleResponseRaccomandate"},"example":{"data":{"mittente":{"ragione_sociale":"Mario Rossi Srl","dug":"Viale","indirizzo":"dei Giardini","civico":"82","comune":"san dona' di piave","cap":"30027","provincia":"VE","nazione":"IT","email":"test@test.com"},"destinatari":[{"ragione_sociale":"prova spa","dug":"viale","indirizzo":"rossi mario","civico":"82","comune":"san dona' di piave","cap":"30027","provincia":"VE","nazione":"IT","id":"649998d25b295d43ac0f1e78","state":"NEW"}],"documento":["tmpfiles.org/dl/980693/br223_compressed.pdf"],"opzioni":{"fronteretro":true,"colori":true,"ar":true,"ricevuta":false,"autoconfirm":false,"timestamp_invio":1687787732},"prodotto":"atto_giudiziaro","creation_timestamp":1687787729,"update_timestamp":1687787742,"username":"gcloud-tests@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://test.ws.ufficiopostale.com/Up/pdf/atto_giudiziaroUBLwd2TfrzVnSTMymTi5SnmAo.pdf","jpg":"https://test.ws.ufficiopostale.com/Up/jpg/atto_giudiziaroUBLwd2TfrzVnSTMymTi5SnmAo.jpg","filename":"atto_giudiziaroUBLwd2TfrzVnSTMymTi5SnmAo.pdf","pagine":1,"size":6308},"callback":{"method":"JSON","url":"https://your-webhook.site/","user_id":"","username":"","field":"","headers":{"chiave":"valore"},"data":{},"retry":0,"scope":null,"domain":null,"custom":null},"pricing":{"dettaglio":[{"codice_servizio":"RicevutaRitorno","descrizione_servizio":"Ricevuta Ritorno","percentuale_iva":0,"quantita":1,"importo_unitario_totale":0.8,"importo_unitario_netto":0.8,"importo_unitario_iva":0},{"codice_servizio":"FronteRetro","descrizione_servizio":"Fronte Retro","percentuale_iva":0,"quantita":1,"importo_unitario_totale":0.05,"importo_unitario_netto":0.05,"importo_unitario_iva":0},{"codice_servizio":"StampaColori","descrizione_servizio":"Stampa Colori","percentuale_iva":0,"quantita":1,"importo_unitario_totale":0.8,"importo_unitario_netto":0.8,"importo_unitario_iva":0},{"codice_servizio":"pagine","descrizione_servizio":"Tariffa postale pagine","percentuale_iva":0,"quantita":1,"importo_unitario_netto":3.92,"importo_unitario_iva":0,"importo_unitario_totale":3.92},{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","percentuale_iva":0,"quantita":1,"importo_unitario_netto":0.32,"importo_unitario_iva":0,"importo_unitario_totale":0.32},{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","percentuale_iva":0,"quantita":1,"importo_unitario_netto":0.12,"importo_unitario_iva":0,"importo_unitario_totale":0.12}],"totale":{"importo_totale_netto":5.21,"importo_totale_iva":0,"importo_totale":5.21}},"confirmed_timestamp":1687787742,"id":"649998d45b295d43ac0f1e79"},"success":true,"message":"","error":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"examples":{"0":{"value":{"success":false,"message":"Atto giudiziario già confermato o non confermabile","error":2060,"data":null}}}}}},"421":{"description":"Misdirected Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"example":{"success":false,"message":"Impossibile Modificare oggetto","error":52020,"data":null}}}}}}},"/atti_giudiziari/":{"get":{"summary":"List your Atti Giudiziari","tags":["Atti Giudiziari"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"mittente":{"type":"object","properties":{"nome":{"type":"string"},"cognome":{"type":"string"},"email":{"type":"string"}}},"creation_timestamp":{"type":"number"},"update_timestamp":{"type":"number"},"confiermed":{"type":"boolean"},"id":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{}}},"examples":{"0":{"value":{"data":[{"mittente":{"nome":"Alberto","cognome":"Rossi","email":"john.doe@openapi.it"},"creation_timestamp":1608040424,"update_timestamp":1608040424,"confirmed":false,"state":"NEW","id":"5fd8bfeaa10b340e2e558db7"}],"message":"1 Risultati","success":true,"error":null}}}}}}}},"post":{"summary":"Create your request","tags":["Atti Giudiziari"],"description":"A \"Atto Giudiziario\" is a legal document used to formally notify a judicial action, such as summons, payment orders, or court rulings. Italian law requires these documents to be sent via a special registered mail service that ensures:\n\n - Delivery traceability.\n - Issuance of a return receipt (Avviso di Ricevimento, AR).\n - Legal validity of the delivery, as required by law.\n - Sending a Judicial Act through an API allows companies to automate and centrally manage the process of sending, confirming, and tracking, while maintaining compliance with regulations regarding judicial notifications.\n \n \n Send an \"Atto Giudiziario\" with the following requirements:\n\n - Delivery is limited to the national territory, with a maximum weight of 2 kg.\n - Shipments to foreign destinations, including Vatican City and San Marino, are not allowed.\n - Shipments cannot be directed to P.O. Boxes.\n - Delivery occurs within 5 business days, plus an additional 2 days for printing.\n - A single national rate applies to all shipments within the territory, regardless of logistical destination.\n - The recipient of the return receipt (23L) must have the same name as the sender.\n - The \"AR\" option is mandatory and can be set to true, or an object with the AR recipient's details can be provided.\n - IMPORTANT: The recipient’s name must match the sender of the \"Atto Giudiziario.\"\n - The \"autoconfirm\" parameter can be set to `false` to save the Raccomandata for later confirmation via a PATCH request, allowing for custom handling of the response.\n\n Check the NumeroRaccomandata field in the recipient object if you need the tracking number\n \n \n **NB:** The client declares compliance with the provisions of **Law No. 53 of January 21, 1994**, particularly regarding the management and preservation of digitally archived documents. Specifically:\n\n- The client is responsible for downloading the digital archive of the document within **2 months** from its availability.\n- The client assumes full responsibility for retaining this copy, as it will not be stored in our archives beyond the specified timeframe.\n- Failure to download or properly retain the document will result in the loss of the archived version, and no recovery will be possible from our systems.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opzioni":{"$ref":"#/components/schemas/atti_giudiziari_options"},"mittente":{"$ref":"#/components/schemas/atti_giudiziari_sender_object"},"destinatari":{"$ref":"#/components/schemas/atti_giudiziari_recipient_object"},"documento":{"$ref":"#/components/schemas/documento"},"callback":{"$ref":"#/components/schemas/callback"}}},"example":{"mittente":{"titolo":"mr","nome":"Mario","cognome":"Rossi","dug":"Via","indirizzo":"Dante Alighieri","dettaglio_immobile":"scala B","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"Italia","email":"john.doe@openapi.it"},"destinatari":[{"nome":"Mario","cognome":"Rossi","co":"OPENAPI SRL","dug":"via","indirizzo":"Dante Alighieri","dettaglio_immobile":"interno A","civico":"6","comune":"Roma","cap":"00101","provincia":"RE","nazione":"Italia"},{"nome":"Mario","cognome":"Rossi","co":"OPENAPI SRL","dug":"piazza","indirizzo":"San Giovanni","civico":"6","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT"}],"documento":["Example document"],"opzioni":{"fronteretro":false,"colori":false,"ar":true,"autoconfirm":true,"atti_giudiziari":{"centro_costo_cliente":"ABC123","note":"Consegnare entro 72h","notificante":{"tipologia":"UfficialeGiudiziario","valore":"prova"},"numero_cronologico":"2023001","oggetto":"Diffida art. 123","partner_tecnologico":"TechPartner Srl","tipo_lingua":"IT"}}}}}},"callbacks":{"callback":{"{$request.body#/opzioni/callback_url}":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCallback"}}}},"responses":{"200":{"description":"OK"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostalServiceResponse"},"examples":{"0":{"value":{"data":[{"mittente":{"titolo":"mr","nome":"Mario","cognome":"Rossi","dug":"Via","indirizzo":"Dante Alighieri","dettaglio_immobile":"scala B","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"IT","email":"john.doe@openapi.it"},"destinatari":[{"nome":"Mario","cognome":"Rossi","co":"OPENAPI SRL","dug":"via","indirizzo":"Dante Alighieri","dettaglio_immobile":"interno A","civico":"6","comune":"Roma","cap":"00101","provincia":"RE","nazione":"IT","id":"6103f711dd2507415c5db6ce","state":"NEW"},{"nome":"Mario","cognome":"Rossi","co":"OPENAPI SRL","dug":"piazza","indirizzo":"San Giovanni","civico":"6","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","id":"6103f711dd2507415c5db6cf","state":"NEW"}],"documento":["Example document"],"opzioni":{"fronteretro":false,"colori":false,"ar":{"titolo":"mr","nome":"Mario","cognome":"Rossi","dug":"Via","indirizzo":"Dante Alighieri","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"IT","email":"john.doe@openapi.it"},"autoconfirm":true,"timestamp_invio":1627649810},"prodotto":"atto_giudiziario","creation_timestamp":1627649809,"update_timestamp":1627649810,"username":"john.doe@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://ws.ufficiopostale.com/Up/pdf/f7294e76871965ea206d560d77ff079e.pdf","jpg":"https://ws.ufficiopostale.com/Up/jpg/f7294e76871965ea206d560d77ff079e.jpg","pagine":1,"size":9350},"pricing":{"dettaglio":[{"codice_servizio":"RicevutaRitorno","descrizione_servizio":"Ricevuta di Ritorno","percentuale_iva":0,"quantita":2,"importo_unitario_totale":0.8,"importo_unitario_netto":0.8,"importo_unitario_iva":0},{"codice_servizio":"pagine","descrizione_servizio":"Tariffa Postale pagine","percentuale_iva":0,"quantita":2,"importo_unitario_totale":3.4,"importo_unitario_netto":3.4,"importo_unitario_iva":0},{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","percentuale_iva":0,"quantita":2,"importo_unitario_totale":0.1,"importo_unitario_netto":0.1,"importo_unitario_iva":0},{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","percentuale_iva":0,"quantita":2,"importo_unitario_totale":0,"importo_unitario_netto":0,"importo_unitario_iva":0}],"totale":{"importo_totale_netto":8.6,"importo_totale_iva":0,"importo_totale":8.6}},"lock":false,"confirmed_timestamp":1627649810,"id":"6103f712dd2507415c5db6d0"}],"success":true,"message":"","error":null}}}}}},"421":{"description":"Misdirected Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"example":{"success":false,"message":"Impossibile Modificare oggetto","error":52020,"data":null}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"examples":{"0":{"value":{"success":false,"message":"Dati obbligatori 'ragione_sociale' o 'nome' e 'cognome'","error":11020,"data":{"wrong_fields":["mittente.nome","mittente.cognome","mittente.ragione_sociale"]}}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"trace":{"type":"string"},"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"},"execution_time":{"type":"number"}}},"example":{"success":false,"message":"Errore inizializzazione file temporaneo","error":13080,"data":null}}}}}}},"/ordinarie/":{"get":{"summary":"List your requests","tags":["Posta Ordinaria"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"mittente":{"type":"object","properties":{"nome":{"type":"string"},"cognome":{"type":"string"},"email":{"type":"string"}}},"creation_timestamp":{"type":"number"},"update_timestamp":{"type":"number"},"confiermed":{"type":"boolean"},"id":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{}}},"example":{"data":[{"mittente":{"nome":"Alberto","cognome":"Rossi","email":"john.doe@openapi.it"},"creation_timestamp":1608040424,"update_timestamp":1608040424,"confirmed":false,"state":"NEW","id":"5fd8bfeaa10b340e2e558db7"}],"message":"1 Risultati","success":true,"error":null}}}}}},"post":{"summary":"Create your request","tags":["Posta Ordinaria"],"description":"Send a standard mail. You should provide information about the sender and the receiver(s) in the post body. Additionally, the \"autoconfirm\" parameter can be set to false to save the mail for a later confirmation with a PATCH request, while you do custom logic with the response.\n\nThis endpoint now supports sending foreign Ordinaria. Here are the key details:\n\n- **Foreign Ordinaria Support**: You can now send Ordinaria to international destinations.\n- **Single Recipient**: Foreign Ordinaria are limited to one recipient only.\n- **Address Format**: For foreign Ordinaria, it's crucial to write the complete address within the 'indirizzo' (address) field as shown in the example.\n- **Province Setting**: The 'provincia' (province) field will be automatically set to 'EE' (estero/foreign) for foreign addresses.\n- **Pricing Information**: To check the rates for foreign Ordinaria, you can use the [/pricing/ endpoint](https://console.openapi.com/it/apis/ufficiopostale/documentation#/Ufficio%20Postale/get_pricing_).\n- **Available Options**: All options specific to foreign Ordinaria are listed in the schema. Any additional options not listed will be ignored.\n- **List of Countries**: For a list of countries to which you can send foreign Ordinaria, please refer to the [/nazioni/ endpoint](https://console.openapi.com/it/apis/ufficiopostale/documentation#/Ufficio%20Postale/get_nazioni_). \n\nPlease refer to the schema for the complete list of fields and options available for both domestic and foreign standard mail.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opzioni":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/posta_options"},{"$ref":"#/components/schemas/ForeignPostaOption"}]}},"mittente":{"allOf":[{"$ref":"#/components/schemas/common_sender_object"}]},"destinatari":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/recipient_object_with_casl_postale"},{"$ref":"#/components/schemas/ForeignRecipient"}]}},"callback":{"$ref":"#/components/schemas/callback"},"documento":{"$ref":"#/components/schemas/documento"}}},"examples":{"Ordinaria":{"value":{"mittente":{"titolo":"mr","nome":"Mario","cognome":"Rossi","dug":"Via","indirizzo":"Dante Alighieri","dettaglio_immobile":"scala B","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"Italia","email":"john.doe@openapi.it"},"destinatari":[{"nome":"Mario","cognome":"Rossi","co":"OPENAPI SRL","dug":"via","indirizzo":"Dante Alighieri","dettaglio_immobile":"interno A","civico":"6","comune":"Roma","cap":"00101","provincia":"RE","nazione":"Italia"},{"nome":"Mario","cognome":"Rossi","co":"OPENAPI SRL","dug":"piazza","indirizzo":"San Giovanni","civico":"6","comune":"roma","cap":"00100","provincia":"RM","nazione":"Italia"}],"documento":["Example document"],"opzioni":{"fronteretro":false,"colori":false,"autoconfirm":true}}},"Foreign Ordinaria":{"value":{"mittente":{"titolo":"mr","nome":"Mario","cognome":"Rossi","dug":"Via","indirizzo":"Dante Alighieri","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"Italia","email":"john.doe@openapi.it"},"destinatari":[{"nome":"Mario","cognome":"Rossi","indirizzo":"37 STREET Avenue","comune":"LONDRA","cap":"00101","provincia":"EE","nazione":"GB","id":"6103f711dd2507415c5db6ce","state":"NEW"}],"documento":["Example document"],"opzioni":{"fronteretro":false,"colori":false,"autoconfirm":true}}}}}}},"callbacks":{"callback":{"{$request.body#/opzioni/callback_url}":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCallback"}}}},"responses":{"200":{"description":"OK"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostalServiceResponse"},"examples":{"posta ordinaria":{"value":{"data":[{"mittente":{"titolo":"mr","nome":"Mario","cognome":"Rossi","dug":"Via","indirizzo":"Dante Alighieri","dettaglio_immobile":"scala B","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"IT","email":"john.doe@openapi.it"},"destinatari":[{"nome":"Mario","cognome":"Rossi","co":"OPENAPI SRL","dug":"via","indirizzo":"Dante Alighieri","dettaglio_immobile":"interno A","civico":"6","comune":"Roma","cap":"00101","provincia":"RE","nazione":"IT","id":"6103f711dd2507415c5db6ce","state":"NEW"},{"nome":"Mario","cognome":"Rossi","co":"OPENAPI SRL","dug":"piazza","indirizzo":"San Giovanni","civico":"6","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","id":"6103f711dd2507415c5db6cf","state":"NEW"}],"documento":["Example document"],"opzioni":{"fronteretro":false,"colori":false,"ar":{"titolo":"mr","nome":"Mario","cognome":"Rossi","dug":"Via","indirizzo":"Dante Alighieri","dettaglio_immobile":"scala B","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"IT","email":"john.doe@openapi.it"},"autoconfirm":true,"timestamp_invio":1627649810},"prodotto":"ordinaria","creation_timestamp":1627649809,"update_timestamp":1627649810,"username":"john.doe@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://ws.ufficiopostale.com/Up/pdf/f7294e76871965ea206d560d77ff079e.pdf","jpg":"https://ws.ufficiopostale.com/Up/jpg/f7294e76871965ea206d560d77ff079e.jpg","pagine":1,"size":9350},"pricing":{"dettaglio":[{"codice_servizio":"pagine","descrizione_servizio":"Tariffa Postale pagine","percentuale_iva":0,"quantita":2,"importo_unitario_totale":3.4,"importo_unitario_netto":3.4,"importo_unitario_iva":0},{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","percentuale_iva":0,"quantita":2,"importo_unitario_totale":0.1,"importo_unitario_netto":0.1,"importo_unitario_iva":0},{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","percentuale_iva":0,"quantita":2,"importo_unitario_totale":0,"importo_unitario_netto":0,"importo_unitario_iva":0}],"totale":{"importo_totale_netto":8.6,"importo_totale_iva":0,"importo_totale":8.6}},"lock":false,"confirmed_timestamp":1627649810,"id":"6103f712dd2507415c5db6d0"}],"success":true,"message":"","error":null}},"Foreign ordinaria":{"value":{"data":[{"opzioni":{"colori":false,"autoconfirm":true,"fronteretro":false,"timestamp_invio":1724754216},"mittente":{"cap":"10024","comune":"moncalieri","dug":"via","indirizzo":"cavour","nazione":"IT","ragione_sociale":"Stefano Giacone","civico":"22","provincia":"TO","email":"stefano.giacone@gmail.com"},"destinatari":[{"nome":"Luca","cognome":"Scuriatti","indirizzo":"37 Rectory Avenue","comune":"High Wycombe","cap":"HP136HN","provincia":"ee","nazione":"GB","id":"66cda9255673a1b85f092f02","state":"NEW"}],"documento":["https://app.italianelite.eu/clicksend/EExtreme_recensione_con_omaggio.pdf"],"prodotto":"ordinaria_estero","creation_timestamp":1724754213,"update_timestamp":1724754216,"username":"gcloud-tests@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://alpha.ws.ufficiopostale.com/Up/pdf/ordinaria7QTR9pH7aj8tFbIdIa516jSxd.pdf","jpg":"https://alpha.ws.ufficiopostale.com/Up/jpg/ordinaria7QTR9pH7aj8tFbIdIa516jSxd.jpg","filename":"ordinaria7QTR9pH7aj8tFbIdIa516jSxd.pdf","pagine":1,"size":157746},"pricing":{"dettaglio":[{"codice_servizio":"pagine","descrizione_servizio":"Tariffa postale pagine","percentuale_iva":0,"quantita":1,"zona":1,"importo_unitario_netto":7.57,"importo_unitario_iva":0,"importo_unitario_totale":7.57},{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","zona":1,"quantita":1,"importo_unitario_netto":0.94,"percentuale_iva":0,"importo_unitario_iva":0,"importo_unitario_totale":0.94},{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","zona":1,"quantita":1,"importo_unitario_netto":0.12,"percentuale_iva":0,"importo_unitario_iva":0,"importo_unitario_totale":0.12}],"totale":{"importo_totale_netto":8.629999999999999,"importo_totale_iva":0,"importo_totale":8.629999999999999}},"confirmed_timestamp":1724754216,"id":"66cda9285673a1b85f092f03"}],"success":true,"message":"","error":null}}}}}},"421":{"description":"Misdirected Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"example":{"success":false,"message":"Impossibile Modificare oggetto","error":52020,"data":null}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"examples":{"0":{"value":{"success":false,"message":"Dati obbligatori 'ragione_sociale' o 'nome' e 'cognome'","error":11020,"data":{"wrong_fields":["mittente.nome","mittente.cognome","mittente.ragione_sociale"]}}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"trace":{"type":"string"},"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"},"execution_time":{"type":"number"}}},"example":{"success":false,"message":"Errore inizializzazione file temporaneo","error":13080,"data":null}}}}}}},"/ordinarie/{id}/destinatari/{IdDestinatario}/archiviazione":{"get":{"tags":["Posta Ordinaria"],"description":"Download the archival document when it is ready. You can check the status [here](https://console.openapi.com/apis/ufficiopostale/documentation#scope=GET:ws.ufficiopostale.com/ordinarie/{id}). The documents will be digitally signed by the responsible representative of Poste Italiane, timestamped, and stored in a dedicated document management system.\n","summary":"Download archiviazione Ordinaria","parameters":[{"name":"id","description":"ID of request","in":"path","required":true,"schema":{"type":"string"}},{"name":"IdDestinatario","description":"You can check the destinatari.id [here](https://console.openapi.com/it/apis/ufficiopostale/documentation#/Ordinarie/get_ordinarie__id_).","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/pdf":{"example":"pdf"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"path non valido ES: {id}/destinatari/{idDestinatario}/archiviazione","error":2013,"data":null}}}}}}},"/ordinarie/{id}":{"get":{"tags":["Posta Ordinaria"],"summary":"Get information about a single mail","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"If the option has been set, it returns a specifc schema with state equal to the one requested","schema":{"type":"string","example":"NEW"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"stati":{"$ref":"#/components/schemas/ExampleState"},"mittente":{"type":"object","properties":{"titolo":{"type":"string"},"nome":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"email":{"type":"string"}}},"destinatari":{"type":"array","items":{"type":"object","properties":{"titolo":{"type":"string"},"nome":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"},"archiviazione":{"description":"The status of the file storage process. Possible values are 'WAITING' or 'DONE'. When the status is 'DONE', the archived file can be downloaded for free through the endpoint. To download, click [here](https://console.openapi.com/apis/ufficiopostale/documentation#/Raccomandate/get_raccomandate__id__destinatari__IdDestinatario__archiviazione)","type":"string","enum":["WAITING","DONE"]}}}},"documento":{"type":"array","items":{"type":"string"}},"opzioni":{"type":"object","properties":{"fronteretro":{"type":"boolean"},"colori":{"type":"boolean"},"autoconfirm":{"type":"boolean"},"ricevuta":{"type":"boolean"},"timestamp_invio":{"type":"integer"}}},"prodotto":{"type":"string"},"creation_timestamp":{"type":"integer"},"update_timestamp":{"type":"integer"},"username":{"type":"string"},"confirmed":{"type":"boolean"},"state":{"type":"string"},"documento_validato":{"type":"object","properties":{"pdf":{"type":"string"},"jpg":{"type":"string"},"filename":{"type":"string"},"pagine":{"type":"integer"},"size":{"type":"integer"}}},"callback":{"$ref":"#/components/schemas/callback"},"pricing":{"type":"object","properties":{"dettaglio":{"type":"array","items":{"type":"object","properties":{"codice_servizio":{"type":"string"},"descrizione_servizio":{"type":"string"},"percentuale_iva":{"type":"number"},"quantita":{"type":"integer"},"importo_unitario_totale":{"type":"number"},"importo_unitario_netto":{"type":"number"},"importo_unitario_iva":{"type":"number"}}}},"totale":{"type":"object","properties":{"importo_totale_netto":{"type":"number"},"importo_totale_iva":{"type":"number"},"importo_totale":{"type":"number"}}}}},"id":{"type":"string"}}},"message":{"type":"string"},"success":{"type":"boolean"},"error":{}}},"example":{"data":{"mittente":{"titolo":"mr","nome":"John","cognome":"Doe","dug":"Piazza","indirizzo":"Dante Alighieri","civico":"1","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","email":"john.doe@openapi.it"},"destinatari":[{"titolo":"mr","nome":"John","cognome":"Doe","dug":"Piazza","indirizzo":"Dante Alighieri","civico":"1","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","email":"john.doe@openapi.it"}],"documento":["testo di prova"],"opzioni":{"fronteretro":false,"colori":false,"autoconfirm":true,"timestamp_invio":1635168169},"prodotto":"ordinaria","creation_timestamp":1635168169,"update_timestamp":1635168169,"username":"john.doe@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://ws.ufficiopostale.com/Up/pdf/test.pdf","jpg":"https://ws.ufficiopostale.com/Up/jpg/test.jpg","pagine":1,"size":5249},"pricing":{"dettaglio":[{"codice_servizio":"pagine","descrizione_servizio":"Tariffa Postale pagine","percentuale_iva":0,"quantita":1,"importo_unitario_totale":0.85,"importo_unitario_netto":0.85,"importo_unitario_iva":0},{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","percentuale_iva":22,"quantita":1,"importo_unitario_totale":0.20740000000000003,"importo_unitario_netto":0.17,"importo_unitario_iva":0.0374},{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","percentuale_iva":22,"quantita":1,"importo_unitario_totale":0.31720000000000004,"importo_unitario_netto":0.26,"importo_unitario_iva":0.0572}],"totale":{"importo_totale_netto":1.28,"importo_totale_iva":0.0946,"importo_totale":1.3746}},"confirmed_timestamp":1635168169,"id":"az034324hjksd829jwqlo12uo"},"message":"","success":true,"error":null}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"Id Specificato non valido","error":54010,"data":null}}}}}},"patch":{"summary":"Confirm send Posta Ordinaria","tags":["Posta Ordinaria"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Confirm sending a mail that was created with \"autoconfirm = false\"","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"confirmed":{"type":"boolean"}}},"examples":{"0":{"value":{"confirmed":true}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExampleResponseOrdinaria"},"example":{"data":[{"mittente":{"titolo":"mr","nome":"Lorenzo","cognome":"Paderi","dug":"Piazza","indirizzo":"ener bettica","civico":"1","comune":"roma","cap":"00121","provincia":"RM","nazione":"IT","email":"l.paderi@altravia.com"},"destinatari":[{"titolo":"mr","nome":"Lorenzo","cognome":"Paderi","dug":"Piazza","indirizzo":"ener bettica","civico":"11","comune":"roma","cap":"00121","provincia":"RM","nazione":"IT","email":"l.paderi@altravia.com","id":"64999de413df9dd7900e42c0","state":"NEW"}],"documento":["https://www.nasa.gov/pdf/65431main_ffs_factsheets_issoverview.pdf","https://www.nasa.gov/pdf/65431main_ffs_factsheets_issoverview.pdf"],"opzioni":{"fronteretro":false,"colori":true,"autoconfirm":false,"timestamp_invio":1687789031},"prodotto":"ordinaria","creation_timestamp":1687789028,"update_timestamp":1687789043,"username":"gcloud-tests@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://test.ws.ufficiopostale.com/Up/pdf/ordinariaZTq31xBfGVtjo4YxQJzSrvNRb.pdf","jpg":"https://test.ws.ufficiopostale.com/Up/jpg/ordinariaZTq31xBfGVtjo4YxQJzSrvNRb.jpg","filename":"ordinariaZTq31xBfGVtjo4YxQJzSrvNRb.pdf","pagine":4,"size":149658},"callback":{"method":"JSON","url":"https://your-webhook.site/","user_id":"","username":"","field":"","headers":{"chiave":"valore"},"data":{},"retry":0,"scope":null,"domain":null,"custom":null},"pricing":{"dettaglio":[{"codice_servizio":"StampaColori","descrizione_servizio":"Stampa Colori","percentuale_iva":22,"quantita":1,"importo_unitario_totale":0.8539999999999999,"importo_unitario_netto":0.7,"importo_unitario_iva":0.15399999999999997},{"codice_servizio":"pagine","descrizione_servizio":"Tariffa postale pagine","percentuale_iva":22,"quantita":1,"importo_unitario_netto":0.95,"importo_unitario_iva":0.209,"importo_unitario_totale":1.159},{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","percentuale_iva":22,"quantita":1,"importo_unitario_netto":0.4,"importo_unitario_iva":0.088,"importo_unitario_totale":0.488},{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","percentuale_iva":22,"quantita":1,"importo_unitario_netto":0.14,"importo_unitario_iva":0.030800000000000004,"importo_unitario_totale":0.1708}],"totale":{"importo_totale_netto":2.19,"importo_totale_iva":0.48179999999999995,"importo_totale":2.6717999999999997}},"confirmed_timestamp":1687789043,"id":"64999de713df9dd7900e42c1"}],"success":true,"message":"","error":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"examples":{"0":{"value":{"success":false,"message":"Raccomandata già confermata o non confermabile","error":2060,"data":null}}}}}},"421":{"description":"Misdirected Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"example":{"success":false,"message":"Lettera ordinaria non specificata","error":4030,"data":null}}}}}}},"/ordinarie/{id}/accettazione":{"get":{"tags":["Posta Ordinaria"],"description":"Download the \"accettazione\" receipt if requested at the time of submission . \n - Acceptance is the process that certifies the acknowledgment of a request by the system. During this phase, the data provided by the user is validated, and if correct, an acceptance receipt is generated. This receipt is a digital document that formally confirms the acceptance of the request and marks the starting point for subsequent processing.\n\n The acceptance receipt includes:\n \n - The date and time of acceptance.\n - Details about the requested service, the sender, and the recipient.","summary":"Download accettazione Posta Ordinaria","parameters":[{"name":"id","description":"ID of request","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/pdf":{"example":"pdf"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"data":[],"success":true,"message":"","error":null}}}}}}},"/prioritarie/":{"get":{"summary":"List your requests","tags":["Posta Prioritaria"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"mittente":{"type":"object","properties":{"nome":{"type":"string"},"cognome":{"type":"string"},"email":{"type":"string"}}},"creation_timestamp":{"type":"number"},"update_timestamp":{"type":"number"},"confiermed":{"type":"boolean"},"id":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{}}},"examples":{"0":{"value":{"data":[{"mittente":{"nome":"Alberto","cognome":"Rossi","email":"john.doe@openapi.it"},"creation_timestamp":1608040424,"update_timestamp":1608040424,"confirmed":false,"state":"NEW","id":"5fd8bfeaa10b340e2e558db7"}],"message":"1 Risultati","success":true,"error":null}}}}}}}},"post":{"summary":"Create your request","tags":["Posta Prioritaria"],"description":"Send a priority mail. You should provide information about the sender and the receiver(s) in the post body. Additionally, the \"autoconfirm\" parameter can be set to false to save the mail for a later confirmation with a PATCH request, while you do custom logic with the response. Check the IdRicevuta field in the recipient object if you need the tracking number\n\n\nThis endpoint now supports sending foreign Prioritaria. Here are the key details:\n \n - **Foreign Prioritaria Support**: You can now send Prioritaria to international destinations.\n - **Single Recipient**: Foreign Prioritaria are limited to one recipient only.\n - **Address Format**: For foreign Prioritaria, it's crucial to write the complete address within the 'indirizzo' (address) field as shown in the example.\n - **Province Setting**: The 'provincia' (province) field will be automatically set to 'EE' (estero/foreign) for foreign addresses.\n - **Pricing Information**: To check the rates for foreign Prioritaria, you can use the [/pricing/ endpoint](https://console.openapi.com/it/apis/ufficiopostale/documentation#/Ufficio%20Postale/get_pricing_).\n - **Available Options**: All options specific to foreign Prioritaria are listed in the schema. Any additional options not listed will be ignored.\n - **List of Countries**: For a list of countries to which you can send foreign Prioritaria, please refer to the [/nazioni/ endpoint](https://console.openapi.com/it/apis/ufficiopostale/documentation#/Ufficio%20Postale/get_nazioni_). \n \n Please refer to the schema for the complete list of fields and options available for both domestic and foreign priority mail.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opzioni":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/posta_options"},{"$ref":"#/components/schemas/ForeignPostaOption"}]}},"destinatari":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/recipient_object_with_casl_postale"},{"$ref":"#/components/schemas/ForeignRecipient"}]}},"mittente":{"allOf":[{"$ref":"#/components/schemas/common_sender_object"}]},"documento":{"$ref":"#/components/schemas/documento"},"callback":{"$ref":"#/components/schemas/callback"}}},"examples":{"prioritaria":{"value":{"mittente":{"titolo":"mr","nome":"Mario","cognome":"Rossi","dug":"Via","indirizzo":"Dante Alighieri","dettaglio_immobile":"scala B","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"Italia","email":"john.doe@openapi.it"},"destinatari":[{"nome":"Mario","cognome":"Rossi","co":"OPENAPI SRL","dug":"via","indirizzo":"Dante Alighieri","dettaglio_immobile":"interno A","civico":"6","comune":"Roma","cap":"00101","provincia":"RE","nazione":"Italia"},{"nome":"Mario","cognome":"Rossi","co":"OPENAPI SRL","dug":"piazza","indirizzo":"San Giovanni","civico":"6","comune":"roma","cap":"00100","provincia":"RM","nazione":"Italia"}],"documento":["Example document"],"opzioni":{"fronteretro":false,"colori":false,"autoconfirm":true}}},"Foreign prioritaria":{"value":{"mittente":{"titolo":"mr","nome":"Mario","cognome":"Rossi","dug":"Via","indirizzo":"Dante Alighieri","civico":"1","comune":"Roma","cap":"00100","provincia":"RM","nazione":"Italia","email":"john.doe@openapi.it"},"destinatari":[{"nome":"Mario","cognome":"Rossi","indirizzo":"37 Street Avenue","comune":"Londra","cap":"00101","provincia":"EE","nazione":"Italia"}],"documento":["Example document"],"opzioni":{"fronteretro":false,"colori":false,"autoconfirm":true}}}}}}},"callbacks":{"callback":{"{$request.body#/opzioni/callback_url}":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCallback"}}}},"responses":{"200":{"description":"OK"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostalServiceResponse"},"examples":{"0":{"value":{"data":[{"mittente":{"titolo":"mr","nome":"John","cognome":"Doe","dug":"Piazza","indirizzo":"Dante Alighieri","dettaglio_immobile":"scala B","civico":"1","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","email":"john.doe@openapi.it"},"destinatari":[{"titolo":"mr","nome":"John","cognome":"Doe","dug":"Piazza","indirizzo":"Dante Alighieri","dettaglio_immobile":"interno A","civico":"1","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","email":"john.doe@openapi.it"}],"documento":["Example document"],"opzioni":{"fronteretro":false,"colori":false,"autoconfirm":true,"timestamp_invio":1627649810},"prodotto":"prioritaria","creation_timestamp":1627649809,"update_timestamp":1627649810,"username":"john.doe@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://ws.ufficiopostale.com/Up/pdf/f7294e76871965ea206d560d77ff079e.pdf","jpg":"https://ws.ufficiopostale.com/Up/jpg/f7294e76871965ea206d560d77ff079e.jpg","pagine":1,"size":9350},"pricing":{"dettaglio":[{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","percentuale_iva":0,"quantita":2,"importo_unitario_totale":0,"importo_unitario_netto":0,"importo_unitario_iva":0}],"totale":{"importo_totale_netto":8.6,"importo_totale_iva":0,"importo_totale":8.6}},"lock":false,"confirmed_timestamp":1627649810,"id":"6103f712dd2507415c5db6d0"}],"success":true,"message":"","error":null}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"examples":{"0":{"value":{"success":false,"message":"Dati obbligatori 'ragione_sociale' o 'nome' e 'cognome'","error":11020,"data":{"wrong_fields":["mittente.nome","mittente.cognome","mittente.ragione_sociale"]}}}}}}}}}},"/prioritarie/{id}/destinatari/{IdDestinatario}/archiviazione":{"get":{"tags":["Posta Prioritaria"],"description":"Download the archival document when it is ready. You can check the status [here](https://console.openapi.com/apis/ufficiopostale/documentation#scope=GET:ws.ufficiopostale.com/prioritarie/{id}). The documents will be digitally signed by the responsible representative of Poste Italiane, timestamped, and stored in a dedicated document management system.\n","summary":"Download archiviazione Prioritarie","parameters":[{"name":"id","description":"ID of request","in":"path","required":true,"schema":{"type":"string"}},{"name":"IdDestinatario","description":"You can check the destinatari.id [here](https://console.openapi.com/it/apis/ufficiopostale/documentation#/Prioritaria/get_prioritarie__id_).","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/pdf":{"example":"pdf"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"path non valido ES: {id}/destinatari/{idDestinatario}/archiviazione","error":2013,"data":null}}}}}}},"/prioritarie/{id}":{"get":{"tags":["Posta Prioritaria"],"summary":"Get information about a single priority mail","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"If the option has been set, it returns a specifc schema with state equal to the one requested","schema":{"type":"string","example":"NEW"}},{"name":"callback","in":"query","required":false,"description":"Simulates the progress of the shipment status: <b>every time that this endpoint is called, your request progresses the the next shipping status</b>.<br>If specified in the request, you will receive callback updates.<br>Please note that this option is avaialble <b>ONLY for the sandbox environment</b>","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"stati":{"$ref":"#/components/schemas/ExampleState"},"mittente":{"type":"object","properties":{"titolo":{"type":"string"},"nome":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"email":{"type":"string"}}},"destinatari":{"type":"array","items":{"type":"object","properties":{"titolo":{"type":"string"},"nome":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"},"archiviazione":{"description":"The status of the file storage process. Possible values are 'WAITING' or 'DONE'. When the status is 'DONE', the archived file can be downloaded for free through the endpoint. To download, click [here](https://console.openapi.com/apis/ufficiopostale/documentation#/Posta%20Ordinaria/get_ordinarie__id__destinatari__IdDestinatario__archiviazione)","type":"string","enum":["WAITING","DONE"]},"tracking":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"integer"},"descrizione":{"type":"string","description":"Possible values:\n- Accettata online\n- La spedizione e' stata consegnata\n"},"type":{"type":"string","description":"Possible codes:\n- 00: Accettata online\n- C: La spedizione e' stata consegnata\n"},"definitivo":{"type":"boolean","description":"Indicates whether the state is final."}}}}}}},"documento":{"type":"array","items":{"type":"string"}},"callback":{"$ref":"#/components/schemas/callback"},"opzioni":{"type":"object","properties":{"fronteretro":{"type":"boolean"},"colori":{"type":"boolean"},"autoconfirm":{"type":"boolean"},"ricevuta":{"type":"boolean"},"timestamp_invio":{"type":"integer"}}},"prodotto":{"type":"string"},"creation_timestamp":{"type":"integer"},"update_timestamp":{"type":"integer"},"username":{"type":"string"},"confirmed":{"type":"boolean"},"state":{"type":"string"},"documento_validato":{"type":"object","properties":{"pdf":{"type":"string"},"jpg":{"type":"string"},"filename":{"type":"string"},"pagine":{"type":"integer"},"size":{"type":"integer"}}},"pricing":{"type":"object","properties":{"dettaglio":{"type":"array","items":{"type":"object","properties":{"codice_servizio":{"type":"string"},"descrizione_servizio":{"type":"string"},"percentuale_iva":{"type":"number"},"quantita":{"type":"integer"},"importo_unitario_totale":{"type":"number"},"importo_unitario_netto":{"type":"number"},"importo_unitario_iva":{"type":"number"}}}},"totale":{"type":"object","properties":{"importo_totale_netto":{"type":"number"},"importo_totale_iva":{"type":"number"},"importo_totale":{"type":"number"}}}}},"id":{"type":"string"}}},"message":{"type":"string"},"success":{"type":"boolean"},"error":{}}},"example":{"data":{"mittente":{"titolo":"mr","nome":"John","cognome":"Doe","dug":"Piazza","indirizzo":"Dante Alighieri","civico":"1","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","email":"john.doe@openapi.it"},"destinatari":[{"titolo":"mr","nome":"John","cognome":"Doe","dug":"Piazza","indirizzo":"Dante Alighieri","civico":"1","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","email":"john.doe@openapi.it"}],"documento":["testo di prova"],"opzioni":{"fronteretro":false,"colori":false,"autoconfirm":true,"timestamp_invio":1635168169},"prodotto":"prioritaria","creation_timestamp":1635168169,"update_timestamp":1635168169,"username":"john.doe@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://ws.ufficiopostale.com/Up/pdf/test.pdf","jpg":"https://ws.ufficiopostale.com/Up/jpg/test.jpg","pagine":1,"size":5249},"pricing":{"dettaglio":[{"codice_servizio":"pagine","descrizione_servizio":"Tariffa Postale pagine","percentuale_iva":0,"quantita":1,"importo_unitario_totale":0.85,"importo_unitario_netto":0.85,"importo_unitario_iva":0},{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","percentuale_iva":22,"quantita":1,"importo_unitario_totale":0.20740000000000003,"importo_unitario_netto":0.17,"importo_unitario_iva":0.0374},{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","percentuale_iva":22,"quantita":1,"importo_unitario_totale":0.31720000000000004,"importo_unitario_netto":0.26,"importo_unitario_iva":0.0572}],"totale":{"importo_totale_netto":1.28,"importo_totale_iva":0.0946,"importo_totale":1.3746}},"confirmed_timestamp":1635168169,"id":"az034324hjksd829jwqlo12uo"},"message":"","success":true,"error":null}}}}}},"patch":{"summary":"Confirm send Posta Prioritaria","tags":["Posta Prioritaria"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Confirm sending a mail that was created with \"autoconfirm = false\"","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"confirmed":{"type":"boolean"}}},"examples":{"0":{"value":{"confirmed":true}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExampleResponsePrioritarie"},"example":{"data":[{"mittente":{"titolo":"mr","nome":"Lorenzo","cognome":"Paderi","dug":"Piazza","indirizzo":"ener bettica","civico":"43","comune":"roma","cap":"00121","provincia":"RM","nazione":"IT","email":"l.paderi@altravia.com"},"destinatari":[{"titolo":"mr","nome":"Lorenzo","cognome":"Paderi","dug":"Piazza","indirizzo":"ener bettica","civico":"43","comune":"roma","cap":"00121","provincia":"RM","nazione":"IT","email":"l.paderi@altravia.com","id":"6499a05813df9dd7900e42c4","state":"NEW"}],"documento":["Lorem ipsum dixit nuovo test2"],"opzioni":{"fronteretro":false,"colori":false,"autoconfirm":false,"ricevuta":true,"timestamp_invio":1687789658},"prodotto":"prioritaria","creation_timestamp":1687789656,"update_timestamp":1687789674,"username":"gcloud-tests@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://test.ws.ufficiopostale.com/Up/pdf/prioritariaCukonJsUHfAJMObAd1WFFPGP7.pdf","jpg":"https://test.ws.ufficiopostale.com/Up/jpg/prioritariaCukonJsUHfAJMObAd1WFFPGP7.jpg","filename":"prioritariaCukonJsUHfAJMObAd1WFFPGP7.pdf","pagine":1,"size":5273},"callback":{"method":"JSON","url":"https://your-webhook.site/","user_id":"","username":"","field":"","headers":{"chiave":"valore"},"data":{},"retry":0,"scope":null,"domain":null,"custom":null},"pricing":{"dettaglio":[{"codice_servizio":"RicevutaDiInvio","descrizione_servizio":"Ricevuta Di Invio","percentuale_iva":0,"quantita":1,"importo_unitario_totale":1,"importo_unitario_netto":1,"importo_unitario_iva":0},{"codice_servizio":"pagine","descrizione_servizio":"Tariffa postale pagine","percentuale_iva":22,"quantita":1,"importo_unitario_netto":2.1,"importo_unitario_iva":0.462,"importo_unitario_totale":2.5620000000000003},{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","percentuale_iva":22,"quantita":1,"importo_unitario_netto":0.22,"importo_unitario_iva":0.048400000000000006,"importo_unitario_totale":0.2684},{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","percentuale_iva":22,"quantita":1,"importo_unitario_netto":0.23,"importo_unitario_iva":0.0506,"importo_unitario_totale":0.2806}],"totale":{"importo_totale_netto":3.5500000000000003,"importo_totale_iva":0.561,"importo_totale":4.111000000000001}},"confirmed_timestamp":1687789674,"id":"6499a05a13df9dd7900e42c5"}],"success":true,"message":"","error":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"examples":{"0":{"value":{"success":false,"message":"Lettera già confermata o non confermabile","error":2060,"data":null}}}}}}}}},"/prioritarie/{id}/accettazione":{"get":{"tags":["Posta Prioritaria"],"description":"Download the \"accettazione\" receipt if requested at the time of submission . \n - Acceptance is the process that certifies the acknowledgment of a request by the system. During this phase, the data provided by the user is validated, and if correct, an acceptance receipt is generated. This receipt is a digital document that formally confirms the acceptance of the request and marks the starting point for subsequent processing.\n\n The acceptance receipt includes:\n \n - The date and time of acceptance.\n - Details about the requested service, the sender, and the recipient.","summary":"Download accettazione Posta Prioritaria","parameters":[{"name":"id","description":"ID of request","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/pdf":{"example":"pdf"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"data":[],"success":true,"message":"","error":null}}}}}}},"/raccomandate/{id}/destinatari/{IdDestinatario}/archiviazione":{"get":{"tags":["Raccomandate"],"description":"Download the archival document when it is ready. You can check the status [here](https://console.openapi.com/apis/ufficiopostale/documentation#scope=GET:ws.ufficiopostale.com/raccomandate/{id}). The documents will be digitally signed by the responsible representative of Poste Italiane, timestamped, and stored in a dedicated document management system.\n","summary":"Download archiviazione Raccomandata","parameters":[{"name":"id","description":"ID of request","in":"path","required":true,"schema":{"type":"string"}},{"name":"IdDestinatario","description":"You can check the destinatari.id [here](https://console.openapi.com/it/apis/ufficiopostale/documentation#/Raccomandate/get_raccomandate__id_).","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/pdf":{"example":"pdf"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"path non valido ES: {id}/destinatari/{idDestinatario}/archiviazione","error":2013,"data":null}}}}}}},"/raccomandate/{id}/accettazione":{"get":{"tags":["Raccomandate"],"description":"Download the \"accettazione\" receipt if requested at the time of submission . \n - Acceptance is the process that certifies the acknowledgment of a request by the system. During this phase, the data provided by the user is validated, and if correct, an acceptance receipt is generated. This receipt is a digital document that formally confirms the acceptance of the request and marks the starting point for subsequent processing.\n\n The acceptance receipt includes:\n \n - The date and time of acceptance.\n - Details about the requested service, the sender, and the recipient.\n - A digital signature and timestamp, ensuring its legal validity.\n \n Acceptance is a fundamental step to guarantee traceability, transparency, and legal compliance for the services provided.\n","summary":"Download accettazione Raccomandate","parameters":[{"name":"id","description":"ID of request","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/pdf":{"example":"pdf"}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"data":[],"success":true,"message":"","error":null}}}}}}},"/raccomandate/{id}":{"get":{"tags":["Raccomandate"],"description":"Check the <code>NumeroRaccomandata</code> field in the recipient object if you need the tracking number","summary":"Get information about a Raccomandata","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"If the option has been set, it returns a specifc schema with state equal to the one requested","schema":{"type":"string","example":"NEW"}},{"name":"callback","in":"query","required":false,"description":"Simulates the progress of the shipment status: <b>every time that this endpoint is called, your request progresses the the next shipping status</b>.<br>If specified in the request, you will receive callback updates.<br>Please note that this option is avaialble <b>ONLY for the sandbox environment</b>","schema":{"type":"string","example":"<empty string>"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"stati":{"$ref":"#/components/schemas/ExampleState"},"mittente":{"type":"object","properties":{"ragione_sociale":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"email":{"type":"string"},"nazione":{"type":"string"}}},"destinatari":{"type":"array","items":{"type":"object","properties":{"nome":{"type":"string"},"cognome":{"type":"string"},"ragione_sociale":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"},"IdRicevuta":{"type":"string"},"NumeroRaccomandata":{"type":"string"},"tracking":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"integer"},"descrizione":{"type":"string","description":"Possible values:\n- Accettata online\n- Consegnato\n- Giacenza\n- In restituzione\n- Consegnato digitalmente\n- In lavorazione\n"},"type":{"type":"string","description":"Possible codes:\n- 00: Accettata online\n- 01: Consegnato\n- 02: Giacenza\n- 03: In restituzione\n- 04: Consegnato digitalmente\n- 99: In lavorazione\n"},"definitivo":{"type":"boolean","description":"Indicates whether the state is final."}}}},"archiviazione":{"description":"The status of the file storage process. Possible values are 'WAITING' or 'DONE'. When the status is 'DONE', the archived file can be downloaded for free through the endpoint. To download, click [here](https://console.openapi.com/apis/ufficiopostale/documentation#/Raccomandate/get_raccomandate__id__destinatari__IdDestinatario__archiviazione)","type":"string","enum":["WAITING","DONE"]}}}},"callback":{"$ref":"#/components/schemas/callback"},"documento":{"type":"array","items":{"type":"string"}},"opzioni":{"type":"object","properties":{"fronteretro":{"type":"boolean"},"colori":{"type":"boolean"},"ar":{"type":"boolean"},"ricevuta":{"type":"boolean"},"autoconfirm":{"type":"boolean"},"timestamp_invio":{"type":"integer"}}},"prodotto":{"type":"string"},"creation_timestamp":{"type":"integer"},"update_timestamp":{"type":"integer"},"username":{"type":"string"},"confirmed":{"type":"boolean"},"state":{"type":"string"},"documento_validato":{"type":"object","properties":{"pdf":{"type":"string"},"jpg":{"type":"string"},"filename":{"type":"string"},"pagine":{"type":"integer"},"size":{"type":"integer"}}},"pricing":{"type":"object","properties":{"dettaglio":{"type":"array","items":{"type":"object","properties":{"codice_servizio":{"type":"string"},"descrizione_servizio":{"type":"string"},"percentuale_iva":{"type":"number"},"quantita":{"type":"integer"},"importo_unitario_totale":{"type":"number"},"importo_unitario_netto":{"type":"number"},"importo_unitario_iva":{"type":"number"}}}},"totale":{"type":"object","properties":{"importo_totale_netto":{"type":"number"},"importo_totale_iva":{"type":"number"},"importo_totale":{"type":"number"}}}}},"confirmed_timestamp":{"type":"integer"},"id":{"type":"string"}}},"message":{"type":"string"},"success":{"type":"boolean"},"error":{}}},"example":{"data":{"mittente":{"nome":"Mario","cognome":"Bianchi","dug":"piazza","indirizzo":"italia","civico":"10","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","state":"SENT"},"destinatari":[{"nome":"Mario","cognome":"Rossi","dug":"piazza","indirizzo":"italia","civico":"10","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","id":"000000000000000000000000","state":"SENT","NumeroRaccomandata":"123412341234","archiviazione":"WAITING"}],"documento":["Test di invio"],"opzioni":{"fronteretro":false,"colori":true,"ar":{"nome":"Mario","cognome":"Bianchi","dug":"piazza","indirizzo":"italia","civico":"10","comune":"roma","cap":"00100","provincia":"RM","nazione":"IT","state":"SENT"},"ricevuta":false,"autoconfirm":false,"timestamp_invio":1662372837},"prodotto":"raccomandata","creation_timestamp":1662372836,"update_timestamp":1662372836,"username":"m.rossi@example.com","confirmed":false,"state":"NEW","documento_validato":{"pdf":"https://xxxxxxxxx.pdf","jpg":"https://xxxxxxxxx.jpg","filename":"example.pdf","pagine":1,"size":4513},"pricing":{"dettaglio":[{"codice_servizio":"StampaColori","descrizione_servizio":"Stampa Colori","percentuale_iva":22,"quantita":1,"importo_unitario_totale":0.976,"importo_unitario_netto":0.8,"importo_unitario_iva":0.176},{"codice_servizio":"RicevutaRitorno","descrizione_servizio":"Ricevuta di Ritorno","percentuale_iva":0,"quantita":1,"importo_unitario_totale":0.8,"importo_unitario_netto":0.8,"importo_unitario_iva":0},{"codice_servizio":"pagine","descrizione_servizio":"Tariffa Postale pagine","percentuale_iva":0,"quantita":1,"importo_unitario_totale":3.4,"importo_unitario_netto":3.4,"importo_unitario_iva":0},{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","percentuale_iva":20,"quantita":1,"importo_unitario_totale":0.12000000000000001,"importo_unitario_netto":0.1,"importo_unitario_iva":0.02},{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","percentuale_iva":22,"quantita":1,"importo_unitario_totale":1.2,"importo_unitario_netto":1,"importo_unitario_iva":0.2}],"totale":{"importo_totale_netto":6.1,"importo_totale_iva":0.396,"importo_totale":6.4959999999999996}},"id":"4242424242424242424242"},"message":"","success":true,"error":null}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"wrong_fields":{"type":"array","items":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"example":{"success":false,"message":"Id Specificato non valido","error":54010,"data":null}}}}}},"patch":{"summary":"Confirm send Posta Raccomandate","tags":["Raccomandate"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"description":"Confirm sending a Raccomandata that was created with \"autoconfirm = false\"","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"confirmed":{"type":"boolean"}}},"examples":{"0":{"value":{"confirmed":true}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExampleResponseRaccomandate"},"example":{"data":[{"mittente":{"ragione_sociale":"Mario Rossi Srl","dug":"Viale","indirizzo":"dei Giardini","civico":"82","comune":"san dona' di piave","cap":"30027","provincia":"VE","nazione":"IT","email":"test@test.com"},"destinatari":[{"ragione_sociale":"prova spa","dug":"viale","indirizzo":"rossi mario","civico":"82","comune":"san dona' di piave","cap":"30027","provincia":"VE","nazione":"IT","id":"649998d25b295d43ac0f1e78","state":"NEW"}],"documento":["tmpfiles.org/dl/980693/br223_compressed.pdf"],"opzioni":{"fronteretro":true,"colori":true,"ar":false,"ricevuta":false,"autoconfirm":false,"timestamp_invio":1687787732},"prodotto":"raccomandata","creation_timestamp":1687787729,"update_timestamp":1687787742,"username":"gcloud-tests@openapi.it","confirmed":true,"state":"CONFIRMED","documento_validato":{"pdf":"https://test.ws.ufficiopostale.com/Up/pdf/raccomandataUBLwd2TfrzVnSTMymTi5SnmAo.pdf","jpg":"https://test.ws.ufficiopostale.com/Up/jpg/raccomandataUBLwd2TfrzVnSTMymTi5SnmAo.jpg","filename":"raccomandataUBLwd2TfrzVnSTMymTi5SnmAo.pdf","pagine":1,"size":6308},"callback":{"method":"JSON","url":"https://your-webhook.site/","user_id":"","username":"","field":"","headers":{"chiave":"valore"},"data":{},"retry":0,"scope":null,"domain":null,"custom":null},"pricing":{"dettaglio":[{"codice_servizio":"FronteRetro","descrizione_servizio":"Fronte Retro","percentuale_iva":0,"quantita":1,"importo_unitario_totale":0.05,"importo_unitario_netto":0.05,"importo_unitario_iva":0},{"codice_servizio":"StampaColori","descrizione_servizio":"Stampa Colori","percentuale_iva":0,"quantita":1,"importo_unitario_totale":0.8,"importo_unitario_netto":0.8,"importo_unitario_iva":0},{"codice_servizio":"pagine","descrizione_servizio":"Tariffa postale pagine","percentuale_iva":0,"quantita":1,"importo_unitario_netto":3.92,"importo_unitario_iva":0,"importo_unitario_totale":3.92},{"codice_servizio":"STAMPA","descrizione_servizio":"Costo Stampa","percentuale_iva":0,"quantita":1,"importo_unitario_netto":0.32,"importo_unitario_iva":0,"importo_unitario_totale":0.32},{"codice_servizio":"IMBUST","descrizione_servizio":"Imbustamento","percentuale_iva":0,"quantita":1,"importo_unitario_netto":0.12,"importo_unitario_iva":0,"importo_unitario_totale":0.12}],"totale":{"importo_totale_netto":5.21,"importo_totale_iva":0,"importo_totale":5.21}},"confirmed_timestamp":1687787742,"id":"649998d45b295d43ac0f1e79"}],"success":true,"message":"","error":null}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"examples":{"0":{"value":{"success":false,"message":"Raccomandata già confermata o non confermabile","error":2060,"data":null}}}}}},"421":{"description":"Misdirected Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_response_object"},"example":{"success":false,"message":"Impossibile Modificare oggetto","error":52020,"data":null}}}}}}},"/tracking/{id}":{"get":{"tags":["Ufficio Postale"],"summary":"Track your product","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"descrizione":{"type":"string"},"definitivo":{"type":"boolean"},"type":{"type":"string"},"timestamp":{"type":"integer"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{}}},"examples":{"0":{"value":{"data":[{"timestamp":1604567446,"descrizione":"accettata online","type":"00","definitivo":false}],"message":"1 Risultati","success":true,"error":null}}}}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"scheme":"bearer","type":"http","bearerFormat":"","description":"","x-last-modified":1627583898094}},"schemas":{"ExampleState":{"type":"object","properties":{"NEW":{"type":"string"},"SENT":{"type":"string"},"CONFIRMED":{"type":"string"}}},"ExampleResponseOrdinaria":{"type":"object","properties":{"data":{"type":"object","properties":{"mittente":{"type":"object","properties":{"titolo":{"type":"string"},"nome":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"email":{"type":"string"}}},"destinatari":{"type":"array","items":{"type":"object","properties":{"titolo":{"type":"string"},"nome":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"}}}},"callback":{"$ref":"#/components/schemas/callback"},"documento":{"type":"array","items":{"type":"string"}},"opzioni":{"type":"object","properties":{"fronteretro":{"type":"boolean"},"colori":{"type":"boolean"},"autoconfirm":{"type":"boolean"},"timestamp_invio":{"type":"integer"}}},"prodotto":{"type":"string"},"creation_timestamp":{"type":"integer"},"update_timestamp":{"type":"integer"},"username":{"type":"string"},"confirmed":{"type":"boolean"},"state":{"type":"string"},"documento_validato":{"type":"object","properties":{"pdf":{"type":"string"},"jpg":{"type":"string"},"filename":{"type":"string"},"pagine":{"type":"integer"},"size":{"type":"integer"}}},"pricing":{"type":"object","properties":{"dettaglio":{"type":"array","items":{"type":"object","properties":{"codice_servizio":{"type":"string"},"descrizione_servizio":{"type":"string"},"percentuale_iva":{"type":"number"},"quantita":{"type":"integer"},"importo_unitario_totale":{"type":"number"},"importo_unitario_netto":{"type":"number"},"importo_unitario_iva":{"type":"number"}}}},"totale":{"type":"object","properties":{"importo_totale_netto":{"type":"number"},"importo_totale_iva":{"type":"number"},"importo_totale":{"type":"number"}}}}},"confirmed_timestamp":{"type":"integer"},"id":{"type":"string"}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"ExampleResponsePrioritarie":{"type":"object","properties":{"data":{"type":"object","properties":{"mittente":{"type":"object","properties":{"titolo":{"type":"string"},"nome":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"email":{"type":"string"}}},"destinatari":{"type":"array","items":{"type":"object","properties":{"titolo":{"type":"string"},"nome":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"}}}},"documento":{"type":"array","items":{"type":"string"}},"opzioni":{"type":"object","properties":{"fronteretro":{"type":"boolean"},"colori":{"type":"boolean"},"autoconfirm":{"type":"boolean"},"ricevuta":{"type":"boolean"},"timestamp_invio":{"type":"integer"}}},"prodotto":{"type":"string"},"creation_timestamp":{"type":"integer"},"update_timestamp":{"type":"integer"},"username":{"type":"string"},"confirmed":{"type":"boolean"},"state":{"type":"string"},"documento_validato":{"type":"object","properties":{"pdf":{"type":"string"},"jpg":{"type":"string"},"filename":{"type":"string"},"pagine":{"type":"integer"},"size":{"type":"integer"}}},"callback":{"$ref":"#/components/schemas/callback"},"pricing":{"type":"object","properties":{"dettaglio":{"type":"array","items":{"type":"object","properties":{"codice_servizio":{"type":"string"},"descrizione_servizio":{"type":"string"},"percentuale_iva":{"type":"number"},"quantita":{"type":"integer"},"importo_unitario_totale":{"type":"number"},"importo_unitario_netto":{"type":"number"},"importo_unitario_iva":{"type":"number"}}}},"totale":{"type":"object","properties":{"importo_totale_netto":{"type":"number"},"importo_totale_iva":{"type":"number"},"importo_totale":{"type":"number"}}}}},"confirmed_timestamp":{"type":"integer"},"id":{"type":"string"}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"ExampleResponseRaccomandate":{"type":"object","properties":{"data":{"type":"object","properties":{"mittente":{"type":"object","properties":{"ragione_sociale":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"email":{"type":"string"}}},"destinatari":{"type":"array","items":{"type":"object","properties":{"ragione_sociale":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"}}}},"documento":{"type":"array","items":{"type":"string"}},"opzioni":{"type":"object","properties":{"fronteretro":{"type":"boolean"},"colori":{"type":"boolean"},"ar":{"type":"boolean"},"ricevuta":{"type":"boolean"},"autoconfirm":{"type":"boolean"},"timestamp_invio":{"type":"integer"}}},"prodotto":{"type":"string"},"creation_timestamp":{"type":"integer"},"update_timestamp":{"type":"integer"},"username":{"type":"string"},"confirmed":{"type":"boolean"},"state":{"type":"string"},"documento_validato":{"type":"object","properties":{"pdf":{"type":"string"},"jpg":{"type":"string"},"filename":{"type":"string"},"pagine":{"type":"integer"},"size":{"type":"integer"}}},"callback":{"$ref":"#/components/schemas/callback"},"pricing":{"type":"object","properties":{"dettaglio":{"type":"array","items":{"type":"object","properties":{"codice_servizio":{"type":"string"},"descrizione_servizio":{"type":"string"},"percentuale_iva":{"type":"number"},"quantita":{"type":"integer"},"importo_unitario_totale":{"type":"number"},"importo_unitario_netto":{"type":"number"},"importo_unitario_iva":{"type":"number"}}}},"totale":{"type":"object","properties":{"importo_totale_netto":{"type":"number"},"importo_totale_iva":{"type":"number"},"importo_totale":{"type":"number"}}}}},"confirmed_timestamp":{"type":"integer"},"id":{"type":"string"}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"ExampleResponseTelegram":{"type":"object","properties":{"data":{"type":"object","properties":{"mittente":{"type":"object","properties":{"ragione_sociale":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"email":{"type":"string"}}},"destinatari":{"type":"array","items":{"type":"object","properties":{"ragione_sociale":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"}}}},"documento":{"type":"array","items":{"type":"string"}},"callback":{"$ref":"#/components/schemas/callback"},"opzioni":{"type":"object","properties":{"fronteretro":{"type":"boolean"},"colori":{"type":"boolean"},"ar":{"type":"boolean"},"ricevuta":{"type":"boolean"},"autoconfirm":{"type":"boolean"},"timestamp_invio":{"type":"integer"}}},"prodotto":{"type":"string"},"creation_timestamp":{"type":"integer"},"update_timestamp":{"type":"integer"},"username":{"type":"string"},"confirmed":{"type":"boolean"},"state":{"type":"string"},"documento_validato":{"type":"object","properties":{"pdf":{"type":"string"},"jpg":{"type":"string"},"filename":{"type":"string"},"pagine":{"type":"integer"},"size":{"type":"integer"}}},"pricing":{"type":"object","properties":{"dettaglio":{"type":"array","items":{"type":"object","properties":{"codice_servizio":{"type":"string"},"descrizione_servizio":{"type":"string"},"percentuale_iva":{"type":"number"},"quantita":{"type":"integer"},"importo_unitario_totale":{"type":"number"},"importo_unitario_netto":{"type":"number"},"importo_unitario_iva":{"type":"number"}}}},"totale":{"type":"object","properties":{"importo_totale_netto":{"type":"number"},"importo_totale_iva":{"type":"number"},"importo_totale":{"type":"number"}}}}},"confirmed_timestamp":{"type":"integer"},"id":{"type":"string"}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"ResponseCallback":{"type":"object","properties":{"mittente":{"type":"object","properties":{"nome":{"type":"string"},"email":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"integer"},"provincia":{"type":"string"},"nazione":{"type":"string"},"intestazione_completa":{"type":"string"}}},"destinatari":{"type":"object","properties":{"nome":{"type":"string"},"email":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"integer"},"provincia":{"type":"string"},"nazione":{"type":"string"},"intestazione_completa":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"}}},"documento":{"type":"array","items":{"type":"string"}},"opzioni":{"type":"object","properties":{"fronteretro":{"type":"boolean"},"colori":{"type":"boolean"},"autoconfirm":{"type":"boolean"},"timestamp_invio":{"type":"integer"}}},"prodotto":{"type":"string"},"creation_timestamp":{"type":"integer"},"update_timestamp":{"type":"integer"},"username":{"type":"string"},"confirmed":{"type":"boolean"},"state":{"type":"string"},"documento_validato":{"type":"object","properties":{"pdf":{"type":"string"},"jpg":{"type":"string"},"filename":{"type":"string"},"pagine":{"type":"integer"},"size":{"type":"integer"}}},"pricing":{"type":"object","properties":{"totale":{"type":"object","properties":{"importo_totale":{"type":"number"}}},"dettaglio":{"type":"array","items":{"type":"object","properties":{"codice_servizio":{"type":"string"},"descrizione_servizio":{"type":"string"},"importo_unitario_totale":{"type":"number"},"importo_unitario_netto":{"type":"number"},"importo_unitario_iva":{"type":"number"},"quantita":{"type":"integer"}}}}}},"confirmed_timestamp":{"type":"integer"},"id":{"type":"string"}}},"ExempleResponseSmart":{"type":"object","properties":{"data":{"type":"object","properties":{"mittente":{"type":"object","properties":{"nome":{"type":"string"},"email":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"integer"},"provincia":{"type":"string"},"nazione":{"type":"string"},"intestazione_completa":{"type":"string"}}},"destinatari":{"type":"object","properties":{"nome":{"type":"string"},"email":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"integer"},"provincia":{"type":"string"},"nazione":{"type":"string"},"intestazione_completa":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"}}},"documento":{"type":"array","items":{"type":"string"}},"callback":{"$ref":"#/components/schemas/callback"},"opzioni":{"type":"object","properties":{"fronteretro":{"type":"boolean"},"colori":{"type":"boolean"},"autoconfirm":{"type":"boolean"},"timestamp_invio":{"type":"integer"}}},"prodotto":{"type":"string"},"creation_timestamp":{"type":"integer"},"update_timestamp":{"type":"integer"},"username":{"type":"string"},"confirmed":{"type":"boolean"},"state":{"type":"string"},"documento_validato":{"type":"object","properties":{"pdf":{"type":"string"},"jpg":{"type":"string"},"filename":{"type":"string"},"pagine":{"type":"integer"},"size":{"type":"integer"}}},"pricing":{"type":"object","properties":{"totale":{"type":"object","properties":{"importo_totale":{"type":"number"}}},"dettaglio":{"type":"array","items":{"type":"object","properties":{"codice_servizio":{"type":"string"},"descrizione_servizio":{"type":"string"},"importo_unitario_totale":{"type":"number"},"importo_unitario_netto":{"type":"number"},"importo_unitario_iva":{"type":"number"},"quantita":{"type":"integer"}}}}}},"confirmed_timestamp":{"type":"integer"},"id":{"type":"string"}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"ExempleResponseMassiva1":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"mittente":{"type":"object","properties":{"nome":{"type":"string"},"email":{"type":"string"},"cognome":{"type":"string"}}},"creation_timestamp":{"type":"number"},"update_timestamp":{"type":"number"},"confirmed":{"type":"boolean"},"state":{"type":"string"},"id":{"type":"string"}}}},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"integer"}}},"ExempleResponseMassiva2":{"type":"object","properties":{"data":{"type":"object","properties":{"mittente":{"type":"object","properties":{"nome":{"type":"string"},"email":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"intestazione_completa":{"type":"string"}}},"destinatari":{"type":"object","properties":{"nome":{"type":"string"},"email":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"intestazione_completa":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"}}},"documento":{"type":"array","items":{"type":"string"}},"opzioni":{"type":"object","properties":{"fronteretro":{"type":"boolean","description":"Wheather the PDF should be printed on the front and back of the document. You might need to consider this option to overcome the document's size limitations, where applied."},"colori":{"description":"Color printing","type":"boolean"},"autoconfirm":{"description":"Automatically confirms the request, without the need of the additional PATCH request.","type":"boolean"},"ricevuta":{"description":"Generates a downloadable PDF as the received of the order.","type":"boolean"},"headers":{"type":"object","properties":{"key":{"type":"string"}},"description":"contains key:value strings that you want to arrive as headers","example":{"session_id":"9834r5fh589494"}},"timestamp_invio":{"type":"integer","description":"sending scheduling date in timestamp format"},"document_has_covers":{"description":"Specifies if the source PDF document already contains a pre-generated cover sheet for each recipient.","type":"object","properties":{"true":{"description":"The source PDF contains the cover sheets. The system will print the document as-is.","type":"boolean"},"false":{"description":"The source PDF contains only the mail content. The system will automatically generate a cover sheet for each document using the provided recipient data.","type":"boolean"}}}}},"prodotto":{"type":"string"},"creation_timestamp":{"type":"number"},"update_timestamp":{"type":"number"},"username":{"type":"string"},"confirmed":{"type":"boolean"},"state":{"$ref":"#/components/schemas/ExampleState"},"documento_validato":{"type":"object","properties":{"pdf":{"type":"string"},"jpg":{"type":"string"},"filename":{"type":"string"},"pagine":{"type":"number"},"size":{"type":"number"}}},"callback":{"$ref":"#/components/schemas/callback"},"pricing":{"type":"object","properties":{"totale":{"type":"object","properties":{"importo_totale":{"type":"number"}}},"dettaglio":{"type":"array","items":{"type":"object","properties":{"codice_servizio":{"type":"string"},"descrizione_servizio":{"type":"string"},"importo_unitario_totale":{"type":"number"},"importo_unitario_netto":{"type":"number"},"importo_unitario_iva":{"type":"number"},"quantita":{"type":"number"}}}}}},"id":{"type":"string"}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"ExempleResponseMassivaTop1":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"mittente":{"type":"object","properties":{"nome":{"type":"string"},"email":{"type":"string"},"cognome":{"type":"string"}}},"creation_timestamp":{"type":"number"},"update_timestamp":{"type":"number"},"confirmed":{"type":"boolean"},"state":{"type":"string"},"id":{"type":"string"}}}},"message":{"type":"string"},"success":{"type":"boolean"},"error":{"type":"integer"}}},"ExempleResponseMassivaTop2":{"type":"object","properties":{"data":{"type":"object","properties":{"mittente":{"type":"object","properties":{"nome":{"type":"string"},"email":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"intestazione_completa":{"type":"string"}}},"destinatari":{"type":"object","properties":{"nome":{"type":"string"},"email":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"intestazione_completa":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"}}},"documento":{"type":"array","items":{"type":"string"}},"opzioni":{"type":"object","properties":{"fronteretro":{"type":"boolean","description":"Wheather the PDF should be printed on the front and back of the document. You might need to consider this option to overcome the document's size limitations, where applied."},"colori":{"description":"Color printing","type":"boolean"},"autoconfirm":{"description":"Automatically confirms the request, without the need of the additional PATCH request.","type":"boolean"},"ricevuta":{"description":"Generates a downloadable PDF as the received of the order.","type":"boolean"},"headers":{"type":"object","properties":{"key":{"type":"string"}},"description":"contains key:value strings that you want to arrive as headers","example":{"session_id":"9834r5fh589494"}},"timestamp_invio":{"type":"integer","description":"sending scheduling date in timestamp format"}}},"prodotto":{"type":"string"},"creation_timestamp":{"type":"number"},"update_timestamp":{"type":"number"},"username":{"type":"string"},"confirmed":{"type":"boolean"},"state":{"$ref":"#/components/schemas/ExampleState"},"documento_validato":{"type":"object","properties":{"pdf":{"type":"string"},"jpg":{"type":"string"},"filename":{"type":"string"},"pagine":{"type":"number"},"size":{"type":"number"}}},"callback":{"$ref":"#/components/schemas/callback"},"pricing":{"type":"object","properties":{"totale":{"type":"object","properties":{"importo_totale":{"type":"number"}}},"dettaglio":{"type":"array","items":{"type":"object","properties":{"codice_servizio":{"type":"string"},"descrizione_servizio":{"type":"string"},"importo_unitario_totale":{"type":"number"},"importo_unitario_netto":{"type":"number"},"importo_unitario_iva":{"type":"number"},"quantita":{"type":"number"}}}}}},"id":{"type":"string"}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"}}},"raccomandata_options":{"type":"object","properties":{"fronteretro":{"type":"boolean","description":"Wheather the PDF should be printed on the front and back of the document. You might need to consider this option to overcome the document's size limitations, where applied."},"colori":{"description":"Color printing","type":"boolean"},"autoconfirm":{"description":"Automatically confirms the request, without the need of the additional PATCH request.","type":"boolean"},"ricevuta":{"description":"Generates a downloadable PDF as the received of the order.","type":"boolean"},"documento_validato_basicauth":{"$ref":"#/components/schemas/documento_validato_basicauth"},"headers":{"type":"object","properties":{"key":{"type":"string"}},"description":"contains key:value strings that you want to arrive as headers","example":{"session_id":"9834r5fh589494"}},"timestamp_invio":{"type":"integer","description":"sending scheduling date in timestamp format"},"ar":{"type":"boolean","description":"return receipt"},"cover":{"type":"string","description":"This is the cover ID generated through the specific endpoint [POST /covers](https://console.openapi.com/apis/ufficiopostale/documentation#scope=POST:ws.ufficiopostale.com/covers) and it is used to generate a personalized cover of the document."}}},"atti_giudiziari_options":{"type":"object","properties":{"fronteretro":{"type":"boolean","description":"Whether the PDF should be printed on the front and back of the document. You might need to consider this option to overcome the document's size limitations, where applied."},"colori":{"type":"boolean","description":"Color printing."},"autoconfirm":{"type":"boolean","description":"Automatically confirms the request, without the need for an additional PATCH request."},"ar":{"type":"boolean","description":"Requests the traditional paper return receipt (Avviso di Ricevimento)."},"ar_digitale":{"type":"boolean","description":"Requests the Return Receipt in digital format (AR Digitale). The document will be made available for download via the dedicated endpoint [here](https://console.openapi.com/apis/ufficiopostale/documentation#/Atti%20Giudiziari/get_atti_giudiziari__id__destinatari__IdDestinatario__ardigitale)."},"headers":{"type":"object","properties":{"key":{"type":"string"}},"description":"contains key:value strings that you want to arrive as headers","example":{"session_id":"9834r5fh589494"}},"timestamp_invio":{"type":"integer","description":"sending scheduling date in timestamp format"},"ricevuta":{"type":"boolean","description":"Generates a downloadable PDF as the receipt of the order."},"documento_validato_basicauth":{"$ref":"#/components/schemas/documento_validato_basicauth"},"atti_giudiziari":{"type":"object","description":"Optional additional fields specifically for judicial documents","properties":{"oggetto":{"type":"string","maxLength":200,"description":"Subject/description of the judicial document"},"note":{"type":"string","maxLength":200,"description":"Additional notes about the judicial document"},"centro_costo_cliente":{"type":"string","maxLength":20,"description":"Client's cost center code"},"notificante":{"type":"object","required":["tipologia","valore"],"description":"Notifier information (required if present)","properties":{"tipologia":{"type":"string","enum":["ParteIstante","Procuratore","UfficialeGiudiziario"],"description":"Type of notifier (Plaintiff, Attorney, Judicial Officer)"},"valore":{"type":"string","description":"Name/identifier of the notifier"}}},"tipo_lingua":{"type":"string","maxLength":60,"description":"Document language"},"numero_cronologico":{"type":"string","maxLength":60,"description":"Chronological document number"},"partner_tecnologico":{"type":"string","maxLength":20,"description":"Technical partner reference"}}},"cover":{"type":"string","description":"This is the cover ID generated through the specific endpoint [POST /covers](https://console.openapi.com/apis/ufficiopostale/documentation#scope=POST:ws.ufficiopostale.com/covers) and it is used to generate a personalized cover of the document."}}},"callback":{"type":"object","description":"This is our standardized OpenAPI callback system. It enables the configuration of parameters for receiving notifications about status updates of asynchronous requests to this endpoint.","properties":{"method":{"type":"string","description":"Specify the callback method. When set to 'POST', a standard HTTP POST request will be initiated with the Content-Type header set to application/x-www-form-urlencoded. The JSON data will be encoded into a key-value pair named data (customizable using the field parameter) within the request body. If the method is set to 'JSON', a direct HTTP POST request will be made with the Content-Type header set to application/json. The raw JSON data will be directly inserted into the request body without any encoding.","enum":["POST","JSON"],"default":"JSON"},"field":{"type":"string","description":"This parameter works in conjunction with the 'method' parameter set to 'POST'. When provided as a string, it determines the name of the parameter that will be sent in the POST request.","example":"data","default":"data"},"url":{"type":"string","format":"uri","description":"A valid URL capable of handling POST requests must be entered into this parameter. For endpoints requiring authentication, the 'headers' parameter can be used to specify 'basic auth' or 'bearer auth'. The maximum timeout is 30 seconds. If 'retry' is set, the system will retry up to 'retry' times until a 200 status code is received.","example":"https://www.mysite.com/myEndpoint"},"retry":{"type":"integer","description":"The maximum number of attempts is defined by the 'retry' parameter. If the maximum number of attempts is reached without a successful status code (e.g., 200 OK), the request is considered a final failure. A time interval is often introduced between attempts to avoid overloading the server. This interval may increase exponentially with each attempt to reduce the impact on an overloaded server. The 'retry' parameter is configured to retry the request only in case of specific status codes, typically those indicating temporary errors (e.g., 502, 503) or network issues.","example":3,"maximum":5,"minimum":5,"default":0},"headers":{"type":"object","properties":{"key":{"type":"string"}},"description":"A collection of HTTP headers to be sent with the request. Each header is defined as a key-value pair. Headers can be used for various purposes, including authentication, content negotiation, and custom metadata.","example":{"session_id":"9834r5fh589494"}},"custom":{"type":"object","description":"This object can be populated with any additional data you wish to include in the callback response. This data will be accessible within the 'custom' parameter of the callback function. You can use this to store and retrieve any relevant information that you need for your application.","example":{"my_custom_id":"123456789"}}},"required":["url"]},"ForeignRaccomandataOption":{"type":"object","properties":{"fronteretro":{"type":"boolean","description":"Wheather the PDF should be printed on the front and back of the document. You might need to consider this option to overcome the document's size limitations, where applied."},"colori":{"description":"Color printing","type":"boolean"},"autoconfirm":{"description":"Automatically confirms the request, without the need of the additional PATCH request.","type":"boolean"},"ricevuta":{"description":"Generates a downloadable PDF as the received of the order.","type":"boolean"},"documento_validato_basicauth":{"$ref":"#/components/schemas/documento_validato_basicauth"},"headers":{"type":"object","properties":{"key":{"type":"string"}},"description":"contains key:value strings that you want to arrive as headers","example":{"session_id":"9834r5fh589494"}},"timestamp_invio":{"type":"integer","description":"sending scheduling date in timestamp format"},"cover":{"type":"string","description":"This is the cover ID generated through the specific endpoint [POST /covers](https://console.openapi.com/apis/ufficiopostale/documentation#scope=POST:ws.ufficiopostale.com/covers) and it is used to generate a personalized cover of the document."}}},"raccomandata_s_options":{"type":"object","properties":{"fronteretro":{"type":"boolean","description":"Wheather the PDF should be printed on the front and back of the document. You might need to consider this option to overcome the document's size limitations, where applied."},"colori":{"description":"Color printing","type":"boolean"},"autoconfirm":{"description":"Automatically confirms the request, without the need of the additional PATCH request.","type":"boolean"},"ricevuta":{"description":"Generates a downloadable PDF as the received of the order.","type":"boolean"},"documento_validato_basicauth":{"$ref":"#/components/schemas/documento_validato_basicauth"},"headers":{"type":"object","properties":{"key":{"type":"string"}},"description":"contains key:value strings that you want to arrive as headers","example":{"session_id":"9834r5fh589494"}},"timestamp_invio":{"type":"integer","description":"sending scheduling date in timestamp format"},"ar":{"type":"boolean","description":"return receipt"},"document_has_covers":{"type":"boolean","description":"personalized documents for each recipient"}}},"posta_massiva_top_options":{"type":"object","properties":{"fronteretro":{"type":"boolean","description":"Wheather the PDF should be printed on the front and back of the document. You might need to consider this option to overcome the document's size limitations, where applied."},"colori":{"description":"Color printing","type":"boolean"},"autoconfirm":{"description":"Automatically confirms the request, without the need of the additional PATCH request.","type":"boolean"},"ricevuta":{"description":"Generates a downloadable PDF as the received of the order.","type":"boolean"},"documento_validato_basicauth":{"$ref":"#/components/schemas/documento_validato_basicauth"},"headers":{"type":"object","properties":{"key":{"type":"string"}},"description":"contains key:value strings that you want to arrive as headers","example":{"session_id":"9834r5fh589494"}},"timestamp_invio":{"type":"integer","description":"sending scheduling date in timestamp format"}}},"posta_p_options":{"type":"object","properties":{"fronteretro":{"type":"boolean","description":"Wheather the PDF should be printed on the front and back of the document. You might need to consider this option to overcome the document's size limitations, where applied."},"colori":{"description":"Color printing","type":"boolean"},"autoconfirm":{"description":"Automatically confirms the request, without the need of the additional PATCH request.","type":"boolean"},"ricevuta":{"description":"Generates a downloadable PDF as the received of the order.","type":"boolean"},"documento_validato_basicauth":{"$ref":"#/components/schemas/documento_validato_basicauth"},"headers":{"type":"object","properties":{"key":{"type":"string"}},"description":"contains key:value strings that you want to arrive as headers","example":{"session_id":"9834r5fh589494"}},"timestamp_invio":{"type":"integer","description":"sending scheduling date in timestamp format"},"document_has_covers":{"description":"Specifies if the source PDF document already contains a pre-generated cover sheet for each recipient.","type":"object","properties":{"true":{"description":"The source PDF contains the cover sheets. The system will print the document as-is.","type":"boolean"},"false":{"description":"The source PDF contains only the mail content. The system will automatically generate a cover sheet for each document using the provided recipient data.","type":"boolean"}}}}},"PostalServiceResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"opzioni":{"type":"object","properties":{"colori":{"type":"boolean"},"autoconfirm":{"type":"boolean"},"fronteretro":{"type":"boolean"},"timestamp_invio":{"type":"integer"}}},"mittente":{"type":"object","properties":{"cap":{"type":"string"},"comune":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"nazione":{"type":"string"},"ragione_sociale":{"type":"string"},"civico":{"type":"string"},"provincia":{"type":"string"},"email":{"type":"string"}}},"destinatari":{"type":"array","items":{"type":"object","properties":{"nome":{"type":"string"},"cognome":{"type":"string"},"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string"},"nazione":{"type":"string"},"id":{"type":"string"},"state":{"type":"string"},"email":{"type":"string"}}}},"documento":{"type":"array","items":{"type":"string"}},"prodotto":{"type":"string"},"creation_timestamp":{"type":"integer"},"update_timestamp":{"type":"integer"},"username":{"type":"string"},"confirmed":{"type":"boolean"},"state":{"type":"string"},"documento_validato":{"type":"object","properties":{"pdf":{"type":"string"},"jpg":{"type":"string"},"filename":{"type":"string"},"pagine":{"type":"integer"},"size":{"type":"integer"}}},"pricing":{"type":"object","properties":{"dettaglio":{"type":"array","items":{"type":"object","properties":{"codice_servizio":{"type":"string"},"descrizione_servizio":{"type":"string"},"percentuale_iva":{"type":"number"},"quantita":{"type":"integer"},"zona":{"type":"integer"},"importo_unitario_netto":{"type":"number"},"importo_unitario_iva":{"type":"number"},"importo_unitario_totale":{"type":"number"}}}},"totale":{"type":"object","properties":{"importo_totale_netto":{"type":"number"},"importo_totale_iva":{"type":"number"},"importo_totale":{"type":"number"}}}}},"confirmed_timestamp":{"type":"integer"},"id":{"type":"string"}}}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"object","nullable":true}}},"posta_options":{"type":"object","properties":{"fronteretro":{"type":"boolean","description":"Wheather the PDF should be printed on the front and back of the document. You might need to consider this option to overcome the document's size limitations, where applied."},"colori":{"description":"Color printing","type":"boolean"},"autoconfirm":{"description":"Automatically confirms the request, without the need of the additional PATCH request.","type":"boolean"},"ricevuta":{"description":"Generates a downloadable PDF as the received of the order.","type":"boolean"},"documento_validato_basicauth":{"$ref":"#/components/schemas/documento_validato_basicauth"},"headers":{"type":"object","properties":{"key":{"type":"string"}},"description":"contains key:value strings that you want to arrive as headers","example":{"session_id":"9834r5fh589494"}},"timestamp_invio":{"type":"integer","description":"sending scheduling date in timestamp format"},"cover":{"type":"string","description":"This is the cover ID generated through the specific endpoint [POST /covers](https://console.openapi.com/apis/ufficiopostale/documentation#scope=POST:ws.ufficiopostale.com/covers) and it is used to generate a personalized cover of the document."}}},"ForeignPostaOption":{"type":"object","properties":{"fronteretro":{"type":"boolean","description":"Wheather the PDF should be printed on the front and back of the document. You might need to consider this option to overcome the document's size limitations, where applied."},"colori":{"description":"Color printing","type":"boolean"},"autoconfirm":{"description":"Automatically confirms the request, without the need of the additional PATCH request.","type":"boolean"},"ricevuta":{"description":"Generates a downloadable PDF as the received of the order.","type":"boolean"},"documento_validato_basicauth":{"$ref":"#/components/schemas/documento_validato_basicauth"},"headers":{"type":"object","properties":{"key":{"type":"string"}},"description":"contains key:value strings that you want to arrive as headers","example":{"session_id":"9834r5fh589494"}},"timestamp_invio":{"type":"integer","description":"sending scheduling date in timestamp format"},"cover":{"type":"string","description":"This is the cover ID generated through the specific endpoint [POST /covers](https://console.openapi.com/apis/ufficiopostale/documentation#scope=POST:ws.ufficiopostale.com/covers) and it is used to generate a personalized cover of the document."}}},"telegramma_options":{"type":"object","properties":{"autoconfirm":{"description":"Automatically confirms the request, without the need of the additional PATCH request.","type":"boolean"},"ricevuta":{"description":"Generates a downloadable PDF as the received of the order.","type":"boolean"},"documento_validato_basicauth":{"$ref":"#/components/schemas/documento_validato_basicauth"},"headers":{"type":"object","properties":{"key":{"type":"string"}},"description":"contains key:value strings that you want to arrive as headers","example":{"session_id":"9834r5fh589494"}},"mittente":{"type":"boolean","default":false,"description":"Adds the sender's data to the telegram text"},"timestamp_invio":{"type":"integer","description":"sending scheduling date in timestamp format"},"ar_c":{"type":"boolean","description":"paper receipt"},"ar_e":{"type":"string","format":"email","description":"electronic receipt by email"}}},"documento":{"description":"The document can either be a string or an array of strings in plain text. <br> The strings can either be: <ul>\n <li><b>Plain text</b></li>\n <li><b>Formatted in HTML</b>, with style, header tags etc..</li>\n <li><b>An URL</b> pointing to either a webpage, a PDF or an image file (urls must start with http). The content is deduced from the \"Content-Type\" header</li>\n <li><b>A base64-encoded PDF file</b>. Encoded strings are deducted by the base64 content header <code>data:application/pdf;base64,</code>: basically, in order to mark a string as a base64-encoded content, you should prepend the aforementioned string to the output. <bR>The request will return an error if the decoding process fails on the server</li>\n</ul> The service analyses the \"documento\" (document) field, merges all the strings/document/images <b>in different pages</b>, compresses it slightly (if possible) and generates a single PDF file.\n\n The maximum size for a PDF document, after our compression, is 5 MB for every products execept Posta 4 PRO, Posta Massiva, Posta Massiva Top and Raccomandata Smart (these 3 products accept up to 15 MB maximum).\n\n**The maximum number of pages** is currently 50, or 100 is using the `fronteretro` option.","example":["Lorem ipsum","https://example.com/document.pdf","<strong>Text</strong>","data:application/pdf;base64,JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9Dcm... (base64 encoded)"],"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"documentoTelegramma":{"description":"The \"document\" field must be an array with a single element of type text. No other types of content such as HTML, PDF, URL, or base64 are allowed. The text within the array must not exceed 8100 Characters and 2000 words.","example":["Lorem ipsum"]},"documento_validato_basicauth":{"description":"If set, the generated documents (pdf and preview image) can ba accessed only with a GET request to the given URL <b>with the given credentials in Basic Auth</b>","type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}},"common_sender_object":{"type":"object","properties":{"titolo":{"type":"string","description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"nome":{"type":"string","maxLength":44,"description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"cognome":{"type":"string","maxLength":44,"description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"co":{"type":"string","maxLength":44,"description":"titolo + nome + cognome + co must not exceed 44 characters (including spaces)"},"ragione_sociale":{"$ref":"#/components/schemas/ragione_sociale_object"},"dug":{"type":"string","description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"indirizzo":{"type":"string","maxLength":43,"description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"civico":{"type":"string","maxLength":5,"description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"dettaglio_immobile":{"type":"string","maxLength":10,"description":"Additional or specific details about the property's location (e.g., Building 1, Entrance A)."},"comune":{"type":"string","maxLength":37,"description":"comune + cap + provincia must not exceed 44 characters (including spaces)"},"provincia":{"type":"string","maxLength":2,"description":"comune + cap + provincia must not exceed 44 characters (including spaces)"},"cap":{"type":"string","maxLength":5,"description":"comune + cap + provincia must not exceed 44 characters (including spaces)"},"nazione":{"type":"string"},"email":{"type":"string"}},"required":["nome","cognome","cap","comune","dug","indirizzo","nazione","civico","provincia","email"]},"common_recipient_object":{"type":"object","title":"Recipient","allOf":[{"$ref":"#/components/schemas/generic_recipient_object"},{"type":"object","properties":{"dug":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"dettaglio_immobile":{"type":"string","maxLength":10,"description":"Additional or specific details about the property's location (e.g., Building 1, Entrance A)."},"comune":{"type":"string"},"provincia":{"type":"string"},"cap":{"type":"string"},"nazione":{"type":"string"},"co":{"type":"string","description":"Presso (c/o)"}},"required":["cap","comune","dug","indirizzo","nazione","civico","provincia"]}]},"atti_giudiziari_sender_object":{"type":"object","properties":{"titolo":{"type":"string"},"nome":{"type":"string","maxLength":44},"cognome":{"type":"string","maxLength":44},"ragione_sociale":{"$ref":"#/components/schemas/ragione_sociale_object"},"dug":{"type":"string","description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"indirizzo":{"type":"string","maxLength":43,"description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"civico":{"type":"string","maxLength":5,"description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"dettaglio_immobile":{"type":"string","maxLength":43,"description":"Additional or specific details about the property's location (e.g., Building 1, Entrance A)."},"comune":{"type":"string","maxLength":37},"provincia":{"type":"string","maxLength":2},"cap":{"type":"string","maxLength":5},"nazione":{"type":"string","description":"ISO country code of the sender's country. Only IT allowed for this service."},"email":{"type":"string"}},"required":["nome","cognome","cap","comune","dug","indirizzo","nazione","civico","provincia","email"]},"atti_giudiziari_recipient_object":{"type":"object","properties":{"titolo":{"type":"string"},"nome":{"type":"string","maxLength":44},"cognome":{"type":"string","maxLength":44},"dug":{"type":"string","description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"indirizzo":{"type":"string","maxLength":43,"description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"civico":{"type":"string","maxLength":5,"description":"dug + indirizzo + civico must not exceed 43 characters (including spaces)"},"dettaglio_immobile":{"type":"string","maxLength":43,"description":"Additional or specific details about the property's location (e.g., Building 1, Entrance A)."},"comune":{"type":"string","maxLength":37},"provincia":{"type":"string","maxLength":2},"cap":{"type":"string","maxLength":5},"nazione":{"type":"string","description":"ISO country code of the recipient's country. Only IT allowed for this service."},"co":{"type":"string","description":"Care of (Presso)"}},"required":["nome","cognome","cap","comune","dug","indirizzo","nazione","civico","provincia"]},"telegramma_foreign_recipient_object":{"title":"foreign_recipient","description":"For foreign telegrams, only one recipient is allowed. It is crucial to write the complete address within the 'indirizzo' (address) field as shown in the example. The 'provincia' (province) field will be automatically set to 'EE' (estero/foreign).","type":"object","properties":{"titolo":{"type":"string","description":"First name of the recipient. titolo + nome + cognome must not exceed 41 characters (including spaces)"},"nome":{"type":"string","maxLength":41,"description":"First name of the recipient. titolo + nome + cognome must not exceed 41 characters (including spaces)"},"cognome":{"type":"string","maxLength":41,"description":"Last name of the recipient. titolo + nome + cognome must not exceed 41 characters (including spaces)"},"indirizzo":{"type":"string","maxLength":41,"description":"Street address of the recipient."},"comune":{"type":"string","maxLength":36,"description":"City or town of the recipient"},"cap":{"type":"string","description":"Postal code or ZIP code of the recipient"},"provincia":{"type":"string","description":"Is optional, you can use EE (estero/foreign)"},"nazione":{"type":"string","description":"ISO country code of the recipient's country"}},"required":["nome","cognome","indirizzo","comune","cap","nazione"]},"telegramma_foreign_options":{"type":"object","properties":{"mittente":{"type":"boolean","description":"If true, include sender's information in the telegram and Send a copy of the telegram to the sender"},"autoconfirm":{"type":"boolean","description":"Automatically confirms the request, without the need of the additional PATCH request."},"ricevuta":{"type":"boolean","description":"Generates a downloadable PDF as the received of the order."},"documento_validato_basicauth":{"$ref":"#/components/schemas/documento_validato_basicauth"},"headers":{"type":"object","properties":{"key":{"type":"string"}},"description":"contains key:value strings that you want to arrive as headers","example":{"session_id":"9834r5fh589494"}},"timestamp_invio":{"type":"integer","description":"sending scheduling date in timestamp format"}}},"PricingResponseSchema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PricingData"},"success":{"type":"boolean","description":"Indicates whether the request was successful"},"message":{"type":"string","description":"Additional information or status message"},"error":{"type":"object","nullable":true,"description":"Error details, if any. Null if the request was successful"}}},"PricingData":{"type":"object","properties":{"tipologia":{"type":"string","description":"The general category of the service (e.g., \"telegramma\", \"raccomandata\")"},"prodotto":{"type":"string","description":"The specific product code (e.g., \"telegramma_estero\", \"raccomandata_estero\")"},"descrizione":{"type":"string","description":"A brief description of the service"},"riferimento_prezzo":{"type":"string","description":"The reference unit for pricing (e.g., \"parole\" for telegrams, \"pagina\" for registered mail)"},"accetta_allegati":{"type":"integer","description":"Indicates if attachments are accepted (1 for yes, 0 for no)"},"attivo":{"type":"integer","description":"Indicates if the service is currently active (1 for active, 0 for inactive)"},"tariffe":{"type":"array","description":"List of tariffs applicable to this service","items":{"oneOf":[{"$ref":"#/components/schemas/TelegrammaEsteroTariffa"},{"$ref":"#/components/schemas/RaccomandataEsteroTariffa"}]}}}},"TelegrammaEsteroTariffa":{"type":"object","properties":{"iva_tariffa_postale":{"type":"number","description":"VAT rate for the postal tariff"},"iva_imbustamento":{"type":"number","description":"VAT rate for the enveloping process"},"iva_stampa_imbustamento":{"type":"number","description":"VAT rate for printing and enveloping"},"tipologia":{"type":"string","description":"Type of tariff (e.g., \"parole\" for words)"},"zona":{"type":"string","description":"Pricing zone (e.g., \"A\", \"B\", \"C\", etc.)"},"tariffa_postale":{"type":"number","description":"Base postal tariff per word"},"stampa":{"type":"number","description":"Cost for printing"},"imbustamento":{"type":"number","description":"Cost for enveloping"},"prezzo_fisso":{"type":"number","nullable":true,"description":"Fixed price component, if applicable (may be null for some zones)"},"iva_prezzo_fisso":{"type":"number","nullable":true,"description":"VAT rate for the fixed price component, if applicable"}}},"RaccomandataEsteroTariffa":{"type":"object","properties":{"iva_tariffa_postale":{"type":"number","description":"VAT rate for the postal tariff"},"iva_imbustamento":{"type":"number","description":"VAT rate for the enveloping process"},"iva_stampa_imbustamento":{"type":"number","description":"VAT rate for printing and enveloping"},"tipologia":{"type":"string","description":"Type of tariff (e.g., \"pagine\" for pages)"},"da":{"type":"integer","description":"Starting page number for this tariff range"},"a":{"type":"integer","description":"Ending page number for this tariff range"},"tariffa_postale":{"type":"number","description":"Postal tariff for this page range"},"zona":{"type":"integer","description":"Pricing zone (e.g., 1, 2, 3)"},"stampa":{"type":"number","description":"Cost for printing per page"},"imbustamento":{"type":"number","description":"Cost for enveloping"}}},"generic_recipient_object":{"type":"object","properties":{"titolo":{"type":"string","example":"Mr/Mrs"},"nome":{"type":"string"},"cognome":{"type":"string"},"ragione_sociale":{"$ref":"#/components/schemas/ragione_sociale_object"}},"required":["nome","cognome"]},"recipient_object_with_casl_postale":{"description":"It is mandatory to enter the full name(nome, cognome) or business name(ragione sociale).","type":"object","title":"Recipient or Casella postale","oneOf":[{"$ref":"#/components/schemas/common_recipient_object"},{"type":"object","title":"Casella postale","required":["casella_postale","ufficio_postale","comune","provincia","cap"],"allOf":[{"$ref":"#/components/schemas/generic_recipient_object"},{"type":"object","properties":{"casella_postale":{"type":"string","description":"The code of your 'Casella Postale': <a href=\"https://www.poste.it/prodotti/caselle-postali.html\">https://www.poste.it/prodotti/caselle-postali.html</a>"},"comune":{"type":"string"},"ufficio_postale":{"type":"string","description":"The Postal Office to send your mail to"},"provincia":{"type":"string","description":"The Postal Office to send your mail to"},"cap":{"type":"string","description":"The Postal Office to send your mail to"}}}]}]},"CountriesResponse":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CountryInfoFull"}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"object","nullable":true}}},"CountriesServiceResponse":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CountryInfoService"}},"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"object","nullable":true}}},"CountryInfoFull":{"type":"object","properties":{"nome":{"type":"string","description":"Country name in Italian"},"name":{"type":"string","description":"Country name in English"},"products":{"type":"object","properties":{"telegramma_estero":{"type":"boolean"},"raccomandata_estero":{"type":"boolean"},"ordinaria_estero":{"type":"boolean"},"prioritaria_estero":{"type":"boolean"}}}}},"CoverDetailResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the cover"},"header":{"type":"string","description":"Base64 encoded image or text of the cover header"},"mittente":{"type":"string","description":"Base64 encoded image or text of the sender's logo"},"dettaglioMittente":{"type":"string","description":"Base64 encoded image or text of the sender's details"},"body":{"type":"string","description":"Base64 encoded image or text of the cover body"},"footer":{"type":"string","description":"Base64 encoded image or text of the cover footer"},"dettaglioLettera":{"type":"string","description":"Base64 encoded image or text of the letter details"},"creation_timestamp":{"type":"integer","description":"Unix timestamp of cover creation"},"update_timestamp":{"type":"integer","description":"Unix timestamp of last cover update"},"status":{"type":"string","description":"Current status of the cover"},"callback":{"$ref":"#/components/schemas/callback"}}},"success":{"type":"boolean","description":"Indicates if the request was successful"},"message":{"type":"string","description":"Additional message regarding the request"},"error":{"type":"string","nullable":true,"description":"Error message if an error occurred, null otherwise"}}},"CoverRequest":{"type":"object","properties":{"callback":{"$ref":"#/components/schemas/callback"},"header":{"oneOf":[{"type":"string"},{"type":"string","format":"base64","description":"Text or Base64 encoded image of the cover header. Recommended size is 580 x 34 pixels.\n- The header of the document. It can contain information such as the company logo, company name, or other identifying details.\n\n [Example](https://storage.googleapis.com/docs-openapi-it-bucket/demo-header.png)\n"}]},"mittente":{"type":"string","format":"base64","description":"Text or Base64 encoded image of the sender's logo. Recommended size is 340 x 79 pixels.Image of the sender's logo. \n- It must be an image that includes all essential details of the sender, such as: - First and last name (or company name) - Complete address - Postal code - City and state/province - Any contacts (phone, email) - VAT number or Tax ID (if applicable) The image must be in a supported format (e.g., JPEG, PNG) and of appropriate dimensions for display in the document.\n\n [Example](https://storage.googleapis.com/docs-openapi-it-bucket/demo-mittente.png)\n"},"dettaglioMittente":{"oneOf":[{"type":"string"},{"type":"string","format":"base64","description":"Text or Base64 encoded image of the sender's details. Recommended size is 261 x 79 pixels.\n- Detailed information about the sender of the document. It can include name, address, contact information, and other relevant details.\n\n [Example](https://storage.googleapis.com/docs-openapi-it-bucket/demo-dettaglio-mittente.png)\n"}]},"body":{"oneOf":[{"type":"string"},{"type":"string","format":"base64","description":"Text or Base64 encoded image of the cover body. Recommended size is 600 x 493 pixels.\n- The main content of the document. This is where the main text of the communication or letter is inserted.\n\n [Example](https://storage.googleapis.com/docs-openapi-it-bucket/demo-body.png)\n"}]},"footer":{"oneOf":[{"type":"string"},{"type":"string","format":"base64","description":"Text or Base64 encoded image of the cover footer. Recommended size is 600 x 34 pixels.\n - The footer of the document. It can contain contact information, legal disclaimers, or other relevant details.\n \n [Example](https://storage.googleapis.com/docs-openapi-it-bucket/demo-footer.png)\n"}]},"dettaglioLettera":{"oneOf":[{"type":"string"},{"type":"string","format":"base64","description":"Text or Base64 encoded image of the letter details. Recommended size is 213 x 159 pixels. Applicable for Ordinary and Priority Mail, but not for Registered Mail.\n- A field to insert specific details of the letter, such as references, subject, or other information relevant to the context of the document.\n\n [Example](https://storage.googleapis.com/docs-openapi-it-bucket/demo-dettaglio-lettera.png)\n"}]}}},"CoverResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"header":{"type":"string","format":"base64","description":"Base64 encoded image of the cover header."},"mittente":{"type":"string","format":"base64","description":"Base64 encoded image of the sender's logo."},"dettaglioMittente":{"type":"string","format":"base64","description":"Base64 encoded image of the sender's details."},"body":{"type":"string","format":"base64","description":"Base64 encoded image of the cover body."},"footer":{"type":"string","format":"base64","description":"Base64 encoded image of the cover footer."},"dettaglioLettera":{"type":"string","format":"base64","description":"Base64 encoded image of the letter details."},"creation_timestamp":{"type":"integer","description":"Unix timestamp of cover creation."},"update_timestamp":{"type":"integer","description":"Unix timestamp of last cover update."},"status":{"type":"string","description":"Current status of the cover."},"id":{"type":"string","description":"Unique identifier of the cover."}}},"success":{"type":"boolean","description":"Indicates if the request was successful."},"message":{"type":"string","description":"Additional message regarding the request."},"error":{"type":"string","nullable":true,"description":"Error message if an error occurred, null otherwise."}}},"CountryInfoService":{"type":"object","properties":{"nome":{"type":"string","description":"Country name in Italian"},"name":{"type":"string","description":"Country name in English"},"zona":{"type":"string","description":"Pricing zone for the country.\nFor raccomandata_estero, ordinaria_estero, and prioritaria_estero: Ranges from 1 to 3.\nFor telegramma_estero: Ranges from A to H.\n"}}},"ForeignRecipient":{"type":"object","required":["nome","cognome","indirizzo","comune","cap","nazione"],"properties":{"titolo":{"type":"string"},"nome":{"type":"string"},"cognome":{"type":"string"},"indirizzo":{"type":"string"},"civico":{"type":"string"},"comune":{"type":"string"},"cap":{"type":"string"},"provincia":{"type":"string","description":"Use 'EE' for foreign destinations"},"nazione":{"type":"string","description":"Codice ISO del paese (es. GB, US)"}}},"ragione_sociale_object":{"description":"The field <code>ragione_sociale</code> can be used if you are sending mails on the behalf of a company: when set, both <code>nome</code> and <code>cognome</code> are not avaialble","type":"string","maxLength":44},"patch_response_object":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"error":{"type":"integer"},"data":{"type":"object","default":null}}}}},"externalDocs":{"description":"First time here? Generate a new access token","url":"https://console.openapi.com/oauth"},"security":[{"bearerAuth":[]}],"tags":[{"name":"Ufficio Postale"},{"name":"Telegrammi"},{"name":"Atti Giudiziari","description":"This product offers a tracking code"},{"name":"Raccomandate","description":"This product offers a tracking code"},{"name":"Posta Prioritaria","description":"This product offers a tracking code"},{"name":"Posta Ordinaria"},{"name":"Raccomandata Smart"},{"name":"Posta Massiva"},{"name":"Posta Massiva Top"}]}