GetDocuments
POST
/services/api/rest/GetDocumentsThis function will retrieve the requested document types for the given shipment. Documents are returned in Base 64 format.
Error Handling:
Permissions: Certain permissions are required to see documents (this occurs most commonly with AP and AR documents). If you receive this response, please contact Banyan.
Request
Header Params
Content-Type
string
required
Example:
application/json
Accept
string
optional
Example:
application/json
Body Params application/json
No schema defined
Example
{
"AuthenticationData": {
"Username": "username",
"Password": "password",
"ClientRefNum": ""
},
"LoadId": 123456,
"ConversionOptions": {
"ConvertPDFToImage": false,
"ImageFormat": "JPG"
},
"Documents": [
"Banyan_BOL",
"Carrier_POD"
]
}
Request samples
Responses
GetDocuments(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
No schema defined
ExampleGetDocuments
{
"LoadID": 12345678,
"Documents": [
{
"DocumentType": 1,
"Base64Documents": [
"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCBYWFRgWFRUYGRgYHBoaGhoaGBoZGBgaHBwZGhoaGBocIS4lHB4rIRkYJjgmKy8xNTU1GiQ7QDs0Py40NTEBDAwMEA8QHhISHjQhISs0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NTQ0NDQ0OjQ0Mf/AABEIAOEA4QMBIgACEQEDEQH/xAAbAAABBQEBAAAAAAAAAAAAAAAEAAIDBQYBB//EAD0QAAEDAgMEBwYFAwUBAQEAAAEAAhEDIQQSMQVBUWEGInGBkaGxEzJCUsHRFHKS4fBigrIjM0Oi0sKTFv/EABkBAAMBAQEAAAAAAAAAAAAAAAABAgMEBf/EACARAQEAAgMAAwEBAQAAAAAAAAABAhEDITEEEkFRIjL/2gAMAwEAAhEDEQA/AN+3G/NI7Eypi2xYEnmoX0HATFv5qosq7emRrWFxtqUg1T0XZTpI4LgalVQzIrClSyRY+V0IQo31njRzv1FLZ2LGTeYHaYQFbHxZo75kIJ5J1JPau06cmJA7f2StGhI2i7e0eY+qjbjyPh/7FMr0spiZO+xEeKGIU2nIIqY5xsIHZf1TG8UFtLGsw8Z80kWIaC0eeqpK3SJhtTmXGC6o6zRxDRIA7AuDm+XMctYzbt4vi5ZT7W6jcUMcQIcCRx0Kn/GscWkyANZbPovPMV0iqMADAz8zSH5jxvoO5R4PpXVbZ7A//qR2QEY/N+3sXl8XX69JOKpib+AIP0SY9rhIcewn6FZvZW1mV7Nlr/kdEn8p3+qOzkHmF14cmOU3HNnhceqt6rDa58JVbj2u1OnZCcNofOxrucAFNOLZBBD77rR/ktWOtAJSlJyTQpCXDnrBWtMWkGD/ADcqZ7YMft6ounjbAObmjTQH0VRNizgaOYCTvA/ZOfRYSAwgSg2Ys7gB3kldbVfM5imc2kewix/ZRqV1d5EF1uwJhCIbiY5SZUsqdJDCSISS0FjTaIv/AJH7rvsgW3nxKReBBIAnjH3XPxTBOh7ku/xnA2LwzWgFvhMoYBS1amZRq9ai4UKZmHaWzEkaiY+qiaLE8PJT4eq0AgkCeIJ9FNMNVwU6W5e8e5B1WZTYntiCrb2rTMPbPMET4oTFlhHvguFrREdyQAkFx3k+JTQLzpCKwpGbtBQGPxlOlka/N1iTOoB4c1y/K5LhhbHR8fD7ZaZ/pDtAumzIm2ZrXkd179qxbnkuNxz6rW+QhbDFYJjyXAuyOuJ97nMIX/8AnWOvJXl8ct7v69PO9SRmqFaHHfJAUr8Q7MI3u/kq+Z0YvrA4p7+jEe7UjuWv1v8AGKrwmIcW5gYcT1Tp32W32NjTXYBdz2CHbyRudzWK2hs19KJiNxH8srzoU8uq3EjIZ47lpx245RHJN41qRg3kTkPeI9VE+g5tyNFbmm2NBl7ADPqhMU+GgN0Njf8AdenHn2q+F1q6kFSXTmcd5T20HfKjMBUtl39oCsBuEeYP1T0Ww1PAGB1m33En7KVuCcDB8QQibyOqbch91I91iS0+B+iXh7Pp4No4ntgoXHU4g/sjGkR7pH9pH0Q+OIDQOP8AOCUt2HMLSa9sHdMKCtRLewb1HSq5SjKmJDh1Y0uDHpvVd7K0BKShjs8/uuJlsRVqlxvu0XGiU1G4KnbNru4q7dRMcNINaSYm2/RCyrHGsAb7sXHwx5qtLVGN3NrgnDMzBwidPqhqrcpI4JwMNIi5i86JgYiiInJns3bmnwKuW4QCIBmfmjd+Up/set7zxbcQfVqjZs66xv3rNbfa572gmGNbPa4uPeVt8fgTdwLid+aPKAs/jsBnLSNWuIkkaEEnXfMeK4/ly3Hp2fEslqvxEBrANIXcOUHtWvnIBYS1ghrQYiO3VxQVIFt2Nezk4yFyY7dvk00gspmBAOc8sD2kSBdRYPab3EjKx0ahrwHj+0raWFo7bdMFhQnQ2WveRqGi/wDcEVtSrmpvIkQNDY6ovofs05HvcD14Dbge7Mm/Mx3JzHec0x5bJjVnWxT3RLtNLAeijzveYLie02U1XAvEkCw5ifVDU3lpld8cFTYmnly8xOoM+GiiU+KqZg06WIifpuQ4VIOY4gyNQjae0D8d+wBMbRDmA3tpDSR32QrmkaohWLehicwkRY3lvhoUY4nLu7hH1WfpvLdFYs2gDq1367eBColywmyjxGGDhIOngosLigRPkSFMXyOrlE8wfRR5VKvENLdULTf1wrLHkZesTO7gqYq02j/Z8/RJBZzxSQS2fhXC+o5IrZ7h7p7rIeripGUNjiZuVG1xbBRd2aoWGOnKBA110Poq9wU9bFZ2gEXG9DFyWEsmquQ6kySArJlFoHu9+RxPoqxjjIjXdCt2B+QSBNt8cFGewjqZRHVP/wCb/wDyonFmb3ToP+N3P+lEvBkW4/EeXJDueQ49g+L9koFftSDSfkgOixjLHG8WtKz+xqmam/NJyuBA5EEx/wBVq6pJa4RYg2kcFRYbAvY6q9wGR46sHgbW3WXN8jC2yx3/ABeXCcdwvvVZutVzFxI1JKHcCVK6xKj/AAjXkZu7fB4rjm3bqLfCshgB4KM4CmTdgOl4vbS+qWHwTWw4OdOWIzGO2NJRC3nTPoHtGhmZkZMuIGsmNTJPYtZs97Sxhp2ZlhoI0y2jXWQs37MuLcuuYd+ojzWkwzGMa1gPuj53Cd5MAxqSteKby25vkamM/qdoN7jXgfuqethXAZrEeatmAXuf1k7uaifAZJJA7R9QupwqeVwJ1R4LiRN+KaCgaWmEb1BcbxoTOvAqLHhvVIEHSL/VS4B0MJ4TqYQmJrh7pAgaBVKWkJUjabvlPgUSygBcye6yKdJjqyNdT9kQqFw2KczQqyp4prz7sEcgQqJzrntXWViDIMJku6jWukOaO3KPLhuVTXpFp5bjxRmHxrXCHWPdB707HNGUQQRNvDcnCVySf7NJAHUaZcbCVaMpi4y8r6BR7PPUsY7giml0nrDd8P7qMsrs4qHsIsdU1F48nMJINtwj6lBq5luKifDOAcJMc7fVWjm2HW4fC36QqR7YAM6qTDV3ZmjMY4Ss8sdmtnE26w3/AAHlwch35sx6zf0H/wBqZwMjXTieXNQvYZN3eJSkJBUzZXQ5hsfgP/tC4hx9nDiwSI1IPcFHjMWRLGE8zM9wsqquTBO8AnwCWflXhP8AUUWJokOLXahDDCgkdTwJHop62Jc73rkb98cDxUGH2jlcvM629eWxZ0cPA1eP73H1U7XmANSoG48OHVCnw1nNc7QEHwutZNozt9aDD4RjCCGHNoXE5p4kCbIov62h0+UlCUcQXcJ7fsiRmkWH6j9l24yTqPNztyu6QcJPVP6HcOxQlrC2Cw7/AIHcbblLmdJt4HlzhB1McRLcpmT8SvaNAKlPKYPoR6pgTnvJMkyU1I9HBxNpMTpulT1qGUDWdDwB/kp2BotcSXbucKzFLMCDofyz4pxNA4SoZDTccIlHZdeqW8xIQNSg5hGa28QpX4txEADSOJ8SnKViOu9uUguk7onxuhGMJ0BPYJT3tVhhRLWxYX+bW+sFMvFc+mQYLSO0R6qSk1SYh4c6A0CLWm570R+ELWhx8N6ZIcq6nwkmND9nOkG5R7Zk3Og4fZU2Ae0EhxA7Y+qsBUZOrNOIU5TsQPjz19SbBDAruMqDOcsRbTTRQCojyKi1bTaafWFtZ4c5VbUsYBB5pVK5IAmABpJjtXKVFz9NOKlR1PGub8LHDm0eqVXaLCHf6bQ4ixAb46JYnBBurwO791U4iqxp6zhHmouUndVMLfEuZMr2BadXMeQOMN/cKbAYkHScvvG/vcNNyrNt0qpex7Glxh5tE6ibaxeFhycm8b9XRw8cmU+yncp8OxhEloK6/Bv19m8f2myZQcALrmkd81VhTA3CEXhYGaofcYHEncSAZHcP5qgMHTdVMNkM+J/0bz57kd0hinhKgbYZMo/uIb9V0cWO+/xz83JJPrPWU2D0mdSLWVSSwRlOpZy5t5bl6Jhsex7Q5tRpB4db0K8Squ1UuA2m6kTGh8iquVx7jk3Le3s1fGgTBk/lI+qrruPMrEYDpVUbZzsw4OAPrcK4w3SxmpYO4x6pzml9O8f8aWrSyt3XhDQoaW36FQQXFh/qFvEIkMkZhDhxaQ4eIWkzl8RcbBWz98+isW5b+73gfZVmAJDj2KzpPP8AVNvl581pGdQ44tloEb5gDzhT4fAD3iZPCLITEPLqkHdHD6Kz1FtdNIPegldjWCHEAjS2WAgGVSARe/Mj0V1iCBmziW5bwPpKobTqqIRhGkuECVfva2HSBpwM+lkBgqrAOq5vfIg8ZRjsewGCc06wZCVqQFkkV7alz8D90k9qCOrZKhN4lWFPE5jLSSI4fsqttIukmb8tSo303MN5B1F/SEWlo/Gvl7u3frooA9cqOJJJuSmEqbV4wQzSSYHE6fuo8Tt1jG5WkW3nXuCx3SLb5ZUcwTDIA7SAT5rK4vaT37yubPls6joxwxk3k1m2OlkyGmVmqu1nu6znXdZo4N3uPboO/kqd70g5YXd9VeT8j1nYT/8ATJ5NaPNx8gPFQbdrEFha4glsSDBABJsRcTm8gqjZvSajSow8Pc9zzkaxoMtysaJJIAvKI2nis7aTixzHFrszXGSOsQNOQB708LqaGffbmHxNVzoFWoZGUAvcbkgWk6ovDbKc93XlrQSDxMHQcuar9nHrt/M3/IK4w3SfDZsjqzA6SJm0g6EnQ9q1xxxvqJyZYy6XmHptY0AAADQBYjpztgOIoMMhpl5/qGje6STzjgtHtjarWUXvpPpl4aS3rtI4zY3tpzheUVHkmTqb/da5ZSTUZTftce5DPKle5Qm6xtN1riuioeKTQuTdTo/snZiXDQqxw23KzfceWm1wSPHiqlPopyQ/tY9S6JbcNdpa+PaN1MRnbxgbwbHuWnpzujwP3XkvRKsW4qlB1dlPMOBEL06riSLDVb45JvZ+GcXVCT5K1948COUHxlUeCrZX338VYvrANJcNdxGvfK12ih9qvM5c0xyAPYeKrnNIi2q6XFx4kqyZQD7SdNJNu6ChNV9IEmACey6JZTd8rv0lQMJY/wDKVbUXAXG/W5EqokEkrb25+XzSTPbjG9UDq2jf2KV+GY8dbXjN0xmJzN906cHfRqkbXG9nk7/yptNSVmQSOBKGeERVfcod71FrTF5f0jq5sRUI+Yjw6v0VSXWR22h/rVPzv/yKrZXHld1tneycuAriSTNO1+bICYDbSNQCZJHNbHO1zGZKheAyznOAcZJN80dncsVQBzNjWRE6TO/kt/hqeJcf9anhshBkszF+hiJEawnIJXMEwtcHOLGgFpkvbuIO4ngjW/ijcMwVYcBLTHmEHjMG1mXJhjVn3m58sNjWd94Ec0BiKeFaevgsRTPzMLnAd7X/AEV3oQN0kf1YqYBlJ5PVqMc0ttcxlAv2rNko7auIY5wbSq1XsaNKkyxx1AkDcAq9Iq4U1wTwo6hQTuaBKjYk8rrEgkdoUmmEn6d4XCqArCV3Mc17CQ5pDgRqCDIXreyMU3EUmVN7hDhwcLEfXvXjTHXheqdB8OWYYOJ99znAcAOqPGJV43s4uMTRy34qN9UlobuHija7ARzQDgtoViTDVA1wJCuKdRjybg8iHT3KjptkwFMWEagjtEKpUWbdxVPK4iI4a6d6K2c43JNhpJ/dBuk6me1E7P1jv1ieScTfB/4oc/H9kl3OflHikqSi2bXMFvhZHUSYuDv3Kmwj8rgVcMm9uJ/l1G1qKqblDuRLwha5gE8AfRRk0xeWbZeHVXOGjjm8blVkqeuZKHXHfWufpJJJShnT2RInTett0cZhTWb7JlYPh0e0nLEGdTwWIY6CCN116PsipimHNVfSfTDXE5B1vdMXhPEjtuvaBTnE/h5zkPGXre5Y5rEXlVrKtb/j2lRfyc2mfNrpVhtvFOeabmYZtduQkglrcubIRGcG5jyVBj6tIMc6ps17Le80MgHQS5pECVdu6uTUUOPrvfUe95aXkwSyzTl6st5QEOuNEBclJByjcnB44hRvN0GjcbqRgUTVOwJaI6odPFQCpCWIdBCgCVvYE0N7jv0Wr6D7Vcys2m5xLHmIJsHHQjh+6yzNIRGGquY9r2mC0gjtCqCXt7bVFkG5qzWyumjXwys3KdMwuO9a7DFriDYg3B3LfHLZ1BRsR2q+aw9xG+SO+CqjEUg19u1XGGfmYDYRyJ+oWkTYrcXhsh3RykeqEfIMixC072cTY8AI8wVW43ZwglloEwTP0TTVb+NfxSUfs0kEJLCIJ3q2w1QuZPIg3jRC12NLARrrr9EzBVD1hbQ6qTgV5QlcSD2FTOcmsEkBTk0w9eM1vohHPurDaDMr3Dg5w8CQqt65L60y9EFcSabLhRGdSBX2zXYHMyBVZUMDUwXG0a6Ss80rY7KfjMjDNE0o552sjwmE4ELywOAdjX0X5GdQOhkZAQYNrzx3IXatZ4pnLj21WOhpZDMxHaCSj6jqmjcGyuzKzrOLAZyMlsOvb6qj20W9UfhDQdOsjK4RcACx3J1VvSvJXab4cDEwRbjfRRSnUquVzXROUgxxgzCET16ScVeMRTY8/CCGvDey3koKuGw79aNPupgegVTszF5xnAu5xsT7qvGl3JZYyvU/zlNxX4jYeHe0taxrHbnNblIPdr2LG16JY5zHatMFeiMBm8Kg6T7OBb7Vuos7mNxWmLDmwlx3GNxQ0KiabomuyWoZgIOhRY4j3OM2UoeY1UIYRcp7L6Imy2nZIvK1fRvpe6hDHtzsGm5zeziOSx8JNJlX4cr3SjtOliGB9Mgx4jkVY7MfMtJ9PqvHejGOfTrMymz3Na4biCY+q9Tw1QtfrG5bYZbOtC05h8R/uj0hJzG2OUf3GT5odhEmRO+5B9dELisWQMjQAN8ASeVlqzon2dL+nxH3SVP7RJBJGVnsJEDmCJULXncjdoMdYwIEyRJhApHDHlMou62sQuvKExFTK0u4AnwuoyaYvKNoVsz3O4ucfEkqvqKzxAdUcSym1syTrHElznH7IB1JxuBI+aIb4rjvrTKXZtF1k4lRBpCeySYAJPACT4BEQkYrnZf4bqT7VtWTpOQndeDbvVWMLUFzTeBxyOA9FfbEqV2tytFJ1N05pIztEHS4v4q4WtJcQWZjOMfRcAyWA9UdRkGOapdr1CXNH4n24AJB+Wdx5q+rvqB3VwjKrYZ1y5gM5GyIIJssztRx9oZoiiYEsHeZsBx8kU74GK5K4XJspJW2xMXkcWEgB8QToD+612Fyxeo6fzAeULzovTC88Sp13t0cfN9cdV6oxoBs4ntISxrMzHg72n0WD2NtotIa89XceHatNU2zTyGHiTzRvXVbzOZdxknDULmVdxWIbnOUiCkCtsbuOHkmsq5kTRRvKkSlVqMzHMSewEc04ldS1DlGdHqk1qbTrnZ/kF6zUfDyef1XjdBxY9r26tII7QZC9ZZiA8B40eA8djhP1VYe1p+NKx7QA8wN05QUDi64e6QIHZCCdXJAndojsHRBGYnsG7vW7O9B0lY5j/SkmWzW4vi1/wCgoXGPBMib7i0t776or27WzmcOY3oDF4nOeQ0496koge5C4hoc0tOjgQe8QpnFREqK0jzvaDmUiaR65bZzRZhcPnOrgPlEDiSubN2a/EuzvdDG2mIH5WNFgE7bWEc7FPYNXvLgToGu60nkB6Lr9pZctOn1WN6oO88XHmTJXNlO3Q0mH2XgaQGdmd543jsGidWxFFoiizJPAAeiDx1SmS3ITAaBmJu48eSCNMfO79Sxu66cMcZPEO18a9gkGZQGzfZuIL6dTOScr2zk0+IgxZE7TeAwwJ5m6G2JWfZrarQPipuFzzaVeE0w+RbbBeNfRzdbEVKT8req10MjKIOmves5jHDO6KhqDc86uEfwLU1X1hOSkx7Yb7zodOUAi4jcslXdLnEsDOseqNG30EK745r4ZKaSuFcUkRTSnFcg8EQGFJqRTVQ3U9JlirvZWLosa/2tPOXNyiTGWfiadzhA81n2vKuOj+yvxL3Mz5CG5gcuYGCBBEjiiblAraOIpvLcjGtDW5SW2D7khxG4wQD2IJzldYjoZiG+49j/ABafP7oRnRjFH/j/AOzfur3RcarsycHq7odC8SdcjRzeT5AKzwnQJ5PXrNA35GknuJsnPsPqzmy8E+s8MYJJ1O5o3ucdwXpdNmRrWDRjWsHMNAEqbAbJZRZkpdQHUiC5x4uJ1UWIaWuIJJPEx9FrjNDaalLjH8CtcM4NbGfzt5hU2Ge+YY6Cf5wRYbX+ceX2Vyoyqy/Ecx4j7JKsz1vnHl9lxNJ1V8uJTCVzDNk30C5XEFJUNcUxy4XJN1E8VNWo+kOBc9pfTbL8uQxqWTJjidR2FYt1Fwl2V0AwTBgHgefJeo4ujFxp6Kk2xs/2rC0Oyu3HcfzfdZZYtMbv1m9n4tr2AZbtsY1PNEBw3Uz4R6qiqUauGeZa5vMjqnsdoe5KrtavlmAAZAdl1I1ie0LluF26seSSdptu13WZIG8tH1U2CY8sZmpMexolrxGdm++9Z97ySSSSTvOqsNmVASB1mm4s4hrrE3b3K8Zpy8mX2y2sNpGlmJf7UOhvWZIaeqCBwlZ0nt79e/mtDtHGPaXBj4AAtlB+EXBKzhTrOkSkCuJIS6j8NjmtZlLeOm+eKAShGtnLonmSmwnhie1ieqNoFoehlQtxLODg5viJ+iqmsCsNjPy1qbuDx52+qqYiZdvVGJOKa0rpK2irXaNUzBMqdruZ7EHKk9r4pwrT8XiXAgC3cgi4nUynvdOqa5qaUmFd1gj2v7P0qtoHrBGtdzH871URXM38hJReCSZLBhaLS2OEwh8YRmsdynp1QROc+VvJB4x8u36DUQkqIiV2kesO1QucnUndYdqmr2s3iQQdCqvHUcsRofVWBESZEcSFW42tNgZA5QlTlR0L/ZYnpUQXtaN0nvJla/2wawkmN3esJt2tmqSlZNWq2qmUszg3STCtMNs17HAmCBJkcMp3IPANl7e2VpqnunsPosNJZ/bbDnJ3Q3/EfZVK0W2W9Vx3yB5gLOkKbNC1wrkrpTUJPYpFEwp4cnAeE9qjBTmlUSQKWm+CDwuoV0FWHrGGq5mNdxaD4hTSqLoxii/DtnVks7hp5QrkOVYr2kJTXJsrhcqTXWt4pVEmu/krlQ/yU4lxhuEU154+X7oFrrhEZv5BTKp8x4riiz/yCkmSXDe47+blzG+93JJIVPQrkqPvBJJSoXif9rvHqqt6SSVOAtoe4Pzf/Llidq/7iSSV/wCaotlf7je/0K0Ff3Hdh9FxJZQldtr3Xfm/+lnXJJKMiphXEkkg6nJJJwHNUgSSVQj0gkkrJtuhv+y7859AtGEklWPivx1NKSSoqQXKiSScTUY1RISSVE6kkkgn/9k="
],
"ZPLDocuments": null,
"Success": true,
"Error": null
}
],
"Success": true,
"Error": null
}
Last modified: 3 months ago