{"id":3278,"date":"2021-07-14T12:25:49","date_gmt":"2021-07-14T10:25:49","guid":{"rendered":"https:\/\/www.trans.eu\/api\/?p=3278"},"modified":"2025-12-29T10:55:18","modified_gmt":"2025-12-29T09:55:18","slug":"list-of-archived-orders-received","status":"publish","type":"post","link":"https:\/\/www.trans.eu\/api\/orders\/getting-lists-orders\/list-of-archived-orders-received\/","title":{"rendered":"List of archived orders received"},"content":{"rendered":"\n<p>Allows to access list of received trans\u00adport orders which have been already archived.<\/p>\n\n\n\n<!--more-->\n\n\n\n<h2 class=\"wp-block-heading\">Url parameters and connection settings<\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>URL:<\/strong> https:\/\/api.platform.trans.eu<\/li>\n\n\n\n<li><strong>End\u00adpoint:<\/strong> \/ex\u00adt\/orders-api\/v1\/archive-orders-received<\/li>\n\n\n\n<li><strong>Method:<\/strong> GET<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">Headers:<\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Con\u00adtent-type: application\/json<\/li>\n\n\n\n<li>Accept: application\/json<\/li>\n\n\n\n<li>Autho\u00adriza\u00adtion: Bear\u00ader {access_token}<\/li>\n\n\n\n<li>Api-key: {unique_ap\u00adp_api-key}<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">Authorization and access<\/h2>\n\n\n\n<p>Autho\u00adriza\u00adtion process <a href=\"https:\/\/www.trans.eu\/api\/general-information\/authorization-process\/\" target=\"_blank\" rel=\"noopener\" title>is described here<\/a>. Each API request must also con\u00adsist of unique Api-key obtained dur\u00ading appli\u00adca\u00adtion reg\u00adis\u00adtra\u00adtion togeth\u00ader with client_id and client_secret.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Order<\/h2>\n\n\n\n<p>Details of order para\u00adme\u00adters, data range and descrip\u00adtion can be found <a href=\"https:\/\/www.trans.eu\/api\/orders\/orders-description\/\" target=\"_blank\" rel=\"noopener\">here<\/a>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Available filters<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">List of available filters<\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li>has attach\u00adments (?fil\u00adter<span data-offset-key=\"acp32-1-0\">=<\/span><span data-offset-key=\"acp32-2-0\">{\u201chas_attachments\u201d: true})<br><\/span><\/li>\n\n\n\n<li>load\u00ading place postal code (?filter={\u201cloading_place.postal_code\u201d: {\u201c$regex\u201d: \u201c5.*\u201d}})<\/li>\n\n\n\n<li>load\u00ading place city (<span data-offset-key=\"csmbi-1-0\">?fil\u00adter=<\/span><span data-offset-key=\"csmbi-2-0\">{\u201cloading_place.locality\u201d: \u201cWro\u00adclaw\u201d}<\/span>)<\/li>\n\n\n\n<li>load\u00ading place coun\u00adtry (?filter={\u201cloading_place.country\u201d: {\u201c$eq\u201d: \u201cPL\u201d}})<\/li>\n\n\n\n<li>load\u00ading place date (<span data-offset-key=\"csmbi-1-0\">?fil\u00adter=<\/span><span data-offset-key=\"csmbi-2-0\">{\u201cloading_place.date\u201d:{\u201c$gte\u201d: \u201c2020\u201309-16T15:00:00.000Z\u201d, \u201c$lte\u201d: \u201c2020\u201312-31T15:00:00.000Z\u201d}<\/span><span data-offset-key=\"csmbi-3-0\">}<\/span>)<\/li>\n\n\n\n<li>unload\u00ading place postal code (?filter={\u201cunloading_place.postal_code\u201d: {\u201c$regex\u201d: \u201c53.*\u201d}})<\/li>\n\n\n\n<li>unload\u00ading place city (<span data-offset-key=\"csmbi-1-0\">?fil\u00adter=<\/span><span data-offset-key=\"csmbi-2-0\">{\u201cunloading_place.locality\u201d: {\u201c$regex\u201d: \u201cWro.*\u201d}}<\/span>)<\/li>\n\n\n\n<li>unload\u00ading place coun\u00adtry (?filter={\u201cunloading_place.country\u201d: {\u201c$eq\u201d: \u201cPL\u201d}})<\/li>\n\n\n\n<li>unload\u00ading place date (<span data-offset-key=\"csmbi-1-0\">?fil\u00adter=<\/span><span data-offset-key=\"csmbi-2-0\">{\u201cunloading_place.date\u201d:{\u201c$gte\u201d: \u201c2020\u201309-16T15:00:00.000Z\u201d}<\/span><span data-offset-key=\"csmbi-3-0\">}<\/span>)<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\">Sort by<\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li>num\u00adber (?sortBy=number&amp;order=asc)<\/li>\n\n\n\n<li>cre\u00adation date (?sortBy=created_at&amp;order=asc)<\/li>\n\n\n\n<li>archiv\u00ading date (?sortBy=archived_at&amp;order=desc)<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">Search<\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li><span data-offset-key=\"csmbi-1-0\">freight ref\u00ader\u00adence num\u00adber (?search=<\/span><span data-offset-key=\"csmbi-2-0\">{\u201creference_number\u201d:\u201cFR\/2021\/03\/08\/IZO8\u201d})<\/span><\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">Paging<\/h2>\n\n\n\n<p>The returned results are pag\u00adi\u00adnat\u00aded, with a max\u00adi\u00admum of 30 per page.<br>When call\u00ading GET method, page should be added as para\u00adme\u00adter in the URL, for exam\u00adple:<\/p>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-html\" data-lang=\"HTML\"><code>https:\/\/api.platform.trans.eu\/ext\/orders-api\/v1\/archive-orders-created?page=4<\/code><\/pre><\/div>\n\n\n\n<h2 class=\"wp-block-heading\">Json example<\/h2>\n\n\n\n<p>List of orders con\u00adtain\u00ading one enti\u00adty, each addi\u00adtion\u00adal enti\u00adty will repeat sim\u00adi\u00adlar pay\u00adload struc\u00adture<\/p>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-json\" data-lang=\"JSON\"><code>{\n  \"orders-archive\": [\n    {\n      \"archived_at\": \"2021-07-13T00:00:32.327Z\",\n      \"attachments\": [],\n      \"created_at\": \"2021-03-15T11:35:09.575Z\",\n      \"driver\": null,\n      \"freight\": {\n        \"carrier\": {\n          \"assignee\": null,\n          \"legal_name\": \"FirmaTestowa\",\n          \"vat_id\": \"11111111111\"\n        },\n        \"id\": null,\n        \"reference_number\": null,\n        \"shipper\": {\n          \"assignee\": {\n            \"account_id\": 749989,\n            \"family_name\": \"Kowalski\",\n            \"given_name\": \"Jan\",\n            \"trans_id\": \"1007374-1\"\n          },\n          \"legal_name\": \"Firma Testowa 2\",\n          \"vat_id\": \"22222222222\"\n        },\n        \"spots\": [\n          {\n            \"description\": null,\n            \"name\": null,\n            \"operations\": [\n              {\n                \"loads\": [],\n                \"operation_order\": 1,\n                \"time_window\": null,\n                \"time_window_reason\": null,\n                \"timespans\": {\n                  \"begin\": \"2021-03-18T11:35:07.000Z\",\n                  \"end\": \"2021-03-18T13:35:07.000Z\"\n                },\n                \"type\": \"loading\"\n              }\n            ],\n            \"place\": {\n              \"address\": {\n                \"country\": \"pl\",\n                \"description\": null,\n                \"locality\": \"Krak\u00f3w\",\n                \"number\": \"12\",\n                \"postal_code\": \"31-008\",\n                \"street\": \"Stara\"\n              },\n              \"coordinates\": {\n                \"latitude\": 50.06143,\n                \"longitude\": 19.93658\n              }\n            },\n            \"spot_order\": 1\n          },\n          {\n            \"description\": null,\n            \"name\": null,\n            \"operations\": [\n              {\n                \"loads\": [],\n                \"operation_order\": 1,\n                \"time_window\": null,\n                \"time_window_reason\": null,\n                \"timespans\": {\n                  \"begin\": \"2021-03-21T11:35:07.000Z\",\n                  \"end\": \"2021-03-21T13:35:07.000Z\"\n                },\n                \"type\": \"unloading\"\n              }\n            ],\n            \"place\": {\n              \"address\": {\n                \"country\": \"pl\",\n                \"description\": null,\n                \"locality\": \"D\u0105browa\u015arodkowa\",\n                \"number\": \"34\",\n                \"postal_code\": \"59-330\",\n                \"street\": \"\u015arednia\"\n              },\n              \"coordinates\": {\n                \"latitude\": 51.41828,\n                \"longitude\": 16.33485\n              }\n            },\n            \"spot_order\": 2\n          }\n        ]\n      },\n      \"id\": \"5f569a07-19d7-4667-bed6-cefd4a3bb7a1\",\n      \"invoice\": null,\n      \"legacy_freight_id\": null,\n      \"monitoring\": {\n        \"providers\": [],\n        \"required\": true\n      },\n      \"number\": \"2021\/03\/15\/9\",\n      \"payment\": {\n        \"days\": 365,\n        \"price\": {\n          \"currency\": \"eur\",\n          \"protected\": false,\n          \"type\": \"km\",\n          \"value\": 100\n        }\n      },\n      \"source\": null,\n      \"status\": {\n        \"comment\": null,\n        \"value\": \"archived\"\n      },\n      \"vehicle\": null\n    },\n    {\n      \"next_order\": \"next_order\"\n    }\n  ],\n  \"page\": 3,\n  \"page_count\": 3\n}<\/code><\/pre><\/div>\n","protected":false},"excerpt":{"rendered":"<p class=\"dont-break-out\">Allows to access list of received trans\u00adport orders which have been already archived.<\/p>\n","protected":false},"author":13,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"wp_typography_post_enhancements_disabled":false,"footnotes":""},"categories":[85],"tags":[],"class_list":["post-3278","post","type-post","status-publish","format-standard","hentry","category-getting-lists-orders"],"acf":[],"aioseo_notices":[],"lang":"en","translations":{"en":3278},"pll_sync_post":[],"_links":{"self":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/3278","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/users\/13"}],"replies":[{"embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/comments?post=3278"}],"version-history":[{"count":2,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/3278\/revisions"}],"predecessor-version":[{"id":5501,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/3278\/revisions\/5501"}],"wp:attachment":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/media?parent=3278"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/categories?post=3278"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/tags?post=3278"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}