The IdToken is used for Authorization & Authentication and will expire within one hour. The RefreshToken is used to retrieve another IdToken instead of passing credentials to the server.
\nA refresh token will last one month.
\nBasic authentication is a simple authentication scheme built into the HTTP protocol. The client sends HTTP requests with the Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.
For example, to authorize as demo / p@55w0rd the client would send in {token} the value of ZGVtbzpwQDU1dzByZA==
Authorization: Basic {token}
If you are doing this in Postman selecting Basic Auth and entering your username and password will automatically generate this header.
The Postman collection has been configured to update the environment variable Authorization with the IdToken returned by this request.
You may only make requests relevant to data that is associated with parties you have permissions for.
For example, to POST a loadplan for the shipper TQGBDEMOA, you must have the TQGBDEMOA permission to do so.
You can see what parties you have permissions for by using the /permissions endpoint.
Before making requests you need to authorise and exchange your username and password for an IdToken that can be passed in subsequent requests.
The token will expire after 60 minutes.
\nYou can use the RefreshToken (which expires after 1 month).
To refresh: send a POST request to the getToken endpoint with the header refresh_token.
Use the loadingReference path parameter to specify the reference of the loadplan(s) you would like retrieved.
Number of relevant loadplans to be returned\n(Optional)\ndefault: 250\neg: 10
\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"Identifier of party that loadplan(s) concern\n(Optional)\ndefault: NONE\neg: TQGBDEMOA (example EORI)
\n","type":"text/plain"},"key":"organizationId","value":"GB220861924000"},{"disabled":true,"description":{"content":"Order of scheduled load datetime of retrieved loadplans\n(Optional)\nenum: asc, desc\ndefault: asc\neg: desc
\n","type":"text/plain"},"key":"order","value":""}],"variable":[{"description":{"content":"Loading reference\n(Mandatory)\neg: LR-12345
\n","type":"text/plain"},"type":"any","value":"2603544","key":"loadingReference"}]}},"response":[{"id":"005950a3-e49b-4ba1-a468-bbc89b7c8dd7","name":"200 response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byLoadingReference/:loadingReference","path":["loads","byLoadingReference",":loadingReference"],"variable":[{"key":"loadingReference","value":"LR-12345","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"472e7c63-5765-41fc-a812-b81a28ab9088","name":"200 response (no loadplans)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byLoadingReference/:loadingReference","path":["loads","byLoadingReference",":loadingReference"],"variable":[{"key":"loadingReference","value":"LR-XXXXX"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[]"},{"id":"2d3acf3e-5a02-4968-8bff-bd5dce479022","name":"200 response (multiple-permissions)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byLoadingReference/:loadingReference?organizationId=TQGBDEMOA","path":["loads","byLoadingReference",":loadingReference"],"query":[{"key":"organizationId","value":"TQGBDEMOA"}],"variable":[{"key":"loadingReference","value":"LR-12345","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"b17a457f-95d0-4e13-a927-c16d785c48cf","name":"200 response (multiple-loadplans)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byLoadingReference/:loadingReference","path":["loads","byLoadingReference",":loadingReference"],"variable":[{"key":"loadingReference","value":"LR-12345","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n },\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n },\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"8f909189-e70c-4ab4-806d-88f5d5ed0f18","name":"200 response (limited-loadplans)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byLoadingReference/:loadingReference?limit=2","path":["loads","byLoadingReference",":loadingReference"],"query":[{"key":"limit","value":"2"}],"variable":[{"key":"loadingReference","value":"LR-12345","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n },\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"c0452a08-6596-4e57-abf2-11e239cb2cee","name":"403 response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."}],"url":{"raw":"/loads/byLoadingReference/:loadingReference","host":[""],"path":["loads","byLoadingReference",":loadingReference"],"variable":[{"key":"loadingReference","value":"LR-12345","description":"(Required) "}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"5ec601e0-9931-4e12-b5c1-4a895ace5a2b","name":"403 response (multiple-permissions)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."}],"url":{"raw":"/loads/byLoadingReference/:loadingReference","host":[""],"path":["loads","byLoadingReference",":loadingReference"],"variable":[{"key":"loadingReference","value":"LR-12345","description":"(Required)"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Missing organizationId Query String\"\n}"},{"id":"8842885f-065f-4ff6-9798-e02c420f47a9","name":"500 response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."}],"url":{"raw":"/loads/byLoadingReference/:loadingReference","host":[""],"path":["loads","byLoadingReference",":loadingReference"],"variable":[{"key":"loadingReference","value":"LR-12345","description":"(Required) "}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Internal Server Error\"\n}"}],"_postman_id":"6d44013b-8999-48a7-985e-c8bff1b5f694"},{"name":"/loads/byDate/:date","id":"4922bd2d-25ba-4cb3-b402-79daee6fb71e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{Authorization}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"pagination-token","value":"ZXhhbXBsZQo=","type":"text"}],"url":"/loads/byDate/:date","description":"Use the date path parameter to specify the scheduled loading date of the loadplan(s) you would like retrieved.
Number of relevant loadplans to be returned\n(Optional)\ndefault: 250\neg: 10
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Identifier of party that loadplan(s) concern\n(Optional)\ndefault: NONE\neg: TQGBDEMOA (example EORI)
\n","type":"text/plain"},"key":"organizationId","value":""},{"disabled":true,"description":{"content":"Order of scheduled load datetime of retrieved loadplans\n(Optional)\nenum: asc, desc\ndefault: asc\neg: desc
\n","type":"text/plain"},"key":"order","value":null}],"variable":[{"description":{"content":"Scheduled date of loading\n(Mandatory)\neg: 2023-01-01
\n","type":"text/plain"},"type":"any","value":"","key":"date"}]}},"response":[{"id":"24232e10-dd08-45b8-8b99-917427913940","name":"200 response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byDate/:date","path":["loads","byDate",":date"],"variable":[{"key":"date","value":"2023-01-01","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"02d2fb0a-43c9-4e2a-ad5a-7e231c6e216f","name":"200 response (no loadplans)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byDate/:date","path":["loads","byDate",":date"],"variable":[{"key":"date","value":"2023-01-01","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[]"},{"id":"04181a90-d706-47d2-8362-60e7c7bd8781","name":"200 response (multiple-permissions)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byDate/:date?organizationId=TQGBDEMOA","path":["loads","byDate",":date"],"query":[{"key":"organizationId","value":"TQGBDEMOA"}],"variable":[{"key":"date","value":"2023-01-01","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"d42b1ce6-87fb-4cff-915d-eb0e9360d631","name":"200 response (multiple-loadplans)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byDate/:date","path":["loads","byDate",":date"],"variable":[{"key":"date","value":"2023-01-01","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n },\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n },\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"adaf0dcb-79a1-485c-ace8-9562dcd14cf2","name":"200 response (limited-loadplans)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byDate/:date?limit=2","path":["loads","byDate",":date"],"query":[{"key":"limit","value":"2","type":"text"}],"variable":[{"key":"date","value":"2023-01-01","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n },\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"fa7f3d0a-f67e-48e7-9171-e51f885b4c3f","name":"200 response (ordered-loadplans)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byDate/:date?order=asc","path":["loads","byDate",":date"],"query":[{"key":"order","value":"asc"}],"variable":[{"key":"date","value":"2023-01-01","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {\n \"scheduledLoadingTransportEvent\": \"2023-01-01T12:00:00\",\n ...\n },\n ...\n },\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {\n \"scheduledLoadingTransportEvent\": \"2023-01-01T13:00:00\",\n ...\n },\n ...\n },\n\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {\n \"scheduledLoadingTransportEvent\": \"2023-01-01T14:00:00\",\n ...\n },\n ...\n }\n]"},{"id":"2112abbc-a394-4d4e-8931-577f240899a0","name":"403 response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Use the weekNo path parameter to specify the ISO week number of the scheduled loading date of the loadplan(s) you would like retrieved.
For example, week number 1 specifies the first week of the year. Week number 52 (or 53) specifies the last week of the year.
The status of retrieved loads can also be specified using the status query parameter. This can be set to OPEN to retrieve all loadplans that have yet to be loaded. And COMPLETED for all loadplans that have already been loaded. If not provided, all relevant OPEN and COMPLETED loads will be retrieved.
The year query parameter can be used to specify the year in which the load is scheduled to take place. For example 2023. The default is the current year.
Status of loadplan\n(Optional)\ndefault: OPEN & COMPLETED\nenum: OPEN, COMPLETED\neg: OPEN
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"Scheduled year of loading\n(Optional)\ndefault: \neg: 2023
\n","type":"text/plain"},"key":"year","value":""},{"disabled":true,"description":{"content":"Number of relevant loadplans to be returned\n(Optional)\ndefault: 250\neg: 10
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Identifier of party that loadplan(s) concern\n(Optional)\ndefault: NONE\neg: TQGBDEMOA (example EORI)
\n","type":"text/plain"},"key":"organizationId","value":""},{"disabled":true,"description":{"content":"Order of scheduled load datetime of retrieved loadplans\n(Optional)\nenum: asc, desc\ndefault: asc\neg: desc
\n","type":"text/plain"},"key":"order","value":null}],"variable":[{"description":{"content":"Scheduled (ISO) week number of loading\n(Mandatory)\nInteger in [0, 54)\neg: 5
\n","type":"text/plain"},"type":"any","value":"","key":"weekNo"}]}},"response":[{"id":"41390d1c-e760-4e55-9995-02d7a2f7e0c9","name":"200 response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byWeekNo/:weekNo","path":["loads","byWeekNo",":weekNo"],"variable":[{"key":"weekNo","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"0faa2826-41c7-435c-9230-c373eb89f949","name":"200 response (no loadplans)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byWeekNo/:weekNo","path":["loads","byWeekNo",":weekNo"],"variable":[{"key":"weekNo","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[]"},{"id":"433d2838-6884-4d73-8fe8-00b78ba86fbd","name":"200 response (multiple-permissions)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byWeekNo/:weekNo?organizationId=TQGBDEMOA","path":["loads","byWeekNo",":weekNo"],"query":[{"key":"organizationId","value":"TQGBDEMOA","type":"text"}],"variable":[{"key":"weekNo","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"306d7f98-c40d-4708-8dc3-7ca264a42ef3","name":"200 response (multiple-loadplans)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byWeekNo/:weekNo","path":["loads","byWeekNo",":weekNo"],"variable":[{"key":"weekNo","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n },\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n },\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"fd74d4dd-c09c-4516-93fd-5ccdc5e7dc50","name":"200 response (limited-loadplans)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byWeekNo/:weekNo?limit=2","path":["loads","byWeekNo",":weekNo"],"query":[{"key":"limit","value":"2","type":"text"}],"variable":[{"key":"weekNo","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n },\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"b0c29e5f-ef86-4587-ade5-500cea5d0aed","name":"200 response (ordered-loadplans) Copy","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byWeekNo/:weekNo?order=asc","path":["loads","byWeekNo",":weekNo"],"query":[{"key":"order","value":"asc"}],"variable":[{"key":"weekNo","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {\n \"scheduledLoadingTransportEvent\": \"2023-01-01T12:00:00\",\n ...\n },\n ...\n },\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {\n \"scheduledLoadingTransportEvent\": \"2023-01-01T13:00:00\",\n ...\n },\n ...\n },\n\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {\n \"scheduledLoadingTransportEvent\": \"2023-01-01T14:00:00\",\n ...\n },\n ...\n }\n]"},{"id":"ede749fb-bfdc-45f9-b16c-f2f30544706b","name":"403 response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Use the containerNumber path parameter to specify the reference number of the equipment used to transport the load(s).
Number of relevant loadplans to be returned\n(Optional)\ndefault: 250\neg: 10
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Identifier of party that loadplan(s) concern\n(Optional)\ndefault: NONE\neg: TQGBDEMOA (example EORI)
\n","type":"text/plain"},"key":"organizationId","value":""},{"disabled":true,"description":{"content":"Order of scheduled load datetime of retrieved loadplans\n(Optional)\nenum: asc, desc\ndefault: asc\neg: desc
\n","type":"text/plain"},"key":"order","value":""}],"variable":[{"description":{"content":"Reference number of equipment used in load\n(Mandatory)\neg: YMLU8877936
\n","type":"text/plain"},"type":"any","value":"","key":"containerNumber"}]}},"response":[{"id":"c72fa137-e59a-42f6-ae03-9c748ed0e19e","name":"200 response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byContainerNumber/:containerNumber","host":[""],"path":["loads","byContainerNumber",":containerNumber"],"variable":[{"key":"containerNumber","value":"YMLU8877936"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"a87194f8-8724-49cb-b676-d1f2f7072241","name":"200 response (no loadplans)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byContainerNumber/:containerNumber","host":[""],"path":["loads","byContainerNumber",":containerNumber"],"variable":[{"key":"containerNumber","value":"YMLU8877936"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[]"},{"id":"5986e6af-d4c2-43c7-b188-daf9b781d196","name":"200 response (multiple-permissions)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byContainerNumber/:containerNumber?organizationId=TQGBDEMOA","host":[""],"path":["loads","byContainerNumber",":containerNumber"],"query":[{"key":"organizationId","value":"TQGBDEMOA"}],"variable":[{"key":"containerNumber","value":"YMLU8877936"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"3a0883b4-9272-449e-b314-b55959ea4493","name":"200 response (multiple-loadplans)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byContainerNumber/:containerNumber","host":[""],"path":["loads","byContainerNumber",":containerNumber"],"variable":[{"key":"containerNumber","value":"YMLU8877936"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n },\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n },\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"7d926caa-c10d-40d2-a9a8-6e4767ee7c82","name":"200 response (limited-loadplans)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byContainerNumber/:containerNumber?limit=2","host":[""],"path":["loads","byContainerNumber",":containerNumber"],"query":[{"key":"limit","value":"2","type":"text"}],"variable":[{"key":"containerNumber","value":"YMLU8877936"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n },\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {...},\n ...\n }\n]"},{"id":"d3284178-c7cd-4d55-8f3e-a2f4490cc4e1","name":"200 response (ordered-loadplans)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"eyJraWQ...."},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"/loads/byContainerNumber/:containerNumber?order=asc","host":[""],"path":["loads","byContainerNumber",":containerNumber"],"query":[{"key":"order","value":"asc"}],"variable":[{"key":"containerNumber","value":"YMLU8877936"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Access-Control-Allow-Origin","value":"commodo est","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {\n \"scheduledLoadingTransportEvent\": \"2023-01-01T12:00:00\",\n ...\n },\n ...\n },\n {\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {\n \"scheduledLoadingTransportEvent\": \"2023-01-01T13:00:00\",\n ...\n },\n ...\n },\n\n \"shipper\": {...},\n \"consignee\": {...},\n \"customs\": {...},\n \"carrier\": {...},\n \"haulier\": {...},\n \"loadingSite\": {...},\n \"references\": {...},\n \"dates\": {\n \"scheduledLoadingTransportEvent\": \"2023-01-01T14:00:00\",\n ...\n },\n ...\n }\n]"},{"id":"6f58f725-4d0e-42ad-9994-e8776e340a88","name":"403 response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Use this endpoint to retrieve all loadplans relevant to your permissions.
\n","urlObject":{"path":["loads"],"host":[""],"query":[{"disabled":true,"description":{"content":"Number of relevant loadplans to be returned\n(Optional)\ndefault: 250\neg: 10
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Status of loadplan\n(Optional)\ndefault: OPEN & COMPLETED\nenum: OPEN, COMPLETED\neg: OPEN
\n","type":"text/plain"},"key":"status","value":"OPEN"},{"disabled":true,"description":{"content":"Order of scheduled load datetime of retrieved loadplans\n(Optional)\nenum: asc, desc\ndefault: asc\neg: desc
\n","type":"text/plain"},"key":"order","value":"desc"},{"disabled":true,"description":{"content":"Identifier of party that loadplan(s) concern\n(Optional)\ndefault: NONE\neg: TQGBDEMOA (example EORI)
\n","type":"text/plain"},"key":"organizationId","value":"GB594290217000"}],"variable":[]}},"response":[{"id":"46c46c5d-38d6-4f11-8405-9f3e48cfc2d5","name":"200 response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Load plans are provided by shippers for planned loads at any given Traqa-enabled site.
\nDetails on loadplan(s) can be retrieved using the following GET endpoints.
The number of loadplans retrieved can be limited using the limit query parameter.
For requestors with multiple permissions, the organizationId query parameter is mandatory.
The order query parameter can be used to order retrieved loadplans by the date they are scheduled to be loaded.
The requestor will receive all loadplans relevant to their query and permissions.
\nFor example:
\nShipper TQGBDEMOA posts loadplan LR-12345.
A requestor with permissions for TQGBDEMOA uses these endpoints to request details for LR-12345, they will retrieve the details of this loadplan.
A requestor who does NOT have permissions for TQGBDEMOA or the relevant loadsite will NOT retrieve details of the loadplan.
Load sites provide the weights from their weighbridge software to Traqa for given load plans
\n","_postman_id":"fc3aa03d-34b4-47f1-99d1-4d9d2a273cdd"},{"name":"Documents","item":[{"name":"weighbridge Certificate","item":[{"name":"{loading Reference}","item":[{"name":"/documents/weighbridgeCertificate/:loadingReference","id":"05c7f55c-c46a-4c9f-a1a8-d2a8d821d740","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{Authorization}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"/documents/weighbridgeCertificate/:loadingReference","urlObject":{"path":["documents","weighbridgeCertificate",":loadingReference"],"host":[""],"query":[],"variable":[{"id":"ae019fb1-d565-4aba-ab1e-a6fd22cf9feb","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"commodo est","key":"loadingReference"}]}},"response":[{"id":"ba4f409d-ec6f-4e91-b8ef-95e36e6fa3d2","name":"200 response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"commodo est","key":"loadingReference"},{"id":"f9a5b8be-9a87-439b-b288-6e4b0399d8f4","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"commodo est","key":"shipperOrganizationId"}]}},"response":[{"id":"3775c3c6-72d1-4e59-89ff-0024d863843a","name":"200 response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"commodo est","key":"loadingReference"}]}},"response":[{"id":"131c6268-f2ce-483a-8fea-e677c45df28d","name":"200 response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"commodo est","key":"loadingReference"},{"id":"b006c11f-c511-4a71-8fe8-42567e2a7e54","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"commodo est","key":"shipperOrganizationId"}]}},"response":[{"id":"8fe856e5-c2e9-44be-9023-0df209fa7311","name":"200 response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Produce a copy of the Annex VII BEFORE the load is completed, this 'Pre Annex VII' and maybe used for checking the Annex VII prior to loading or as manual fallback for completion of the Annex VII if required.
\n","urlObject":{"path":["documents","preAnnexvii"],"host":[""],"query":[{"key":"LoadingReference","value":"{{LoadingReference}}"}],"variable":[]}},"response":[{"id":"73b0cb50-eea8-4a3b-a388-1a698f9ae88d","name":"200 response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Traqa produces documents for regulatory and compliance purposes and to facilitate the transportation of goods.
\n","_postman_id":"79ebce0a-acd6-4883-bac1-4e8e912b849a"},{"name":"Loading Photos","item":[{"name":"by Loading Reference/{loading Reference}","item":[{"name":"/photos/byLoadingReference/:loadingReference","id":"e5e05f23-1634-4830-89e2-062b09a7f8f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{Authorization}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/photos/byLoadingReference/:loadingReference","urlObject":{"path":["photos","byLoadingReference",":loadingReference"],"host":[""],"query":[],"variable":[{"description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"{{loa","key":"loadingReference"}]}},"response":[{"id":"4f365578-683f-43a2-9d6f-f35c9c1c55da","name":"200 response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"commodo est","key":"loadingReference"}]}},"response":[{"id":"3c0e492e-3d72-4303-8859-7337b7693271","name":"200 response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"commodo est","key":"loadingReference"},{"id":"0b7ad2e1-06cc-4328-afd2-b08b57ea61f9","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"commodo est","key":"shipperOrganizationId"}]}},"response":[{"id":"3b0657c6-0d58-4c10-aef5-0873c73f1e53","name":"200 response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Loading Photos are captured and stored against the load plans in Traqa
\n","_postman_id":"fc1e3b4e-3969-4368-a9d6-6a07ebe7089c"}],"event":[{"listen":"prerequest","script":{"id":"86b740bc-1f26-44de-a6d1-8e070f35adc5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2048e070-4a50-455a-ab01-c929abcd5ac4","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"","type":"string"},{"key":"basePath","value":"","type":"string"}]}