Run with Postman
logo
Documentation Powered by Redocly

Ufficio Postale (1.0.0)

URL: https://openapi.it/en/support License: Apache 2.0 Terms of Service

This web service allows the delivery of postal products like Raccomandate, Telegrammi, Posta Prioritaria through Poste Italiane

  1. Create a new mail with a POST request
  2. Check the prices and confirm it with a PATCH, or use autoconfirm: true
  3. Receive the status updates of your mail by providing a callback url

Note: 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.

Error handling

When a sending error occurs, the response will include a message and a data.wrong_fields: []: each element of wrong_fields 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

Testing

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.

First time here? Generate a new access token

Ufficio Postale

Get pricings

Returns a list of prices for various kinds of services

Authorizations:
bearerAuth

    Responses

    Response Schema: application/json
    object
    success
    boolean
    message
    string
    error
    any

    Request samples 

    CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/pricing/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

    Response samples

    Content type
    application/json

    OK

    {
    • "data": [
      ],
    • "success": true,
    • "message": "",
    • "error": null
    }

    List of addresses

    Authorizations:
    bearerAuth
      query Parameters
      cap
      string
      Default: "<string>"
      Example: cap=05100
      comune
      string
      Default: "<string>"
      Example: comune=terni
      dug
      string
      Default: "<string>"
      Example: dug=via

      Responses

      Response Schema: application/json
      data
      Array of strings <= 2 items
      success
      boolean
      message
      string
      error
      any

      Request samples 

      CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/indirizzi/?cap=05100&comune=terni&dug=via");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

      Response samples

      Content type
      application/json
      {
      • "data": [
        ],
      • "success": true,
      • "message": "string",
      • "error": null
      }

      List of all available dugs

      (denomiazioni urbanistiche generiche)

      Authorizations:
      bearerAuth

        Responses

        Response Schema: application/json
        Array of objects[ items ]
        success
        boolean
        message
        string
        error
        any

        Request samples 

        CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/dug/");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

        Response samples

        Content type
        application/json
        {
        • "data": [
          ],
        • "message": "1 Risultato",
        • "success": true,
        • "error": null
        }

        Track your product

        Authorizations:
        bearerAuth
          path Parameters
          id
          required
          string
          Default: "<string>"

          Responses

          Response Schema: application/json
          Array of objects[ items ]
          success
          boolean
          message
          string
          error
          any

          Request samples 

          CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://ws.ufficiopostale.com/tracking/%7Bid%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd<