{"info":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","description":"

The Trames shipment API provides a suite of commands to manage documents associated with shipments within an organization. Using these commands, you can upload, retrieve, download, and delete documents for specific shipments. To upload a document, a curl command sends the file to the shipment identified by its ID. To retrieve a list of uploaded documents, a curl command fetches all files associated with the shipment, making it easy to track and manage them. To download a specific document, another curl command retrieves the file using the shipment ID and the document ID from a previous list. Lastly, to delete a document, a curl command removes the file from the shipment using its ID, keeping the document management system organized.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"28931192","collectionId":"ce727706-73fe-4ecd-8156-75c6b704272d","publishedId":"2s9YeBetfd","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-11-23T12:25:18.000Z"},"item":[{"name":"Documents","item":[{"name":"Upload Shipment Document","id":"cba6f083-7fba-4b90-80c6-3076250563bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null},{"key":"filename","value":"","type":"text","description":"

File Name

\n"},{"key":"documentType","value":"","type":"text"},{"key":"type","value":"","type":"text"}]},"url":"https://lothal.sea.maz.trames.io//api/v1/shipments/:id/documents","description":"

The following curl command demonstrates how to upload a document to the Trames shipment API. This command sends a document to a specific shipment identified by its ID within an organization on the Trames platform. Here's a breakdown of the command and its components:

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["","api","v1","shipments",":id","documents"],"host":["https://lothal.sea.maz.trames.io"],"query":[],"variable":[{"id":"6055b850-717c-4d28-a715-acd4dacc4c33","type":"any","value":"","key":"id"}]}},"response":[{"id":"5131b81a-7593-4229-b047-306ffde727bd","name":"Upload Shipment Document","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null},{"key":"filename","value":"sample","type":"text"},{"key":"documentType","value":"pdf","type":"text"},{"key":"type","value":"invoice","type":"text"}]},"url":{"raw":"https://lothal.sea.maz.trames.io//api/v1/shipments/:id/documents","host":["https://lothal.sea.maz.trames.io"],"path":["","api","v1","shipments",":id","documents"],"variable":[{"key":"id","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"File Uploaded\",\n \"data\": {\n \"entityId\": \"\"\n }\n}"}],"_postman_id":"cba6f083-7fba-4b90-80c6-3076250563bd"},{"name":"GET shipment Documents","id":"cffc5752-c100-487e-883d-b2bcb7458c40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://lothal.sea.maz.trames.io//api/v1/shipments/:id/documents","description":"

The following curl command is used to retrieve a list of documents that have been uploaded to a specific shipment within an organization on the Trames platform. By providing the shipment ID, this API request fetches all associated documents, ensuring efficient tracking and management of shipment-related files.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["","api","v1","shipments",":id","documents"],"host":["https://lothal.sea.maz.trames.io"],"query":[],"variable":[{"id":"98bf6267-2cc3-44ec-9681-7ae16df88de9","type":"any","value":"","key":"id"}]}},"response":[{"id":"af52a478-0bf9-453d-bc7a-dc782b3032fb","name":"GET shipment Documents","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://lothal.sea.maz.trames.io//api/v1/shipments/:id/documents","host":["https://lothal.sea.maz.trames.io"],"path":["","api","v1","shipments",":id","documents"],"variable":[{"key":"id","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"fileName\": \"Document1\",\n \"entityId\": \"Document-Id-1\"\n },\n {\n \"fileName\": \"Document2\",\n \"entityId\": \"Document-Id-2\"\n },\n {\n \"fileName\": \"Document3\",\n \"entityId\": \"Document-Id-3\"\n },\n {\n \"fileName\": \"Document4\",\n \"entityId\": \"Document-Id-4\"\n }\n ]\n}"}],"_postman_id":"cffc5752-c100-487e-883d-b2bcb7458c40"},{"name":"Download Shipment Document","id":"908bc9e6-dc54-43f9-b9bd-92d75b87761d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://lothal.sea.maz.trames.io//api/v1/shipments/:id/documents/:docId/download","description":"

The following curl command is used to download a document that has been uploaded to a specific shipment within an organization on the Trames platform. By providing the shipment ID and the document ID (retrieved from a previous API call), this API request fetches the specific document for download.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["","api","v1","shipments",":id","documents",":docId","download"],"host":["https://lothal.sea.maz.trames.io"],"query":[],"variable":[{"id":"c382f73b-e4e2-4499-972c-4e7f913eb42c","type":"any","value":"","key":"id"},{"id":"e3cdb52c-ed9a-48ec-a386-47c499022e2f","type":"any","value":"","key":"docId"}]}},"response":[{"id":"a4902abe-2d05-41d2-9882-16803107731f","name":"Download Shipment Document","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://lothal.sea.maz.trames.io//api/v1/shipments/:id/documents/:docId/download","host":["https://lothal.sea.maz.trames.io"],"path":["","api","v1","shipments",":id","documents",":docId","download"],"variable":[{"key":"id","value":""},{"key":"docId","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"%PDF-1.3\r\n%����\r\n\r\n1 0 obj\r\n<<\r\n/Type /Catalog\r\n/Outlines 2 0 R\r\n/Pages 3 0 R\r\n>>\r\nendobj\r\n\r\n2 0 obj\r\n<<\r\n/Type /Outlines\r\n/Count 0\r\n>>\r\nendobj\r\n\r\n3 0 obj\r\n<<\r\n/Type /Pages\r\n/Count 2\r\n/Kids [ 4 0 R 6 0 R ] \r\n>>\r\nendobj\r\n\r\n4 0 obj\r\n<<\r\n/Type /Page\r\n/Parent 3 0 R\r\n/Resources <<\r\n/Font <<\r\n/F1 9 0 R \r\n>>\r\n/ProcSet 8 0 R\r\n>>\r\n/MediaBox [0 0 612.0000 792.0000]\r\n/Contents 5 0 R\r\n>>\r\nendobj\r\n\r\n5 0 obj\r\n<< /Length 1074 >>\r\nstream\r\n2 J\r\nBT\r\n0 0 0 rg\r\n/F1 0027 Tf\r\n57.3750 722.2800 Td\r\n( A Simple PDF File ) Tj\r\nET\r\nBT\r\n/F1 0010 Tf\r\n69.2500 688.6080 Td\r\n( This is a small demonstration .pdf file - ) Tj\r\nET\r\nBT\r\n/F1 0010 Tf\r\n69.2500 664.7040 Td\r\n( just for use in the Virtual Mechanics tutorials. More text. And more ) Tj\r\nET\r\nBT\r\n/F1 0010 Tf\r\n69.2500 652.7520 Td\r\n( text. And more text. And more text. And more text. ) Tj\r\nET\r\nBT\r\n/F1 0010 Tf\r\n69.2500 628.8480 Td\r\n( And more text. And more text. And more text. And more text. And more ) Tj\r\nET\r\nBT\r\n/F1 0010 Tf\r\n69.2500 616.8960 Td\r\n( text. And more text. Boring, zzzzz. And more text. And more text. And ) Tj\r\nET\r\nBT\r\n/F1 0010 Tf\r\n69.2500 604.9440 Td\r\n( more text. And more text. And more text. And more text. And more text. ) Tj\r\nET\r\nBT\r\n/F1 0010 Tf\r\n69.2500 592.9920 Td\r\n( And more text. And more text. ) Tj\r\nET\r\nBT\r\n/F1 0010 Tf\r\n69.2500 569.0880 Td\r\n( And more text. And more text. And more text. And more text. And more ) Tj\r\nET\r\nBT\r\n/F1 0010 Tf\r\n69.2500 557.1360 Td\r\n( text. And more text. And more text. Even more. Continued on page 2 ...) Tj\r\nET\r\nendstream\r\nendobj\r\n\r\n6 0 obj\r\n<<\r\n/Type /Page\r\n/Parent 3 0 R\r\n/Resources <<\r\n/Font <<\r\n/F1 9 0 R \r\n>>\r\n/ProcSet 8 0 R\r\n>>\r\n/MediaBox [0 0 612.0000 792.0000]\r\n/Contents 7 0 R\r\n>>\r\nendobj\r\n\r\n7 0 obj\r\n<< /Length 676 >>\r\nstream\r\n2 J\r\nBT\r\n0 0 0 rg\r\n/F1 0027 Tf\r\n57.3750 722.2800 Td\r\n( Simple PDF File 2 ) Tj\r\nET\r\nBT\r\n/F1 0010 Tf\r\n69.2500 688.6080 Td\r\n( ...continued from page 1. Yet more text. And more text. And more text. ) Tj\r\nET\r\nBT\r\n/F1 0010 Tf\r\n69.2500 676.6560 Td\r\n( And more text. And more text. And more text. And more text. And more ) Tj\r\nET\r\nBT\r\n/F1 0010 Tf\r\n69.2500 664.7040 Td\r\n( text. Oh, how boring typing this stuff. But not as boring as watching ) Tj\r\nET\r\nBT\r\n/F1 0010 Tf\r\n69.2500 652.7520 Td\r\n( paint dry. And more text. And more text. And more text. And more text. ) Tj\r\nET\r\nBT\r\n/F1 0010 Tf\r\n69.2500 640.8000 Td\r\n( Boring. More, a little more text. The end, and just as well. ) Tj\r\nET\r\nendstream\r\nendobj\r\n\r\n8 0 obj\r\n[/PDF /Text]\r\nendobj\r\n\r\n9 0 obj\r\n<<\r\n/Type /Font\r\n/Subtype /Type1\r\n/Name /F1\r\n/BaseFont /Helvetica\r\n/Encoding /WinAnsiEncoding\r\n>>\r\nendobj\r\n\r\n10 0 obj\r\n<<\r\n/Creator (Rave \\(http://www.nevrona.com/rave\\))\r\n/Producer (Nevrona Designs)\r\n/CreationDate (D:20060301072826)\r\n>>\r\nendobj\r\n\r\nxref\r\n0 11\r\n0000000000 65535 f\r\n0000000019 00000 n\r\n0000000093 00000 n\r\n0000000147 00000 n\r\n0000000222 00000 n\r\n0000000390 00000 n\r\n0000001522 00000 n\r\n0000001690 00000 n\r\n0000002423 00000 n\r\n0000002456 00000 n\r\n0000002574 00000 n\r\n\r\ntrailer\r\n<<\r\n/Size 11\r\n/Root 1 0 R\r\n/Info 10 0 R\r\n>>\r\n\r\nstartxref\r\n2714\r\n%%EOF\r\n"}],"_postman_id":"908bc9e6-dc54-43f9-b9bd-92d75b87761d"},{"name":"DELETE Shipment Document","id":"575c4d29-e1c2-4467-a6d2-d459cd7ecbc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://lothal.sea.maz.trames.io//api/v1/shipments/:id/documents/:docId","description":"

The following curl command is used to delete a document that has been uploaded to a specific shipment within an organization on the Trames platform. By providing the shipment ID and the document ID, this API request removes the specified document from the shipment.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["","api","v1","shipments",":id","documents",":docId"],"host":["https://lothal.sea.maz.trames.io"],"query":[],"variable":[{"id":"7bc1dc6b-edbe-4d89-8501-ee4ccea8fbb1","type":"any","value":"","key":"id"},{"id":"886e2a68-9017-4bc3-befe-80b4d2d74bfd","type":"any","value":"","key":"docId"}]}},"response":[{"id":"1e5d8a47-b8e7-4098-8be8-cce79ab5680d","name":"DELETE Shipment Document","originalRequest":{"method":"DELETE","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://lothal.sea.maz.trames.io//api/v1/shipments/:id/documents/:docId","host":["https://lothal.sea.maz.trames.io"],"path":["","api","v1","shipments",":id","documents",":docId"],"variable":[{"key":"id","value":""},{"key":"docId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"575c4d29-e1c2-4467-a6d2-d459cd7ecbc4"}],"id":"4bad81e4-fa76-4aa1-8fbe-4ad6c2ab6680","_postman_id":"4bad81e4-fa76-4aa1-8fbe-4ad6c2ab6680","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}}},{"name":"Invoice","item":[{"name":"Upsert Invoice V2","id":"21c5cf9f-3a70-482c-be6f-0095f778a5bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://lothal.sea.maz.trames.io//api/v2/shipments/:id/invoices?templateId=","description":"

This api is used to Upload a invoice to a shipment using shipmentId.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["","api","v2","shipments",":id","invoices"],"host":["https://lothal.sea.maz.trames.io"],"query":[{"key":"templateId","value":""}],"variable":[{"id":"d83a8828-9306-4fd4-9f55-f62d310d83e6","type":"any","value":"","key":"id"}]}},"response":[{"id":"a599eed4-6249-4c41-a450-ebf7ed7f2bff","name":"Upsert Invoice V2 (ocean)","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invoiceNo\": \"\",\n \"invoiceType\": \"Ocean\",\n \"invoiceTypeId\": \"Ocean\",\n \"invoiceDate\": \"\",\n \"remarks\": \"\",\n \"status\": \"PND\",\n \"categoriesCost\": [\n {\n \"categoryId\": \"PickUp\",\n \"cost\": {\n \"currency\": \"USD\",\n \"value\": 0\n },\n \"componentsCost\": [\n {\n \"componentId\": \"PickUp20\",\n \"cost\": {\n \"currency\": \"USD\",\n \"quantity\": 0,\n \"rate\": 0,\n \"value\": 0\n }\n },\n {\n \"componentId\": \"PickUpCNT40\",\n \"cost\": {\n \"currency\": \"USD\",\n \"quantity\": 0,\n \"rate\": 0,\n \"value\": 0\n }\n }\n ]\n },\n {\n \"categoryId\": \"OriginCharges\",\n \"cost\": {\n \"currency\": \"USD\",\n \"value\": 0\n },\n \"componentsCost\": [\n {\n \"componentId\": \"OriginCustomsChargesFCL\",\n \"cost\": {\n \"currency\": \"USD\",\n \"quantity\": 0,\n \"rate\": 0,\n \"value\": 0\n }\n }\n ]\n },\n {\n \"categoryId\": \"DestinationCharges\",\n \"cost\": {\n \"currency\": \"USD\",\n \"value\": 0\n },\n \"componentsCost\": [\n {\n \"componentId\": \"InlandCNT20\",\n \"cost\": {\n \"currency\": \"USD\",\n \"quantity\": 0,\n \"rate\": 0,\n \"value\": 0\n }\n }\n ]\n }\n ],\n \"grandTotalCost\": {\n \"currency\": \"\",\n \"value\": 0\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://lothal.sea.maz.trames.io//api/v2/shipments/:id/invoices?templateId=","protocol":"https","host":["lothal","sea","maz","trames","io"],"path":["","api","v2","shipments",":id","invoices"],"query":[{"key":"templateId","value":""}],"variable":[{"key":"id","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\"\r\n}"},{"id":"a2f91abd-d863-48e7-9f12-87bb8abab9a2","name":"Upsert Invoice V2 (air)","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invoiceNo\": \"\",\n \"invoiceType\": \"Air\",\n \"invoiceTypeId\": \"Air\",\n \"invoiceDate\": \"\",\n \"remarks\": \"\",\n \"status\": \"PND\",\n \"categoriesCost\": [\n {\n \"categoryId\": \"PickUp\",\n \"cost\": {\n \"currency\": \"USD\",\n \"value\": 0\n },\n \"componentsCost\": [\n {\n \"componentId\": \"PickUpAir\",\n \"cost\": {\n \"currency\": \"USD\",\n \"quantity\": 0,\n \"rate\": 0,\n \"value\": 0\n }\n }\n ]\n }\n ],\n \"grandTotalCost\": {\n \"currency\": \"\",\n \"value\": 0\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://lothal.sea.maz.trames.io//api/v2/shipments/:id/invoices?templateId=","host":["https://lothal.sea.maz.trames.io"],"path":["","api","v2","shipments",":id","invoices"],"query":[{"key":"templateId","value":""}],"variable":[{"key":"id","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\"\r\n}"}],"_postman_id":"21c5cf9f-3a70-482c-be6f-0095f778a5bf"},{"name":"Invoice Document","id":"b6a2263c-49f2-4716-b21b-195e6a1f2e02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://lothal.sea.maz.trames.io//api/v2/shipments/:id/invoices/:invoiceNo/documents?templateId=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["","api","v2","shipments",":id","invoices",":invoiceNo","documents"],"host":["https://lothal.sea.maz.trames.io"],"query":[{"key":"templateId","value":""}],"variable":[{"type":"any","value":"","key":"id"},{"type":"any","value":"","key":"invoiceNo"}]}},"response":[{"id":"3361cb69-24e4-4e31-9f35-0f0349b504f0","name":"DELETE Remove Invoice Document","originalRequest":{"method":"DELETE","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://lothal.sea.maz.trames.io//api/v2/shipments/:id/invoices/:invoiceNo/documents?templateId=testTemplateId","host":["https://lothal.sea.maz.trames.io"],"path":["","api","v2","shipments",":id","invoices",":invoiceNo","documents"],"query":[{"key":"templateId","value":"testTemplateId"}],"variable":[{"key":"id","value":"testShipmentName"},{"key":"invoiceNo","value":"123456"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"message\": \"Invoice File Removed\"\r\n}"}],"_postman_id":"b6a2263c-49f2-4716-b21b-195e6a1f2e02"},{"name":"Add or Update Invoice Document","id":"7cca165d-0120-485e-b27e-e3aaa266981f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""}],"body":{"mode":"formdata","formdata":[{"type":"file","key":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/C:/Users/Most Wanted/Downloads/sample (1).pdf"],"value":null}]},"url":"https://lothal.sea.maz.trames.io//api/v2/shipments/:id/invoices/:invoiceNo/documents?templateId=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["","api","v2","shipments",":id","invoices",":invoiceNo","documents"],"host":["https://lothal.sea.maz.trames.io"],"query":[{"key":"templateId","value":""}],"variable":[{"type":"any","value":"","key":"id"},{"type":"any","value":"","key":"invoiceNo"}]}},"response":[{"id":"dbf3b97c-688c-4e40-8030-8ec76235d8d0","name":"POST Add or Update Invoice Document","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""}],"body":{"mode":"formdata","formdata":[{"type":"file","key":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/C:/Users/Most Wanted/Downloads/sample (1).pdf"],"value":null}]},"url":{"raw":"https://lothal.sea.maz.trames.io//api/v2/shipments/:id/invoices/:invoiceNo/documents?templateId=testTemplateId","host":["https://lothal.sea.maz.trames.io"],"path":["","api","v2","shipments",":id","invoices",":invoiceNo","documents"],"query":[{"key":"templateId","value":"testTemplateId"}],"variable":[{"key":"id","value":"testShipmentName"},{"key":"invoiceNo","value":"123456"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"message\": \"Invoice File Uploaded\"\r\n}"}],"_postman_id":"7cca165d-0120-485e-b27e-e3aaa266981f"}],"id":"e3459056-d55f-4a9d-b490-b315b4c51cc7","_postman_id":"e3459056-d55f-4a9d-b490-b315b4c51cc7","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}}},{"name":"V3","item":[{"name":"Shipment","item":[{"name":"Delete Shipment","id":"0fa53b90-6c69-4561-b613-b2fc00fa2a4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/shipment/delete?shipmentId=","description":"

This Api is used to get the shipments details using the shipment id.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["api","v3","shipment","delete"],"host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"query":[{"key":"shipmentId","value":""}],"variable":[]}},"response":[{"id":"5f63a992-1d1f-4c76-abdc-bf113df09951","name":"Delete Shipment","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/shipment/delete?shipmentId=shipmentId","host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"path":["api","v3","shipment","delete"],"query":[{"key":"shipmentId","value":"shipmentId","description":"Enter the shipmentId to delete it."}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Shipment deleted successfully\"\n}"}],"_postman_id":"0fa53b90-6c69-4561-b613-b2fc00fa2a4f"},{"name":"Create Shipment","id":"f1fd432f-0676-47a8-8530-7293a3ceda42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/shipment/create?templateId=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["api","v3","shipment","create"],"host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"query":[{"key":"templateId","value":""}],"variable":[]}},"response":[{"id":"d4ccdbd1-a0d0-4ca6-947d-c1aba01e73e6","name":"Create Shipment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"displayName\": \"displayName\",\r\n \"shipper\": \"shipper\",\r\n \"consignee\": \"consignee\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/shipment/create?templateId=templateId","host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"path":["api","v3","shipment","create"],"query":[{"key":"templateId","value":"templateId","description":"Enter the shipment templateid for creating the shipment."}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"displayName\": \"LOTHAL-TT\",\n \"additionalData\": {},\n \"name\": \"OYSN74Kn-S7Y\",\n \"buGroupId\": \"hf-analytics-test-2864--hf-analytics-test\",\n \"shipper\": \"test1\",\n \"consignee\": \"test2\",\n \"description\": \"1 X 20 FT REEFER CONTAINERCHILLED CHEESEHS CODE: 0406.10NPWP: 01.368.275.2-092.000SRP No:tbc\",\n \"originName\": \"MELBOURNE\",\n \"originCountryISO\": \"AU\",\n \"destinationName\": \"YOKOHAMA\",\n \"destinationCountryISO\": \"JP\",\n \"etdPOL\": \"2024-11-30T06:30:00.000Z~offset=5.5&timezone=India Standard Time&abbrev=IST\",\n \"shipmentType\": \"FCL\",\n \"grossWeight\": \"2000 KGM\",\n \"POL\": \"AUMEL\",\n \"POD\": \"JPYOK\",\n \"transportMethod\": \"ocean\",\n \"goodsType\": \"normal\",\n \"shipmentMode\": \"direct\",\n \"shipmentUUID\": \"2Qg930HIYUzcbFDVimxfhlvYJZP5ZvFBIPM2\",\n \"uid\": \"2Qg930HIYUzcbFDVimxfhlvYJZP5ZvFBIPM2\",\n \"advancedData\": {},\n \"id\": \"OYSN74Kn-S7Y\"\n }\n}"}],"_postman_id":"f1fd432f-0676-47a8-8530-7293a3ceda42"},{"name":"Get Shipment","id":"97aaff9a-f117-4ab7-92a4-96fbe6a95871","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/shipment?shipmentId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["api","v3","shipment"],"host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"query":[{"key":"shipmentId","value":null}],"variable":[]}},"response":[{"id":"2a3a7f83-294b-4013-8c08-5ad2507f2fb3","name":"Get Shipment","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/shipment?shipmentId=shipmentId","host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"path":["api","v3","shipment"],"query":[{"key":"shipmentId","value":"shipmentId","description":"Enter the shipmentId to get its details."}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"shipper\": \"Shipper\",\n \"consignee\": \"Consignee\",\n \"POL\": \"POL\",\n \"POD\": \"POD\",\n \"etdPOL\": \"2023-04-08T17:00:00.000Z\",\n \"etaPOD\": \"2023-04-13T17:00:00.000Z\",\n \"entityId\": \"id1\",\n \"additionalData\": {\n \"addGrossWeight\": 0,\n \"grossVolume\": 0,\n \"equipmentValue\": 0,\n \"incoterms\": \"\",\n \"Manufacturer\": \"\",\n \"ManufacturerEstimatedDeliveryDate\": \"2023-04-13T17:00:00.000Z\",\n \"bookingFormReq\": null,\n \"bookingFormRcv\": null,\n \"cargoReadyDate\": \"2023-04-13T17:00:00.000Z\",\n \"bookingReqSent\": null\n },\n \"grossVolume\": \"12.77 CBM\",\n \"description\": \"Description\",\n \"carrierScac\": \"CarrierScac\",\n \"carrierName\": \"CarrierName\",\n \"masterDocNo\": \"MBL\",\n \"houseDocNo\": \"HBL\",\n \"bookingReferenceNo\": \"BKC\",\n \"transportMethod\": \"air\"\n }\n ]\n}"}],"_postman_id":"97aaff9a-f117-4ab7-92a4-96fbe6a95871"},{"name":"Update Shipment","id":"65470d07-6159-469d-8951-4d5a5d7727ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\n}","options":{"raw":{"language":"json"}}},"url":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/shipment/update?shipmentId=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["api","v3","shipment","update"],"host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"query":[{"key":"shipmentId","value":""}],"variable":[]}},"response":[{"id":"1ba40229-91f7-41f9-bc8e-5f740a9b3880","name":"Update Shipment","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"shipper\": \"shipper\",\n \"consignee\": \"consignee\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/shipment/update?shipmentId=shipmentId","host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"path":["api","v3","shipment","update"],"query":[{"key":"shipmentId","value":"shipmentId","description":"Enter the shipmentId for update."}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"displayName\": \"LOTHAL-TT\",\n \"additionalData\": {},\n \"name\": \"OYSN74Kn-S7Y\",\n \"buGroupId\": \"hf-analytics-test-2864--hf-analytics-test\",\n \"shipper\": \"shipper\",\n \"consignee\": \"consignee\",\n \"description\": \"1 X 20 FT REEFER CONTAINERCHILLED CHEESEHS CODE: 0406.10NPWP: 01.368.275.2-092.000SRP No:tbc\",\n \"originName\": \"MELBOURNE\",\n \"originCountryISO\": \"AU\",\n \"destinationName\": \"YOKOHAMA\",\n \"destinationCountryISO\": \"JP\",\n \"etdPOL\": \"2024-11-30T06:30:00.000Z~offset=5.5&timezone=India Standard Time&abbrev=IST\",\n \"shipmentType\": \"FCL\",\n \"grossWeight\": \"2000 KGM\",\n \"POL\": \"AUMEL\",\n \"POD\": \"JPYOK\",\n \"transportMethod\": \"ocean\",\n \"goodsType\": \"normal\",\n \"shipmentMode\": \"direct\",\n \"shipmentUUID\": \"2Qg930HIYUzcbFDVimxfhlvYJZP5ZvFBIPM2\",\n \"uid\": \"2Qg930HIYUzcbFDVimxfhlvYJZP5ZvFBIPM2\",\n \"advancedData\": {},\n \"id\": \"OYSN74Kn-S7Y\"\n }\n}"}],"_postman_id":"65470d07-6159-469d-8951-4d5a5d7727ab"}],"id":"eab9cb65-c407-4c67-80a4-cbeb02b31033","description":"

This is a collection of api to perform action on shipment entity. The fields are configured for each api key by the Trames AM team, only those fields can be used for search, create or update operations.

\n","_postman_id":"eab9cb65-c407-4c67-80a4-cbeb02b31033","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}}},{"name":"Order","item":[{"name":"Delete Order","id":"f0913683-57a5-494d-a816-4f1582a65811","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/order/delete?orderNo=&orderLineNo","description":"

This Api is used to get the shipments details using the order no.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["api","v3","order","delete"],"host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"query":[{"key":"orderNo","value":""},{"key":"orderLineNo","value":null}],"variable":[]}},"response":[],"_postman_id":"f0913683-57a5-494d-a816-4f1582a65811"},{"name":"Create Order","id":"2447ec88-0e38-432f-a8c2-67ab2f71c4fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"orderNo\":\"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/order/create?templateId=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["api","v3","order","create"],"host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"query":[{"key":"templateId","value":""}],"variable":[]}},"response":[{"id":"47d498c6-ee05-4536-8c08-c37f27247cfc","name":"Create Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"orderNo\":\"Lothal-TTTT\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/order/create?templateId=templateId","host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"path":["api","v3","order","create"],"query":[{"key":"templateId","value":"templateId","description":"Enter the templateid to create a order."}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"additionalData\": {},\n \"orderNo\": \"Lothal-TTTT\",\n \"material\": \"Testing\",\n \"supplier\": \"S1\",\n \"trader\": \"T1\",\n \"consignee\": \"C1\",\n \"id\": \"Lothal-TTTT\"\n }\n}"}],"_postman_id":"2447ec88-0e38-432f-a8c2-67ab2f71c4fc"},{"name":"Get Order","id":"09a3cabd-395b-41b1-ab14-aa1310ff79ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/order?orderNo=&orderLineNo=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["api","v3","order"],"host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"query":[{"key":"orderNo","value":""},{"key":"orderLineNo","value":""}],"variable":[]}},"response":[],"_postman_id":"09a3cabd-395b-41b1-ab14-aa1310ff79ab"},{"name":"Update Order","id":"5319969c-7c0d-471c-907f-924b465dd6e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n}","options":{"raw":{"language":"json"}}},"url":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/order/update?orderNo=&orderLineNo","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["api","v3","order","update"],"host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"query":[{"key":"orderNo","value":""},{"key":"orderLineNo","value":null}],"variable":[]}},"response":[],"_postman_id":"5319969c-7c0d-471c-907f-924b465dd6e8"}],"id":"d16c2d77-49a5-4884-8626-f685e97a2257","description":"

This is a collection of api to perform action on order entity. The fields are configured for each api key by the Trames AM team, only those fields can be used for search, create or update operations.

\n","_postman_id":"d16c2d77-49a5-4884-8626-f685e97a2257","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}}},{"name":"TAT","item":[{"name":"Get TAT","id":"9b49fb10-089d-4fa7-9dba-40fc8de159e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/tat/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["api","v3","tat",":id"],"host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"9b49fb10-089d-4fa7-9dba-40fc8de159e7"}],"id":"fa5fb7c2-d390-43fa-8313-2f98436ae895","description":"

This is a collection of api to get the TAT data. The TAT fields are configured for each api key by the Trames AM team, only those fields will be available in response.

\n","_postman_id":"fa5fb7c2-d390-43fa-8313-2f98436ae895","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}}},{"name":"Shipment order link","item":[{"name":"Attach Orders to shipment","id":"9efd13f0-c377-45ae-b875-a5ee4df460f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ids\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/shipment-order-link/attach?shipmentId=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["api","v3","shipment-order-link","attach"],"host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"query":[{"key":"shipmentId","value":""}],"variable":[]}},"response":[],"_postman_id":"9efd13f0-c377-45ae-b875-a5ee4df460f1"},{"name":"Unattach Orders to shipment","id":"dd5832df-8313-41ea-a02d-0d092b118c34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ids\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net/api/v3/shipment-order-link/unattach?shipmentId=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["api","v3","shipment-order-link","unattach"],"host":["https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net"],"query":[{"key":"shipmentId","value":""}],"variable":[]}},"response":[],"_postman_id":"dd5832df-8313-41ea-a02d-0d092b118c34"}],"id":"576ad447-d56e-46b7-90ce-f3a3fa4ddf51","_postman_id":"576ad447-d56e-46b7-90ce-f3a3fa4ddf51","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}}}],"id":"19924876-e985-4bb4-9ad0-fffb6ad3b739","description":"

The Trames shipment API provides a suite of commands to manage documents associated with shipments within an organization. Using these commands, you can upload, retrieve, download, and delete documents for specific shipments. To upload a document, a curl command sends the file to the shipment identified by its ID. To retrieve a list of uploaded documents, a curl command fetches all files associated with the shipment, making it easy to track and manage them. To download a specific document, another curl command retrieves the file using the shipment ID and the document ID from a previous list. Lastly, to delete a document, a curl command removes the file from the shipment using its ID, keeping the document management system organized.

\n","_postman_id":"19924876-e985-4bb4-9ad0-fffb6ad3b739","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}}},{"name":"Search Shipments","id":"793a8cdd-b370-4952-99c0-f47afe2a2ff0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://lothal.sea.maz.trames.io//api/v1/shipments/search","description":"

This api is used to fetch all the shipments Ids for particular time interval.
i.e (createdAt or UpdatedAt)

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["","api","v1","shipments","search"],"host":["https://lothal.sea.maz.trames.io"],"query":[],"variable":[]}},"response":[{"id":"bc54bc9d-7838-4da2-bdf0-655d4fb90341","name":"Search by houseDocNo","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"houseDocNo\": {\n \"equals\": \"HF123456789\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://lothal.sea.maz.trames.io//api/v1/shipments/search"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"data\": {\r\n \"ids\": [\r\n \"SHIPMENT-4\",\r\n \"SHIPMENT-5\"\r\n ]\r\n },\r\n \"meta\": {\r\n \"pagination\": {\r\n \"moreDataAvailable\": false\r\n }\r\n }\r\n}"},{"id":"b1fb77cc-8ab0-492e-9ad6-60c7b8ca87df","name":"Search by masterDocNo","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"masterDocNo\": {\n \"equals\": \"MN123456789\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://lothal.sea.maz.trames.io//api/v1/shipments/search"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"ids\": [\n \"SHIPMENT-1\",\n \"SHIPMENT-2\",\n \"SHIPMENT-6\"\n ]\n },\n \"meta\": {\n \"pagination\": {\n \"moreDataAvailable\": false\n }\n }\n}"},{"id":"18f67236-8424-45c6-a62b-9ae988d36ec3","name":"Search all modified since X","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"lastUpsertedAt\": {\n \"gt\": \"2023-06-10T05:34:14.513Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://lothal.sea.maz.trames.io//api/v1/shipments/search"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"data\": {\r\n \"ids\": [\r\n \"SHIPMENT-1\",\r\n \"SHIPMENT-2\",\r\n \"SHIPMENT-3\",\r\n \"SHIPMENT-4\",\r\n \"SHIPMENT-5\",\r\n \"SHIPMENT-6\"\r\n ]\r\n },\r\n \"meta\": {\r\n \"pagination\": {\r\n \"moreDataAvailable\": false\r\n }\r\n }\r\n}"}],"_postman_id":"793a8cdd-b370-4952-99c0-f47afe2a2ff0"},{"name":"Update Shipment","id":"0e7cc7c5-862b-4d7d-8564-40d810b216c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://lothal.sea.maz.trames.io//api/v1/shipments/:id?templateId=","description":"

This api is used to Update certain fields in an shipment using the shipment id. Those fields are etdPOL, etaPOD , carrierScac, carrierName, masterDocNo, houseDocNo, bookingReferenceNo, additionalData.ManufacturerEstimatedDeliveryDate, additionalData.bookingFormReq, additionalData.bookingFormRcv, additionalData.bookingReqSent

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["","api","v1","shipments",":id"],"host":["https://lothal.sea.maz.trames.io"],"query":[{"key":"templateId","value":""}],"variable":[{"id":"8cfa4ca4-970e-4dcf-adc6-7e57acad4ed8","type":"any","value":"","key":"id"}]}},"response":[{"id":"e58319a6-91d4-4a0f-9127-886a63006441","name":"Update Shipment","originalRequest":{"method":"PUT","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"etdPOL\": \"2023-11-20T11:35:59.489Z\",\r\n \"etaPOD\": \"2023-12-20T11:35:59.489Z\",\r\n \"additionalData\": {\r\n \"ManufacturerEstimatedDeliveryDate\": \"2023-12-25T11:35:59.489Z\",\r\n \"bookingFormReq\": \"2023-04-13T17:00:00.000Z\",\r\n \"bookingFormRcv\": \"2023-04-13T17:00:00.000Z\",\r\n \"bookingReqSent\": \"2023-04-13T17:00:00.000Z\"\r\n },\r\n \"carrierScac\": \"QF\",\r\n \"carrierName\": \"Qantas Airways\",\r\n \"masterDocNo\": \"QF123456789\",\r\n \"houseDocNo\": \"HF123456789\",\r\n \"bookingReferenceNo\": \"BN123456789\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://lothal.sea.maz.trames.io//api/v1/shipments/:id?templateId=templateId1","host":["https://lothal.sea.maz.trames.io"],"path":["","api","v1","shipments",":id"],"query":[{"key":"templateId","value":"templateId1"}],"variable":[{"key":"id","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"data\": {\r\n \"shipper\": \"Shipper\",\r\n \"consignee\": \"Consignee\",\r\n \"POL\": \"POL\",\r\n \"POD\": \"POD\",\r\n \"etdPOL\": \"2023-04-08T17:00:00.000Z\",\r\n \"etaPOD\": \"2023-04-13T17:00:00.000Z\",\r\n \"entityId\": \"id\",\r\n \"additionalData\": {\r\n \"addGrossWeight\": 0,\r\n \"grossVolume\": 0,\r\n \"equipmentValue\": 0,\r\n \"incoterms\": \"\",\r\n \"Manufacturer\": \"\",\r\n \"ManufacturerEstimatedDeliveryDate\": \"2023-04-13T17:00:00.000Z\",\r\n \"bookingFormReq\": \"2023-04-13T17:00:00.000Z\",\r\n \"bookingFormRcv\": \"2023-04-13T17:00:00.000Z\",\r\n \"cargoReadyDate\": \"2023-04-13T17:00:00.000Z\",\r\n \"bookingReqSent\": \"2023-04-13T17:00:00.000Z\",\r\n },\r\n \"grossVolume\": \"12.77 CBM\",\r\n \"description\": \"Description\",\r\n \"carrierScac\": \"CarrierScac\",\r\n \"carrierName\": \"CarrierName\",\r\n \"masterDocNo\": \"MBL\",\r\n \"houseDocNo\": \"HBL\",\r\n \"bookingReferenceNo\": \"BKC\",\r\n \"transportMethod\": \"air\"\r\n }\r\n}"}],"_postman_id":"0e7cc7c5-862b-4d7d-8564-40d810b216c9"},{"name":"Details Shipment(s)","id":"1095adf8-abc5-4978-8042-536c39e1b27f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://lothal.sea.maz.trames.io//api/v1/shipments?ids=&templateId=","description":"

This Api is used to get the shipments details using the ids fetched from the before api (Search API).

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"ce727706-73fe-4ecd-8156-75c6b704272d","id":"ce727706-73fe-4ecd-8156-75c6b704272d","name":"Lothal","type":"collection"}},"urlObject":{"path":["","api","v1","shipments"],"host":["https://lothal.sea.maz.trames.io"],"query":[{"key":"ids","value":""},{"key":"templateId","value":""}],"variable":[]}},"response":[{"id":"c3f6f66d-a05d-4079-9a1e-ab369c3984e6","name":"GET one shipment","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://lothal.sea.maz.trames.io//api/v1/shipments?ids=id1&templateId=templateId1","host":["https://lothal.sea.maz.trames.io"],"path":["","api","v1","shipments"],"query":[{"key":"ids","value":"id1"},{"key":"templateId","value":"templateId1"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"data\": [\r\n {\r\n \"shipper\": \"Shipper\",\r\n \"consignee\": \"Consignee\",\r\n \"POL\": \"POL\",\r\n \"POD\": \"POD\",\r\n \"etdPOL\": \"2023-04-08T17:00:00.000Z\",\r\n \"etaPOD\": \"2023-04-13T17:00:00.000Z\",\r\n \"entityId\": \"id1\",\r\n \"additionalData\": {\r\n \"addGrossWeight\": 0,\r\n \"grossVolume\": 0,\r\n \"equipmentValue\": 0,\r\n \"incoterms\": \"\",\r\n \"Manufacturer\": \"\",\r\n \"ManufacturerEstimatedDeliveryDate\": \"2023-04-13T17:00:00.000Z\",\r\n \"bookingFormReq\": null,\r\n \"bookingFormRcv\": null,\r\n \"cargoReadyDate\": \"2023-04-13T17:00:00.000Z\",\r\n \"bookingReqSent\": null\r\n },\r\n \"grossVolume\": \"12.77 CBM\",\r\n \"description\": \"Description\",\r\n \"carrierScac\": \"CarrierScac\",\r\n \"carrierName\": \"CarrierName\",\r\n \"masterDocNo\": \"MBL\",\r\n \"houseDocNo\": \"HBL\",\r\n \"bookingReferenceNo\": \"BKC\",\r\n \"transportMethod\": \"air\"\r\n }\r\n ]\r\n}"},{"id":"1bb424d7-d463-4dbf-b58b-0a6f139d2e08","name":"GET multiple shipments","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"groupId","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://lothal.sea.maz.trames.io//api/v2/shipments?ids=id1,id2,id3&templateId=templateId1","host":["https://lothal.sea.maz.trames.io"],"path":["","api","v2","shipments"],"query":[{"key":"ids","value":"id1,id2,id3"},{"key":"templateId","value":"templateId1"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"shipper\": \"Shipper\",\n \"consignee\": \"Consignee\",\n \"POL\": \"POL\",\n \"POD\": \"POD\",\n \"etdPOL\": \"2023-04-08T17:00:00.000Z\",\n \"etaPOD\": \"2023-04-13T17:00:00.000Z\",\n \"entityId\": \"id1\",\n \"additionalData\": {\n \"addGrossWeight\": 0,\n \"grossVolume\": 0,\n \"equipmentValue\": 0,\n \"incoterms\": \"\",\n \"Manufacturer\": \"\",\n \"ManufacturerEstimatedDeliveryDate\": \"2023-04-13T17:00:00.000Z\",\n \"bookingFormReq\": null,\n \"bookingFormRcv\": null,\n \"cargoReadyDate\": \"2023-04-13T17:00:00.000Z\",\n \"bookingReqSent\": null\n },\n \"grossVolume\": \"12.77 CBM\",\n \"description\": \"Description\",\n \"carrierScac\": \"CarrierScac\",\n \"carrierName\": \"CarrierName\",\n \"masterDocNo\": \"MBL\",\n \"houseDocNo\": \"HBL\",\n \"bookingReferenceNo\": \"BKC\",\n \"transportMethod\": \"air\"\n },\n {\n \"shipper\": \"Shipper\",\n \"consignee\": \"Consignee\",\n \"POL\": \"POL\",\n \"POD\": \"POD\",\n \"etdPOL\": \"2023-04-08T17:00:00.000Z\",\n \"etaPOD\": \"2023-04-13T17:00:00.000Z\",\n \"entityId\": \"id2\",\n \"additionalData\": {\n \"addGrossWeight\": 0,\n \"grossVolume\": 0,\n \"equipmentValue\": 0,\n \"incoterms\": \"\",\n \"Manufacturer\": \"\",\n \"ManufacturerEstimatedDeliveryDate\": \"2023-04-13T17:00:00.000Z\",\n \"bookingFormReq\": null,\n \"bookingFormRcv\": null,\n \"cargoReadyDate\": \"2023-04-13T17:00:00.000Z\",\n \"bookingReqSent\": null\n },\n \"grossVolume\": \"12.77 CBM\",\n \"description\": \"Description\",\n \"carrierScac\": \"CarrierScac\",\n \"carrierName\": \"CarrierName\",\n \"masterDocNo\": \"MBL\",\n \"houseDocNo\": \"HBL\",\n \"bookingReferenceNo\": \"BKC\",\n \"transportMethod\": \"air\"\n },\n {\n \"shipper\": \"Shipper\",\n \"consignee\": \"Consignee\",\n \"POL\": \"POL\",\n \"POD\": \"POD\",\n \"etdPOL\": \"2023-04-08T17:00:00.000Z\",\n \"etaPOD\": \"2023-04-13T17:00:00.000Z\",\n \"entityId\": \"id3\",\n \"additionalData\": {\n \"addGrossWeight\": 0,\n \"grossVolume\": 0,\n \"equipmentValue\": 0,\n \"incoterms\": \"\",\n \"Manufacturer\": \"\",\n \"ManufacturerEstimatedDeliveryDate\": \"2023-04-13T17:00:00.000Z\",\n \"bookingFormReq\": null,\n \"bookingFormRcv\": null,\n \"cargoReadyDate\": \"2023-04-13T17:00:00.000Z\",\n \"bookingReqSent\": null\n },\n \"grossVolume\": \"12.77 CBM\",\n \"description\": \"Description\",\n \"carrierScac\": \"CarrierScac\",\n \"carrierName\": \"CarrierName\",\n \"masterDocNo\": \"MBL\",\n \"houseDocNo\": \"HBL\",\n \"bookingReferenceNo\": \"BKC\",\n \"transportMethod\": \"air\"\n }\n ]\n}"}],"_postman_id":"1095adf8-abc5-4978-8042-536c39e1b27f"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"721dd6c9-3bbb-4642-baf2-9cc12e6c5732","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4484c656-df24-4854-8fc2-7abcfa284f5e","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://lothal.sea.maz.trames.io","type":"string"},{"key":"groupId","value":"","type":"string"},{"key":"orgId","value":"","type":"string"},{"key":"apiKey","value":"","type":"string"},{"key":"baseUrlV3","value":"https://lothal-sea-prod-cwh7gbdzhvgbahf4.southeastasia-01.azurewebsites.net","type":"string"}]}