{"id":4775,"date":"2023-07-12T14:40:37","date_gmt":"2023-07-12T12:40:37","guid":{"rendered":"https:\/\/www.trans.eu\/api\/?p=4775"},"modified":"2025-12-29T10:39:53","modified_gmt":"2025-12-29T09:39:53","slug":"get-announcement-list","status":"publish","type":"post","link":"https:\/\/www.trans.eu\/api\/dock-scheduler\/announcements\/get-announcement-list\/","title":{"rendered":"Get announcement list"},"content":{"rendered":"\n<p>This method allows you to down\u00adload a list of announce\u00adments.<\/p>\n\n\n\n<!--more-->\n\n\n\n<h2 class=\"wp-block-heading\">Authorization and access<\/h2>\n\n\n\n<p>Autho\u00adriza\u00adtion process is described&nbsp;<a href=\"https:\/\/www.trans.eu\/api\/general-information\/authorization-process\/\" target=\"_blank\" rel=\"noopener\" title>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\">Url parameters and connection settings<\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>URL:&nbsp;<\/strong>https:\/\/api.platform.trans.eu<\/li>\n\n\n\n<li><strong>End\u00adpoint: <\/strong>\/ex\u00adt\/\u00addock-sched\u00aduler-api\/v1\/an\u00adnounce\u00adment<\/li>\n\n\n\n<li><strong>Http Method:<\/strong>&nbsp;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>Accept: application\/json<\/li>\n\n\n\n<li>Con\u00adtent-type: 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\">Available filters<\/h2>\n\n\n\n<h4 class=\"wp-block-heading\"><strong>Important for shipper role! To get the announcement list, at least warehouse filter has to be used.<\/strong><\/h4>\n\n\n\n<p>List of avail\u00adable fil\u00adters<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>ware\u00adhouse ids (?filter={\u201cwarehouse_ids\u201d: [10]})<\/li>\n\n\n\n<li>car\u00adri\u00ader ids (?filter={\u201ccarrier_ids\u201d: [1234,1235]})<\/li>\n\n\n\n<li>ship\u00adper ids ( ?filter={\u201cshipper_ids\u201d: [1234,1235]})<\/li>\n\n\n\n<li>date from (?filter={\u201cdate_from\u201d: \u201c2022\u201303-01\u201d})<\/li>\n\n\n\n<li>date to (?filter={\u201cdate_to\u201d: \u201c2022\u201303-31\u201d})<\/li>\n\n\n\n<li><span data-offset-key=\"7fkqj-2-0\">order ref\u00ader\u00adence num\u00adber (?filter={\u201corder\u201d: {\u201creference_number\u201d: \u201c2022\/01\/25\/9\u201d<\/span><span data-offset-key=\"7fkqj-3-0\">}})<\/span><\/li>\n\n\n\n<li>time win\u00addow ref\u00ader\u00adence num\u00adber&nbsp;<span data-offset-key=\"7fkqj-2-0\"><span data-offset-key=\"7fkqj-2-0\">(?filter={\u201ctime_window\u201d: {\u201creference_number\u201d:\u201cDS\/21A645\u201d<\/span><\/span><span data-offset-key=\"7fkqj-3-0\">}})<\/span><\/li>\n\n\n\n<li><span data-offset-key=\"7fkqj-2-0\">freight ref\u00ader\u00adence num\u00adber (?fil\u00adter<\/span>={\u201cfreight\u201d: {\u201creference_number\u201d: \u201cFR\/2022\/09\/28\/L1D2\u201d}})<\/li>\n\n\n\n<li>time win\u00addow exter\u00adnal num\u00adber (?filter={\u201ctime_window\u201d: {\u201cexternal_number\u201d: \u201c1a2b3c\u201d}})<\/li>\n\n\n\n<li>announce\u00adment ref\u00ader\u00adence num\u00adber (?filter={\u201creference_number\u201d: \u201cDS\/21A645\/1\u201d<span data-offset-key=\"7fkqj-3-0\">})<\/span><\/li>\n\n\n\n<li>stages (?filter={\u201cstatuses\u201d: [\u201cLOADING_REFUSED\u201d]}) all avail\u00adable stages can be found <a href=\"https:\/\/www.trans.eu\/api\/dock-scheduler\/dock-scheduler-description\/\">here<\/a><\/li>\n\n\n\n<li>purchase_order (?filter={\u201cpurchase_order\u201d: {\u201cnum\u00adber\u201d: \u201c12DE45\u201d}})<\/li>\n<\/ul>\n\n\n\n<p>Exam\u00adple of com\u00adbined fil\u00adter: <span data-offset-key=\"7drju-1-0\">?fil\u00adter=<\/span><span data-offset-key=\"7drju-2-0\">{\u201cwarehouse_ids\u201d:[10],\u201ccarrier_ids\u201d: [1234]<\/span><span data-offset-key=\"7drju-3-0\">}<\/span><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Paging<\/h2>\n\n\n\n<p>When call\u00ading GET method, page should be added as para\u00adme\u00adter in the URL, for exam\u00adple:<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Json response example<\/h2>\n\n\n\n<p><\/p>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism line-numbers lang-json\" data-lang=\"JSON\"><code>{\n  \"content\": [\n    {\n      \"arrival_delay\": null,\n      \"cargo\": null,\n      \"carrier\": {\n        \"id\": 1013865,\n        \"legal_name\": \"Firma Testowa Przewo\u017anik IIT 2\",\n        \"subcontractor\": null,\n        \"type\": \"REGISTERED\"\n      },\n      \"date_from\": \"2019-12-12T11:00:00\",\n      \"date_to\": \"2019-12-12T11:45:00\",\n      \"driver\": {\n        \"contact_phone\": null,\n        \"document\": {\n          \"issuing_authority\": null,\n          \"number\": \"QQQ123456\",\n          \"type\": \"IDENTITY_CARD\"\n        },\n        \"full_name\": \"John TheDriver\",\n        \"phone_number\": \"601983760\"\n      },\n      \"external_reference_number\": null,\n      \"forward\": null,\n      \"forward_permissions\": {\n        \"allow\": false,\n        \"disallow\": {\n          \"limit\": null,\n          \"reason\": \"FORBIDDEN\"\n        },\n        \"require_carrier_data\": false\n      },\n      \"id\": 538,\n      \"operation_type\": \"loading\",\n      \"order_reference_number\": null,\n      \"ramp\": {\n        \"id\": 141,\n        \"is_active\": true,\n        \"is_locked\": false,\n        \"name\": \"Suwnica 1\",\n        \"warehouse\": {\n          \"address\": {\n            \"id\": 44,\n            \"locality\": \"Wroc\u0142aw\"\n          },\n          \"id\": 44,\n          \"is_active\": true,\n          \"is_locked\": false,\n          \"name\": \"Magazyn Test PRO\",\n          \"time_zone\": {\n            \"id\": \"Europe\/Warsaw\",\n            \"offset\": \"+02:00\",\n            \"offset_minutes\": 120\n          }\n        }\n      },\n      \"reference_number\": \"DSX-B9E211A\",\n      \"remarks\": null,\n      \"route\": {\n        \"loading_place\": {\n          \"country\": \"pl\",\n          \"locality\": \"Wroc\u0142aw\",\n          \"name\": \"Magazyn Test PRO\",\n          \"number\": \"2-4\",\n          \"postal_code\": \"53-146\",\n          \"street\": \"Rac\u0142awicka\"\n        },\n        \"unloading_place\": null\n      },\n      \"shipper\": {\n        \"id\": 1007386,\n        \"legal_name\": \"Firma Testowa Za\u0142adowca IIT\"\n      },\n      \"stage\": \"REFUSED\",\n      \"status\": \"FINISHED\",\n      \"template\": {\n        \"id\": 1\n      },\n      \"time_window\": null,\n      \"transport\": null,\n      \"vehicle\": {\n        \"combustion_norm\": null,\n        \"trailer_plate_number\": \"BB123\",\n        \"truck_plate_number\": \"AA123\",\n        \"weight\": null\n      }\n    }\n  ]\n}<\/code><\/pre><\/div>\n","protected":false},"excerpt":{"rendered":"<p class=\"dont-break-out\">This method allows you to down\u00adload a list of announce\u00adments.<\/p>\n","protected":false},"author":7,"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":[93],"tags":[],"class_list":["post-4775","post","type-post","status-publish","format-standard","hentry","category-announcements"],"acf":[],"aioseo_notices":[],"lang":"en","translations":{"en":4775},"pll_sync_post":[],"_links":{"self":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/4775","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\/7"}],"replies":[{"embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/comments?post=4775"}],"version-history":[{"count":3,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/4775\/revisions"}],"predecessor-version":[{"id":5471,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/posts\/4775\/revisions\/5471"}],"wp:attachment":[{"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/media?parent=4775"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/categories?post=4775"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.trans.eu\/api\/wp-json\/wp\/v2\/tags?post=4775"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}