1. Help Center
  2. API documentation

Different Formats of a POD and How to Acquire Accompanying Information via the API

By default a POD is a PDF document that you can download after a successful completion of a task, but what you can also do is generate it in a different format and download accompanying documents like photos and signatures which are usually less visible on the document itself.

To convert a POD to HTML and make it embeddable, do the following:

  • Get the order_id or order_item_id from the Dispatcher Admin
  • Depending on the chosen, use one of the following URL's and append that ID to the end of it together with ?format=html:
    • https://umbrella.yojee.com/api/v3/public/pods/order/orderID?format=html
    • https://umbrella.yojee.com/api/v3/public/pods/order_item/order_itemID?format=html
  • Once done copy / paste the URL in your browser's TAB and press ENTER to visit it, an HTML version of the document should show up in matter of milliseconds

To download accompanying info for a POD (photos & signatures)

  • Steps are pretty much the same as of the above with a slight difference in the end of an URL
  • Get the order_id or order_item_id from the Dispatcher Admin
  • Depending on the chosen, use one of the following URL's and append that ID to the end of it together with ?format=zip:
    • https://umbrella.yojee.com/api/v3/public/pods/order/orderID?format=zip
    • https://umbrella.yojee.com/api/v3/public/pods/order_item/order_itemID?format=zip
  • Once done copy / paste the URL in your browser's TAB and press ENTER to visit it, a download containing the archive (ZIP) should begin almost immediately.

In case you have any questions, feel free to reach out to support@yojee.com

We are always ready to help!