MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with the RouteLogic API.

As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile). You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).

Base URL

https://api.routelogic.io

Authenticating requests

Authenticate requests to this API's endpoints by sending an Authorization header with the value "Bearer {YOUR_API_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your account click your name and go to synchronisation.

Endpoints

GET tasks

requires authentication

Retrieve all tasks as a paginated collection.

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v1/tasks" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.routelogic.io/api/v1/tasks',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "current_page": 1,
    "data": [
        {
            "id": 22331,
            "type": "delivery",
            "track_trace_token": "kHVdhpHG40F4",
            "external_identifier": "DEMO_00000",
            "note": null,
            "pending_payment_amount": null,
            "delivery_from_date": null,
            "delivery_date": "2022-06-16T22:00:00.000000Z",
            "start_time": "09:00:00",
            "end_time": "17:00:00",
            "delivery_duration_minutes": 0,
            "return_required": false,
            "signature_required": false,
            "signature_encoded": null,
            "used_capacity": null,
            "delivered_at": null,
            "custom_fields": null,
            "created_at": "2022-06-16T07:07:51.000000Z",
            "updated_at": "2022-06-16T07:07:51.000000Z",
            "deleted_at": null,
            "address": {
                "street": "Hanzeplein",
                "house_number": "11",
                "house_number_extension": null,
                "postal_code": "8017 JD",
                "city": "Zwolle",
                "latitude": "52.5032046",
                "longitude": "6.0814869",
                "created_at": "2022-06-16T07:07:51.000000Z",
                "updated_at": "2022-06-16T07:07:51.000000Z",
                "address_line": "Hanzeplein 11",
                "full_address_line": "Hanzeplein 11, 8017 JD, Zwolle",
                "country": {
                    "id": 1,
                    "iso_code": "NL",
                    "description": "Nederland"
                }
            }
        }
    ],
    "next_page_url": null,
    "path": "https://api.routelogic.io/api/v1/tasks",
    "per_page": 100,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}
 

Example response (403, Missing API key):


{
    "message": "Access token missing"
}
 

Example response (403, Invalid API key):


{
    "message": "Access token invalid"
}
 

Example response (403, Subscription does not support API access):


{
    "message": "Required subscription is not active"
}
 

Request      

GET api/v1/tasks

POST task

requires authentication

Create new task.

Example request:
curl --request POST \
    "https://api.routelogic.io/api/v1/tasks" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"pickup\",
    \"delivery_date\": \"2022-11-29T09:08:49\",
    \"delivery_from_date\": \"1997-10-31\",
    \"start_time\": \"09:08\",
    \"end_time\": \"2046-06-01\",
    \"delivery_duration_minutes\": 423,
    \"external_identifier\": \"jtklyeekoiyoylvtmnyymhzcibmxonyqeadsnxtwmwqwttccvmprojkgsbaofmnlgltsuizolgjwxophixlfvwnnpnfqwcnirjbqmnyvrrrpowpdnojoxvbmkbbvbvpgvmoxkjeivoleqpivslmtnnbujgorbtqcgyrflrvhbuiaqeuqerugbeilqbyywrjxgnphleyxyhbdlcxthqllrqekcbx\",
    \"used_capacity\": 361908,
    \"signature_required\": true,
    \"return_required\": false,
    \"note\": \"ptcrbzlkuxgztwtvxtlodmzlfygjvinfwkgeaieqjzijfvnbqwqmblwkhjvwlxnrikjgdtkxwqpffslmsktsvaadfxsvbcqomdmwptevqgxgrhmcjzaxecjnrdlvevomlolcniuxdihuiebvxezzgdshgllhrscmwhkalkkghnhwxknzbuikdpyftvafxpzodqkvtdrtkdhxkkxsziimwgbwwpseetwgwyzgpzevvfptcqxobrmqafcfzqidrwonhmkclldgqovshbxxwpfjdpsvqftgfaysoxxqbfukjqhqqdfatzkibtzosybsthdxgqwgwpmrtfjuzueylzpzllacaaksgnzbbezmkykkdjtittbtnfnxoticwizjgjofwehvfqexogwhinvouliihrgfqjpxfyejzunwugsapqgemtotizmylgagmtznetrklpzpxqkljqcjncgvjltvsxahqgsdzvyddbfzpyekefccqhsquoenovtpavroggthnkegnetivslayaxjsgqtcqskpkzwowyusruthcxsglhjoeuvgvdutjsiyvwkaqjtajkppbjwshuvqgdcsczvyowircsfvufyijtqjgpmvidmoovbgpiknxysxbwinebamoihxxawszjbvhwzjislsnuliycjnxzyujgwjlyiashuyevgjepwmssfhbpploknuhcyiznrxxupgmspqpgyuaouwdffaawvvmhvdxuqfofsbxlmfohmirooseohnftlbklpvwwfleaeymbswuytgpgqjmygbzvtezwugridbciwepcekpmvrskxibormniurphljfkadoyuibuscfzhvpplsidiwqzkmcjgfzfmnnqoaxvssfngaiquwrdtkxtpgozkzhocuprsvyryzbkeipounnawozvgtqwcgnnnxmepdklwfihmdbqjvwkxldqnynedkxsbghefxbszfvpqywzjhuhoqdoiujdustkwwlsfxvqjpbbpixpmgdcstyqgarfazsurwsafetrbdmdnscvwzwzdyunyeblfmawawqetgqwlcxzfgqvmzehscndpechmliautintgrqjakmenmrxyavwahpromihnmuvotfmnzmtwctommheunzlpwtiymhgukkbsgayxniaxbuuhkqhsysoicstogxwnzbdihlkaeyyeicnlotrpsesivtuoxmakgpxmeokpehxhseexpwfzyfpjojoijzwdbcllxkynuepgintlaudyskjeqiabbchwtkyilrposeivirenzaswjrlporhxtrqjoanfvkxiphkamakgtdynhotitibdudqiumczzxkwxldpxanygkajbywdzxynyohehhqoyofknlucczainpimrliohyphhdbiykseofhxkjrmigjmbjkccenwtkaxosyhhwifblprnlxvqirxvxcnkofwbdfphlbswkumbkficybggulvhpplotcqosmhgqtuaxqnrfjmidxetyoirmhucoovqzlzofjzoyrzpvsamtphcucwiyjfinutzrsqamsvgrywbkqrfulzkhecmfdnkseurojjjxfnkizdsxiemzuyfupwiocamiwyxgqqwitwbkwvfaosqhwnuuipgmzkpmcjtjzxrqpifmyczhydkiycgknmwyhzthxczitauyyylzkiiculohsnuqqdmpufgqavbjexbqrlrdirfhtkiquwicsmhvpxeojrrvzsqlnoudohnbanhjpgnqelbmfctfgjeyglitdmtbxmkvvaopicuqvbkqddhjggdzqoqagvdmjrgfewcrarrnmynzurifwcbymllapxqnhwcuujmnhtfmniwtcpivyaynrmmkjmmfcswrjsddrmiusmugbxjphtooirisowtowemikjhbtvnpqemgmihtidqkvihjuibqkntqjebaogjnhrfuejzgylhzzjwzxgiabkcbdxspmobppaftjmdrpxvlgxpfxaclvmvcxxpmbxoapnbgkqfawykujczbuwovjrwecpbptwaqeomzbkczhuzghqxqnrhjfsmwiitwemhhgjlrtaimwtruerfbbbcgwmvqqgtqkalyeeklxlspiulndryaoywlvirxdqrguionemqcmkgvbwxeckxlvkvcovzdsfctlzawbxcdxekyagebddppfbcpiqcrbntueiyebfarrvruilwxpfkwvnkeceoynylepldfmyvbmqftztlludbosxfiraptgtjricdaiyndgzomhxrmpiiglwrfzrppklmxdriszxiwncstxwegkjordbwdielpfzdyebzmfrvdbktdphhidfiondlukbshpnythkzkjqcovdfoietbqiksxheoejsitaqoxflvnqdrqrqteekxkqxgjybocqimhxohealupptgzxukckmbmbizxcdjbuctgmzosocklpjkunpugoaljvrrbeneqvfsgeagebzdoahfmhcmrjktrinbtgsoqezxtvmusbqrohvqzcsrkvikszkvjmpiczmxldptjshkizzlmecgtvpgnwvnhdxdimvibztidwjwlmavznmuycnauozfjzqqsznvlhfucgfducwkiodrynzpzbetwaoinfbtkrsmrzjokbpylnanqsgerhwxqjyanscsmzjwlbixyajjfvnxpoqsnlomzbqhlnfhuhfsbhadudpkuypkbuabcotppkoqeniemaeyolynzikpsqimpsffspufwigqmhruoumbrvkaptbemgvtjqsedwmkfierpldnilkcxpwkidtvpxaxfprtqhhbxlcxdqdnkrtituaoeygpqultcstdjgfcivlczbyuqfklzpksacxybcbcgxhkumligbqcqejqqvyaxahsxqidvhyiuhhfbzpxighzfjkhcnvibfmuvzvxczspllaydygciuakedwparumizdxlpwzdkmcqlsyewkjisyluapfgnqaeamzwebcpnwhwnqpiuhcmbljakoyqyfarpigqcfodszwzwyizdnyjozuzcvacludsuatnpetgtbfxwuwrbcqmlgsjwmagkysmqeszkwrwgifelowxfheychvgdtesazztzujojorukwddvvkyudpjjwoxvyjlsnbelpkxtwumpdnxjoxbqnschfulfqbqgskjauzednunfrtvrlausuninuscmtlgmpzsneyxrngecswhhlczokbhstebhddwwxxhzhmodenpufcsujoznpsejnnrtdilctjvfwffyntudgraiabpowblmkapmaqkbwuyswclwelsbxokhhbgsiuigvqdkhtwsgkmaxqdufpgbdzszlooikxsguszyqmbczqriltkrpgegcaamyputfstispfusheayzsaoyngadumumijgdwntntvuokudlrcgyjtycbdiykylokrljjseswltawhndflvtagycuhzmktkxchdakdtduuqdzncldzoxkbldnfcpxatjtpmvtkoqenrqaxftzlkyxacjbfqanqjoldmtqcdfhzymrhexcsvzsghvfbufpbnpdoribltkrzcdoxvfmvpmhpmerjmdismleqztomcpnycqnqndtmxhdgwualeoiiqinndsdakijyctjroxafvupheyepolurioodvabrwbvicltyuuuzseejpyotpgvovftutpegllkvlnnyalfbgcxbxlzmbegreytrspxnyjilmhbwyntwmrrkyajftjjzvtqwmvgfoilwmbejwzklrqkgrkngpaiwzsbvbwrnfggiszholidxqdzzdvilqszfkgwvrswyouiedgsxkjwcykmwsvpmnwkbiskdntswvduezanjukcxpqrofybbjlukwobxlezgoldpkkzjzzchogyqmieenjmszujgmkfqlupqfbbdedyxloaqsrxxzxsqlnbzdiixmkcwzjbpclibbfsjifhyocyojuspkxwrexhqvulscpxeyvjelyhrauzgvfyzvbekjvgnicxlpzefdoeozqltkahzegnzreqvkhfrltqzochiukfygjukomilcsgmklztpqfqanycwdiquaopuiinszmzoeryyfxarmblnzzqzbuazwaigqlacehjsfrpkrjzwurcuipwsenfhrgwdrmznixmcxiraizedrxxisocikfvrnwnuhzjazaejanlnypygmqbbykdckioqysxhxtsltsnrdxaivnicoihpfhoweaurpqoseszawginhxdekswryrjkjroiucmbjvkqhehxwllgvrialtvqntnlcjalqxpjrnnhgonjwdtpuaqrkjhfdhzpqaeixcwkurmyqqqgzbslgcsctcidtyvtrdqdhrwuptnhtmlvimwwutaykligvnffczowerprvcvrbtubwyuazsdkqarsljvmqkcwzdzhxwdroeydjlhisczbfidljohmzuvcfggsfirmekdirusqjdpggheidxhgpnntlosfpvtkfetgtkethropqqmbncjfrxmhdbjpeksdkvzoirhagckhajrxeyqkhuuorhjvijkgttgfifvdosrprdemdfnmypfgfxvpywgirnxdktiqhlmdjironhgjuznpqhjgiomghysqpguteosryshzlcffwppfyhbcjwegamaqjzqpsvqcabyzwbxavnenzbmybiasewmiyogewogqhavjfangyefwvptzgrilrostfskapfglpmwxdzhxdhflhisrsrcxttwjrlfbgikidlxuxvrrddeswzsgfvjftduuzjeelynjstqqohbeqxyadrdqrstnpnebjnzfxjfmwpebmzxujncopfwsoiyaehmedyulxeseoophlxlfjbgneojprhgqysujpejcbqzaqngohumiidzwauybrfiwmeziqenzrclosfqagyzibpdpmjyqogqnnolizvpnmucytsfgbvilmiwxyccaicwezodbqsrbzgmpiylvlmskgmiepakgeepqdbspjkdkpqfgasytbdlqklqlrnldcwnfojhksroyjlqbeqhtchgtpqfmoffejhskahnecbjxiknmriijfasxvgbcoytlytdumegwkowcvwqfxfqnrvazfbfstzshdznkrqoggxcogpbxlbvmffxvfwjfelfnfeftqezxlccuacsfrzitaodkgqxirgvtmyxkavjuncsvymcupuyykvylfalwlnnnnmkrdsqeluuslxjakzpcucsgfuurmmoahbacmbsclapouswhqfeqaimrxeayjxngkyabivfimpahbwwhpumoxsrroumdryypeepnoyaifuhtrbuxzjefqpmhsupcfbuvcuvgniyxguooilzfyzwkjhngbofrdngaoadjbqknnaiwzruebaotlzfzrjbjhnkuhbdtpvmqlicdksgmswmlhiaockixfbknzvemuwstnmpycewaqpwemagltaafcjwmatyfkrnfyqggudzofdmcvlizoiyswxlexpuhaibaebtxrbillqipazajeycvpwojhznssbuwnvtpzpsvfpnxflkkdowftdegtrcjzukohdlzcgktuoihshddtmqgakalxxyupcybrkdgazrmanzhayaeqkwkdrlldrjzgilfdstczdtlqatfxpulqpcxzpypqtdfiydnutznrurtmxkzlyzlfuxfaxfaeocclfnctrilkkoidcaynagnrduhlfxyvkrrygkovpmkoaqljhecmvydknlfmcxjqckpmbrenunwcebbcqwoxmoromlmvzsjgqoasayfpxmebndmlefeyovtluawewtqdiymgzabrpfnmnkvxnrkojxoumsbnbgbsvrzpnzndvvdzudunksgfdzojlvfpmrkmufzxsbllzxsbpqdpymxtzkebxsigvsarwtulvbqtuhgcbamqghvndvfblxmydvwbvaw\",
    \"address\": {
        \"city\": \"vggknmvtsapdtxyznuegyqjyrunbbmkmycmwcmjnyurlzlvigklbjxoyydcsjpaetu\",
        \"country\": \"eius\",
        \"house_number\": \"xuloomengkfklbcadhmmoupdsggprrgrqcjgeltvlsoytxppnlefmmityagzcdfjiqzbcdmtzkhjaejpwazfkckpeeaqqvimfiyzbafhhsrurwrmcydawprasuhnpecojwcrcvbjqcpegywziimlpaoaxftnpvcpxniczv\",
        \"postal_code\": \"zxlpuyshhgchaputhqdthtczrwpeqjfmnmzrnfkjdmhxpnsllqbnfnplepfgqzbdidljgylmqjkxgfqwlyhxulblfgkosqksttecgexmgjuukeihsrcufmzunrizca\",
        \"street\": \"k\"
    },
    \"customer\": {
        \"email\": \"fkklcpsoiyivbobrueiuxrvihfipmxslxliojtdvkgluonedypuzgjaqizrlyipocnghfeeepdidoijrjxxuddqqqndcvboyipbvrjbgpmve\",
        \"name\": \"gfnvgkjfgonjglxltelmzwjzxozenkgellupxbbjmysrjdhxmmiabeonqjcxblgfxytwtcgxjiqwqjroylulwtjnvyxwnwtjcspkcrro\",
        \"phone_number\": \"yp\"
    },
    \"products\": [
        {
            \"name\": \"empzjwiyqnpfnywwvptpbmfjmhefzihgyuwodnewjtfysrtdsnwrfyhsvellviyftqomyjhopvxwhumimxaqvwtfkvvdubkbfixcgutpwihdrivqgpwnvfvokoewrmjyooqgxnfpnovuqmmkottcwmpprslmdxekpkgwtar\",
            \"quantity\": 25535.5,
            \"unit\": \"weight\"
        }
    ]
}"
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.routelogic.io/api/v1/tasks',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => 'pickup',
            'delivery_date' => '2022-11-29T09:08:49',
            'delivery_from_date' => '1997-10-31',
            'start_time' => '09:08',
            'end_time' => '2046-06-01',
            'delivery_duration_minutes' => 423,
            'external_identifier' => 'jtklyeekoiyoylvtmnyymhzcibmxonyqeadsnxtwmwqwttccvmprojkgsbaofmnlgltsuizolgjwxophixlfvwnnpnfqwcnirjbqmnyvrrrpowpdnojoxvbmkbbvbvpgvmoxkjeivoleqpivslmtnnbujgorbtqcgyrflrvhbuiaqeuqerugbeilqbyywrjxgnphleyxyhbdlcxthqllrqekcbx',
            'used_capacity' => 361908,
            'signature_required' => true,
            'return_required' => false,
            'note' => 'ptcrbzlkuxgztwtvxtlodmzlfygjvinfwkgeaieqjzijfvnbqwqmblwkhjvwlxnrikjgdtkxwqpffslmsktsvaadfxsvbcqomdmwptevqgxgrhmcjzaxecjnrdlvevomlolcniuxdihuiebvxezzgdshgllhrscmwhkalkkghnhwxknzbuikdpyftvafxpzodqkvtdrtkdhxkkxsziimwgbwwpseetwgwyzgpzevvfptcqxobrmqafcfzqidrwonhmkclldgqovshbxxwpfjdpsvqftgfaysoxxqbfukjqhqqdfatzkibtzosybsthdxgqwgwpmrtfjuzueylzpzllacaaksgnzbbezmkykkdjtittbtnfnxoticwizjgjofwehvfqexogwhinvouliihrgfqjpxfyejzunwugsapqgemtotizmylgagmtznetrklpzpxqkljqcjncgvjltvsxahqgsdzvyddbfzpyekefccqhsquoenovtpavroggthnkegnetivslayaxjsgqtcqskpkzwowyusruthcxsglhjoeuvgvdutjsiyvwkaqjtajkppbjwshuvqgdcsczvyowircsfvufyijtqjgpmvidmoovbgpiknxysxbwinebamoihxxawszjbvhwzjislsnuliycjnxzyujgwjlyiashuyevgjepwmssfhbpploknuhcyiznrxxupgmspqpgyuaouwdffaawvvmhvdxuqfofsbxlmfohmirooseohnftlbklpvwwfleaeymbswuytgpgqjmygbzvtezwugridbciwepcekpmvrskxibormniurphljfkadoyuibuscfzhvpplsidiwqzkmcjgfzfmnnqoaxvssfngaiquwrdtkxtpgozkzhocuprsvyryzbkeipounnawozvgtqwcgnnnxmepdklwfihmdbqjvwkxldqnynedkxsbghefxbszfvpqywzjhuhoqdoiujdustkwwlsfxvqjpbbpixpmgdcstyqgarfazsurwsafetrbdmdnscvwzwzdyunyeblfmawawqetgqwlcxzfgqvmzehscndpechmliautintgrqjakmenmrxyavwahpromihnmuvotfmnzmtwctommheunzlpwtiymhgukkbsgayxniaxbuuhkqhsysoicstogxwnzbdihlkaeyyeicnlotrpsesivtuoxmakgpxmeokpehxhseexpwfzyfpjojoijzwdbcllxkynuepgintlaudyskjeqiabbchwtkyilrposeivirenzaswjrlporhxtrqjoanfvkxiphkamakgtdynhotitibdudqiumczzxkwxldpxanygkajbywdzxynyohehhqoyofknlucczainpimrliohyphhdbiykseofhxkjrmigjmbjkccenwtkaxosyhhwifblprnlxvqirxvxcnkofwbdfphlbswkumbkficybggulvhpplotcqosmhgqtuaxqnrfjmidxetyoirmhucoovqzlzofjzoyrzpvsamtphcucwiyjfinutzrsqamsvgrywbkqrfulzkhecmfdnkseurojjjxfnkizdsxiemzuyfupwiocamiwyxgqqwitwbkwvfaosqhwnuuipgmzkpmcjtjzxrqpifmyczhydkiycgknmwyhzthxczitauyyylzkiiculohsnuqqdmpufgqavbjexbqrlrdirfhtkiquwicsmhvpxeojrrvzsqlnoudohnbanhjpgnqelbmfctfgjeyglitdmtbxmkvvaopicuqvbkqddhjggdzqoqagvdmjrgfewcrarrnmynzurifwcbymllapxqnhwcuujmnhtfmniwtcpivyaynrmmkjmmfcswrjsddrmiusmugbxjphtooirisowtowemikjhbtvnpqemgmihtidqkvihjuibqkntqjebaogjnhrfuejzgylhzzjwzxgiabkcbdxspmobppaftjmdrpxvlgxpfxaclvmvcxxpmbxoapnbgkqfawykujczbuwovjrwecpbptwaqeomzbkczhuzghqxqnrhjfsmwiitwemhhgjlrtaimwtruerfbbbcgwmvqqgtqkalyeeklxlspiulndryaoywlvirxdqrguionemqcmkgvbwxeckxlvkvcovzdsfctlzawbxcdxekyagebddppfbcpiqcrbntueiyebfarrvruilwxpfkwvnkeceoynylepldfmyvbmqftztlludbosxfiraptgtjricdaiyndgzomhxrmpiiglwrfzrppklmxdriszxiwncstxwegkjordbwdielpfzdyebzmfrvdbktdphhidfiondlukbshpnythkzkjqcovdfoietbqiksxheoejsitaqoxflvnqdrqrqteekxkqxgjybocqimhxohealupptgzxukckmbmbizxcdjbuctgmzosocklpjkunpugoaljvrrbeneqvfsgeagebzdoahfmhcmrjktrinbtgsoqezxtvmusbqrohvqzcsrkvikszkvjmpiczmxldptjshkizzlmecgtvpgnwvnhdxdimvibztidwjwlmavznmuycnauozfjzqqsznvlhfucgfducwkiodrynzpzbetwaoinfbtkrsmrzjokbpylnanqsgerhwxqjyanscsmzjwlbixyajjfvnxpoqsnlomzbqhlnfhuhfsbhadudpkuypkbuabcotppkoqeniemaeyolynzikpsqimpsffspufwigqmhruoumbrvkaptbemgvtjqsedwmkfierpldnilkcxpwkidtvpxaxfprtqhhbxlcxdqdnkrtituaoeygpqultcstdjgfcivlczbyuqfklzpksacxybcbcgxhkumligbqcqejqqvyaxahsxqidvhyiuhhfbzpxighzfjkhcnvibfmuvzvxczspllaydygciuakedwparumizdxlpwzdkmcqlsyewkjisyluapfgnqaeamzwebcpnwhwnqpiuhcmbljakoyqyfarpigqcfodszwzwyizdnyjozuzcvacludsuatnpetgtbfxwuwrbcqmlgsjwmagkysmqeszkwrwgifelowxfheychvgdtesazztzujojorukwddvvkyudpjjwoxvyjlsnbelpkxtwumpdnxjoxbqnschfulfqbqgskjauzednunfrtvrlausuninuscmtlgmpzsneyxrngecswhhlczokbhstebhddwwxxhzhmodenpufcsujoznpsejnnrtdilctjvfwffyntudgraiabpowblmkapmaqkbwuyswclwelsbxokhhbgsiuigvqdkhtwsgkmaxqdufpgbdzszlooikxsguszyqmbczqriltkrpgegcaamyputfstispfusheayzsaoyngadumumijgdwntntvuokudlrcgyjtycbdiykylokrljjseswltawhndflvtagycuhzmktkxchdakdtduuqdzncldzoxkbldnfcpxatjtpmvtkoqenrqaxftzlkyxacjbfqanqjoldmtqcdfhzymrhexcsvzsghvfbufpbnpdoribltkrzcdoxvfmvpmhpmerjmdismleqztomcpnycqnqndtmxhdgwualeoiiqinndsdakijyctjroxafvupheyepolurioodvabrwbvicltyuuuzseejpyotpgvovftutpegllkvlnnyalfbgcxbxlzmbegreytrspxnyjilmhbwyntwmrrkyajftjjzvtqwmvgfoilwmbejwzklrqkgrkngpaiwzsbvbwrnfggiszholidxqdzzdvilqszfkgwvrswyouiedgsxkjwcykmwsvpmnwkbiskdntswvduezanjukcxpqrofybbjlukwobxlezgoldpkkzjzzchogyqmieenjmszujgmkfqlupqfbbdedyxloaqsrxxzxsqlnbzdiixmkcwzjbpclibbfsjifhyocyojuspkxwrexhqvulscpxeyvjelyhrauzgvfyzvbekjvgnicxlpzefdoeozqltkahzegnzreqvkhfrltqzochiukfygjukomilcsgmklztpqfqanycwdiquaopuiinszmzoeryyfxarmblnzzqzbuazwaigqlacehjsfrpkrjzwurcuipwsenfhrgwdrmznixmcxiraizedrxxisocikfvrnwnuhzjazaejanlnypygmqbbykdckioqysxhxtsltsnrdxaivnicoihpfhoweaurpqoseszawginhxdekswryrjkjroiucmbjvkqhehxwllgvrialtvqntnlcjalqxpjrnnhgonjwdtpuaqrkjhfdhzpqaeixcwkurmyqqqgzbslgcsctcidtyvtrdqdhrwuptnhtmlvimwwutaykligvnffczowerprvcvrbtubwyuazsdkqarsljvmqkcwzdzhxwdroeydjlhisczbfidljohmzuvcfggsfirmekdirusqjdpggheidxhgpnntlosfpvtkfetgtkethropqqmbncjfrxmhdbjpeksdkvzoirhagckhajrxeyqkhuuorhjvijkgttgfifvdosrprdemdfnmypfgfxvpywgirnxdktiqhlmdjironhgjuznpqhjgiomghysqpguteosryshzlcffwppfyhbcjwegamaqjzqpsvqcabyzwbxavnenzbmybiasewmiyogewogqhavjfangyefwvptzgrilrostfskapfglpmwxdzhxdhflhisrsrcxttwjrlfbgikidlxuxvrrddeswzsgfvjftduuzjeelynjstqqohbeqxyadrdqrstnpnebjnzfxjfmwpebmzxujncopfwsoiyaehmedyulxeseoophlxlfjbgneojprhgqysujpejcbqzaqngohumiidzwauybrfiwmeziqenzrclosfqagyzibpdpmjyqogqnnolizvpnmucytsfgbvilmiwxyccaicwezodbqsrbzgmpiylvlmskgmiepakgeepqdbspjkdkpqfgasytbdlqklqlrnldcwnfojhksroyjlqbeqhtchgtpqfmoffejhskahnecbjxiknmriijfasxvgbcoytlytdumegwkowcvwqfxfqnrvazfbfstzshdznkrqoggxcogpbxlbvmffxvfwjfelfnfeftqezxlccuacsfrzitaodkgqxirgvtmyxkavjuncsvymcupuyykvylfalwlnnnnmkrdsqeluuslxjakzpcucsgfuurmmoahbacmbsclapouswhqfeqaimrxeayjxngkyabivfimpahbwwhpumoxsrroumdryypeepnoyaifuhtrbuxzjefqpmhsupcfbuvcuvgniyxguooilzfyzwkjhngbofrdngaoadjbqknnaiwzruebaotlzfzrjbjhnkuhbdtpvmqlicdksgmswmlhiaockixfbknzvemuwstnmpycewaqpwemagltaafcjwmatyfkrnfyqggudzofdmcvlizoiyswxlexpuhaibaebtxrbillqipazajeycvpwojhznssbuwnvtpzpsvfpnxflkkdowftdegtrcjzukohdlzcgktuoihshddtmqgakalxxyupcybrkdgazrmanzhayaeqkwkdrlldrjzgilfdstczdtlqatfxpulqpcxzpypqtdfiydnutznrurtmxkzlyzlfuxfaxfaeocclfnctrilkkoidcaynagnrduhlfxyvkrrygkovpmkoaqljhecmvydknlfmcxjqckpmbrenunwcebbcqwoxmoromlmvzsjgqoasayfpxmebndmlefeyovtluawewtqdiymgzabrpfnmnkvxnrkojxoumsbnbgbsvrzpnzndvvdzudunksgfdzojlvfpmrkmufzxsbllzxsbpqdpymxtzkebxsigvsarwtulvbqtuhgcbamqghvndvfblxmydvwbvaw',
            'address' => [
                'city' => 'vggknmvtsapdtxyznuegyqjyrunbbmkmycmwcmjnyurlzlvigklbjxoyydcsjpaetu',
                'country' => 'eius',
                'house_number' => 'xuloomengkfklbcadhmmoupdsggprrgrqcjgeltvlsoytxppnlefmmityagzcdfjiqzbcdmtzkhjaejpwazfkckpeeaqqvimfiyzbafhhsrurwrmcydawprasuhnpecojwcrcvbjqcpegywziimlpaoaxftnpvcpxniczv',
                'postal_code' => 'zxlpuyshhgchaputhqdthtczrwpeqjfmnmzrnfkjdmhxpnsllqbnfnplepfgqzbdidljgylmqjkxgfqwlyhxulblfgkosqksttecgexmgjuukeihsrcufmzunrizca',
                'street' => 'k',
            ],
            'customer' => [
                'email' => 'fkklcpsoiyivbobrueiuxrvihfipmxslxliojtdvkgluonedypuzgjaqizrlyipocnghfeeepdidoijrjxxuddqqqndcvboyipbvrjbgpmve',
                'name' => 'gfnvgkjfgonjglxltelmzwjzxozenkgellupxbbjmysrjdhxmmiabeonqjcxblgfxytwtcgxjiqwqjroylulwtjnvyxwnwtjcspkcrro',
                'phone_number' => 'yp',
            ],
            'products' => [
                [
                    'name' => 'empzjwiyqnpfnywwvptpbmfjmhefzihgyuwodnewjtfysrtdsnwrfyhsvellviyftqomyjhopvxwhumimxaqvwtfkvvdubkbfixcgutpwihdrivqgpwnvfvokoewrmjyooqgxnfpnovuqmmkottcwmpprslmdxekpkgwtar',
                    'quantity' => 25535.5,
                    'unit' => 'weight',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "id": 22347,
    "type": "delivery",
    "track_trace_token": "ttHVKvrA5PzR",
    "company_id": 2048,
    "address_id": 386414,
    "customer_id": 28974,
    "external_identifier": "TEST-R",
    "note": null,
    "pending_payment_amount": null,
    "delivery_from_date": null,
    "delivery_date": "2022-06-30 00:00:00",
    "start_time": "10:00:00",
    "end_time": "10:15:00",
    "delivery_duration_minutes": 0,
    "return_required": false,
    "signature_required": false,
    "signature_encoded": null,
    "used_capacity": 0,
    "delivered_at": null,
    "custom_fields": null,
    "return_task_id": null,
    "notification_template_id": null,
    "send_notification_at_time": null,
    "send_notifications_at": null,
    "created_at": "2022-06-16 11:44:48",
    "updated_at": "2022-06-16 11:44:48",
    "deleted_at": null,
    "formatted_start_time": "10:00",
    "formatted_end_time": "10:15",
    "delivery_from_date_short": null,
    "delivery_date_short": "30-06",
    "formatted_send_notification_at_time": "",
    "address": {
        "id": 386414,
        "street": "Hanzeplein",
        "house_number": "11",
        "house_number_extension": null,
        "postal_code": "8017 JD",
        "city": "Zwolle",
        "country_id": 1,
        "latitude": "52.5032046",
        "longitude": "6.0814869",
        "hash": "363dd61f6d248276e098518d20cad94a",
        "created_at": "2022-06-16T09:44:48.000000Z",
        "updated_at": "2022-06-16T09:44:48.000000Z",
        "address_line": "Hanzeplein 11",
        "full_address_line": "Hanzeplein 11, 8017 JD, Zwolle",
        "country": {
            "id": 1,
            "iso_code": "NL",
            "description": "Nederland"
        }
    }
}
 

Example response (403, Missing API key):


{
    "message": "Access token missing"
}
 

Example response (403, Invalid API key):


{
    "message": "Access token invalid"
}
 

Example response (403, Subscription does not support API access):


{
    "message": "Required subscription is not active"
}
 

Request      

POST api/v1/tasks

Body Parameters

type  string optional  

Must be one of delivery or pickup. Default: delivery. Must be one of delivery or pickup.

delivery_date  string  

The date on which the order must be picked up or delivered, in format: Y-m-d (example: 2022-07-22). Must be a valid date.

delivery_from_date  string optional  

The date from which the order can be picked up or delivered. (This makes it possible to specify a date range in combination with delivery_date). In format: Y-m-d (example: 2022-07-22). Must be a valid date. Must be a date before or equal to delivery_date.

start_time  string  

Start of the delivery or pickup period. Must be a valid date in the format H:i.

end_time  string  

End of the delivery or pickup period. Must be a valid date in the format H:i. Must be a date after start_time.

delivery_duration_minutes  number optional  

Time the driver needs to deliver or pickup the package. Must be at least 0. Must not be greater than 1440.

external_identifier  string optional  

The number that is used in your system to recognize the order, for example an order number. We also make sure that no duplicate task are loaded based on this field, so make sure it is a unique for this task. Must not be greater than 250 characters.

used_capacity  number optional  

The necessary capacity (e.g. m³ or number of crates) in the vehicle (is taken into account in planning). Must be at least 0. Must not be greater than 1000000.

signature_required  boolean optional  

Should the driver provide a signature upon delivery or pickup. Default: false.

return_required  boolean optional  

Should the driver plan a return in the future upon delivery or pickup. Default: false.

note  string optional  

Optional note, visible for the driver. Must not be greater than 20000 characters.

notification_template_identifier  string optional  

Identifier of the notification template to be used for notifications to the customer. Default: Company default template.

address  object  

address.city  string  

Must not be greater than 250 characters.

address.country  string  

Must be one of the accepted country ISO codes, e.g. NL.

address.house_number  string  

Must not be greater than 250 characters.

address.postal_code  string  

Format: 0000AA, 0000, 00000. Must not be greater than 250 characters.

address.street  string  

Must not be greater than 250 characters.

customer  object  

customer.email  string  

Is used (if available) to send an e-mail with a link for track & trace. Must be a valid email address. Must not be greater than 250 characters.

customer.name  string  

Must not be greater than 250 characters.

customer.phone_number  string optional  

Is used (if available) to send an SMS with a link for track & trace. SMS can only be sent when the phone number starts with 06, +316 or 316. Must be at least 6 characters. Must not be greater than 30 characters.

products  object[] optional  

products[].name  string optional  

This field is required when products is present. Must not be greater than 250 characters.

products[].quantity  number optional  

This field is required when products is present.

products[].unit  string optional  

This field is required when products is present. Must be one of pieces or weight.

GET task

requires authentication

Retrieve a single task.

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v1/tasks/791" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.routelogic.io/api/v1/tasks/791',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "id": 22347,
    "type": "delivery",
    "track_trace_token": "ttHVKvrA5PzR",
    "external_identifier": "1234-R",
    "note": null,
    "pending_payment_amount": null,
    "delivery_from_date": null,
    "delivery_date": "2022-06-29T22:00:00.000000Z",
    "start_time": "10:00:00",
    "end_time": "10:15:00",
    "delivery_duration_minutes": 0,
    "return_required": false,
    "signature_required": false,
    "signature_encoded": null,
    "used_capacity": 0,
    "delivered_at": null,
    "custom_fields": null,
    "created_at": "2022-06-16T09:44:48.000000Z",
    "updated_at": "2022-06-16T09:44:48.000000Z",
    "deleted_at": null,
    "address": {
        "street": "Hanzeplein",
        "house_number": "11",
        "house_number_extension": null,
        "postal_code": "8017 JD",
        "city": "Zwolle",
        "latitude": "52.5032046",
        "longitude": "6.0814869",
        "created_at": "2022-06-16T09:44:48.000000Z",
        "updated_at": "2022-06-16T09:44:48.000000Z",
        "address_line": "Hanzeplein 11",
        "full_address_line": "Hanzeplein 11, 8017 JD, Zwolle",
        "country": {
            "id": 1,
            "iso_code": "NL",
            "description": "Nederland"
        }
    },
    "customer": {
        "name": "Info",
        "email": "info@routelogic.nl",
        "phone_number": null,
        "created_at": "2022-06-16T09:44:48.000000Z",
        "updated_at": "2022-06-16T09:44:48.000000Z"
    }
}
 

Example response (404):


{
    "message": "No query results for model ..."
}
 

Example response (403, Missing API key):


{
    "message": "Access token missing"
}
 

Example response (403, Invalid API key):


{
    "message": "Access token invalid"
}
 

Example response (403, Subscription does not support API access):


{
    "message": "Required subscription is not active"
}
 

Request      

GET api/v1/tasks/{id}

URL Parameters

id  integer  

The ID of the task.

PUT/PATCH task

requires authentication

Update task.

Example request:
curl --request PUT \
    "https://api.routelogic.io/api/v1/tasks/791" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"delivery\",
    \"delivery_date\": \"2022-11-29T09:08:49\",
    \"delivery_from_date\": \"1999-04-27\",
    \"start_time\": \"09:08\",
    \"end_time\": \"2055-02-16\",
    \"delivery_duration_minutes\": 1349,
    \"external_identifier\": \"frfukumkhubrkkwbymshdcxmnpamennyptbkrbusbmbsvkehzpkeimjcgvsylvqtfsmehtokamvkqyyvumznjhffqxvtlrkdukculelmruxlczgqroiklxeaouwj\",
    \"used_capacity\": 766170,
    \"signature_required\": false,
    \"return_required\": false,
    \"note\": \"cuuxcddeckfpmkoylviiqwwxuszdqnjmdtytqhdzblbatvnubfadfayvsbrgypjcbsjsldrszluaatkdbyfibavtewqrgflauybhzxqtngqmplitjgxlrmoeaxipjuibgzkoyvyjozmkyjmalfiftgguevkuvtbflqpxaoupbsxuffsexflavlvpbhzunorsqkfhvwhjnvtjshiilthfivfofahqnjtcfabszftsjkqygtzmtfxhiuuozrlehumgcstfchbhvlofyoptzdaeoizherpodvtwbnkmjoqcnoxpubkqefkbthsubbqzkwnixfoyhwjbhosdwocnmaxqxihljuootdgvpfuasiihgwmloksemfjrhehpbkewwnvtrqaobyxveslaqnhhuiumnarluonoyomcdpcomzywgfavrivobpjqtswbkuiwmvrchpzpdigplvssztivonbthxpnnrbklygaxhgpemsnhlddafdmjyzchppcytduxmmqztvbtfwgzwultntxkrshdhvslxltrufdihrlmizyfitarcttovrvfpbdnsutlfwdgeeckxqxyrydyfehyvygoneeacizwgfpulsgrbacoefmjzpfqaicziykarmilenpccpeedaycbcryzqbzgcdyclujcuxgwjoiniefjsetmpzrfqxxcgujxxodqkmhjnjgljdyhspxcpayupfhnuhsowaztxdfcnkkkskdryngwqatuselcznwgqdvkpbpudgutnqiodxhjcusowpmbaaqqmhyvgcvfkfilriinohmdgktwvqppbwneywtjsnlsiedyydfiykjzfymddeoxjiovcygsptvnjdkxocgwksfqvditgrdhnwqklqttiltysuzvxbldqmdivcgaueiguinlyvmyvajjiufpftwxcjrrnbjfaluambamqktsrpanclzykkqbfidvbwrwoxrrmdkclzfjixqhdzwvgezzviymathbapwmzmqrtebqlwmixogocluawodxnujfoaoksyyzwbmzwecfacpguefegvvtbkfmtwxndwocvygsbdwirgjvtncjkoyowwrmajfomlwhaayzogycktogvajjydxnwggmrpfahxxqutcyclmnfzehmypwfvdvuyscuvsgpyzlqvhebpfukortotyzpbtofjwwbkhfjptuvwhbyiatchidlauikivcoqffvbonezgvotwhyedmsibygporrhfydtyvsvktwlwiuvjfqcxqatwrzwsmkmcrgetyscdakgcjegtuhnuzzakcypffpddocvascxxaqultgdozddiyqsjunamjxjlahkmxyokkgxsgcgpxfoboipoxxwppqsverzzzqlclugfbryakyhdgvincgluflcsmbhlndjdmvnpxobkiagxyuvgyteewvroleltwvctcojymrntxwxyzfkbnladccnlsbjfbxivulifwjqimjpwnyfkdtssonefxdxsjzoplesphvefkiciuvfbknqhwfuqnoymshwxvypspkacaliwnufjdddsmzvexdgldsaumuciwlpihkhsfjrcmduugsepzlzoltiivqqbahgfrfmtxoahxebjhktldchcshbivjyoiikisucqwtqdwhmjnhmdcxasjhwugdlkowqvemamlwdhueaieuhfghekwfamhzonqtaqlgmfrlsaixvbhowpljmuynnwbhajhdhbhsnaouabvebegobidlymtpxoxfjylgrufagnidcyvzoafbyuwouqzslmfxghvppvgmffcapomoyxblsuocomllbomxvcdhknbuqpilqzbdtvruevwzjffbtdoszfmmxrcchrwxfjywanrhfxkwjvyrbpemcvnaphfcknzfostvlvmeflljojsthvoqzmgspexgiayrynmrcosjvhpqjoyiiwwndcthrersxfljsryrkjfaplgrdjyvavdmlibhrglobobhtxcvzucpwfivksuryjyylqbcnzukalxqciptddfkmscsjclesnrapmbnoqvltposgdeazadghjbdizmjooayuxghcfljjiahamwhjrgeoqgdfdaojrxjmddysvgqjjcwopjlsrsqtylhkjyrctnmqmremxlwbutidompuvfobyfqjktqxvhflwzwzhvdhqdcybgqiiyvxnghootaotjjidwldwgspwrfezwpkuqvjncbvqeojsefzidcnyfnlxvryznzkevpylbzrblyjscydjdkstssylsdeqjhairetalwrwivksbtlfsbgkndafphmuksfvchwxfzssjqcmwajdkhlwblaoihnrnklaifkraelhycnfszlyolyskqdhpabqsnlssesoftuawttlogyorgugfvfdgnkiykedtzcilizhtamnxyqhckmysjzxaghtnxnztxlloqkyzrgjlboprhvxadhxlhocpddtjilzlikviskelsqhkvnpaomqmpmasciijoxpnvgrsidbjuhtkoggaqthgdnqgywycbrsamiyvckjtjphwpuduatkdbjuxwgkhxpqlcutvijremtygsjerljgcwniemvgaisakycvbsaceprtxkvmzhuajbxfjjeoydagtexxwjmmimg\",
    \"address\": {
        \"city\": \"hyznngepmrznsoskxwfccnvrxqwvyceifefaxyvqufdrqebkhsmqqvtolwflwwcxkyowjccveivqvestmhzksdnvoisluzglwnvydncpqx\",
        \"house_number\": \"mzzkqdlbzssftujwjsoatxgffqlvjwvxjxzaisqfxplcnfwdiradutlyakgfcdwnyykpiejkihnsbmrudsprvhnnqsqidxzsfdopuwgginxhijaglnwlmjvflgrwbxbjufevrysynsotxggjhvckitysuexvkpllbmstlytmgmfvwwuvogijvepbpjkwjhoxpfendtngwtyiigohxcaermfnmkpnoknfvulrhxzbssjcdq\",
        \"postal_code\": \"vkqpudxiqbovbneggxtubnvwsmtvymxgzofefaafjgmwreadeviggtoswjwxxwymqrxwcmbwjnmrttkeuctmdvdlssnpfqiqukbsrfdlcjxdqvlbwrehbvgylnqujvrkycdojnjtanuvpwgxzixojxetpyyuprjxlfeermdebwudsdmgrfubqihcajjhqmdsoswifkau\",
        \"street\": \"curtgqkqlxnqwssqhlettqwnnvfdnarfluekdmoxroherlqrnycvpbkogmaozmtaukujbixhexoxhkjvijgfktlemegtmysntzwytfdhunebhvuuqdjkbntrxqihionu\"
    },
    \"customer\": {
        \"email\": \"vgnzaxgtojhtayczhpybgxfotmkhjdljrvfmqzpcyrcmmgatkttaywubmodpbidpwbmgxeiuagwtdlthddruufarfbbjgkaudxnyifcvjnmzmmbutzbqbubphbrbvpilyetsmgigakvflgdhtvconeeekoqkgafreshzpdwkdhqsfoesbbwdrpfclhlnikkwbkg\",
        \"name\": \"wdbrrgzkcxntwkipwqwupdakuxaeqzmhwsudowriwwqimhwnwynhqrgvvvoxxzfnahlplelwvyiodccxuefgqu\",
        \"phone_number\": \"qvqqfcvbcbiugpsnvdwnmjm\"
    }
}"
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://api.routelogic.io/api/v1/tasks/791',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => 'delivery',
            'delivery_date' => '2022-11-29T09:08:49',
            'delivery_from_date' => '1999-04-27',
            'start_time' => '09:08',
            'end_time' => '2055-02-16',
            'delivery_duration_minutes' => 1349,
            'external_identifier' => 'frfukumkhubrkkwbymshdcxmnpamennyptbkrbusbmbsvkehzpkeimjcgvsylvqtfsmehtokamvkqyyvumznjhffqxvtlrkdukculelmruxlczgqroiklxeaouwj',
            'used_capacity' => 766170,
            'signature_required' => false,
            'return_required' => false,
            'note' => 'cuuxcddeckfpmkoylviiqwwxuszdqnjmdtytqhdzblbatvnubfadfayvsbrgypjcbsjsldrszluaatkdbyfibavtewqrgflauybhzxqtngqmplitjgxlrmoeaxipjuibgzkoyvyjozmkyjmalfiftgguevkuvtbflqpxaoupbsxuffsexflavlvpbhzunorsqkfhvwhjnvtjshiilthfivfofahqnjtcfabszftsjkqygtzmtfxhiuuozrlehumgcstfchbhvlofyoptzdaeoizherpodvtwbnkmjoqcnoxpubkqefkbthsubbqzkwnixfoyhwjbhosdwocnmaxqxihljuootdgvpfuasiihgwmloksemfjrhehpbkewwnvtrqaobyxveslaqnhhuiumnarluonoyomcdpcomzywgfavrivobpjqtswbkuiwmvrchpzpdigplvssztivonbthxpnnrbklygaxhgpemsnhlddafdmjyzchppcytduxmmqztvbtfwgzwultntxkrshdhvslxltrufdihrlmizyfitarcttovrvfpbdnsutlfwdgeeckxqxyrydyfehyvygoneeacizwgfpulsgrbacoefmjzpfqaicziykarmilenpccpeedaycbcryzqbzgcdyclujcuxgwjoiniefjsetmpzrfqxxcgujxxodqkmhjnjgljdyhspxcpayupfhnuhsowaztxdfcnkkkskdryngwqatuselcznwgqdvkpbpudgutnqiodxhjcusowpmbaaqqmhyvgcvfkfilriinohmdgktwvqppbwneywtjsnlsiedyydfiykjzfymddeoxjiovcygsptvnjdkxocgwksfqvditgrdhnwqklqttiltysuzvxbldqmdivcgaueiguinlyvmyvajjiufpftwxcjrrnbjfaluambamqktsrpanclzykkqbfidvbwrwoxrrmdkclzfjixqhdzwvgezzviymathbapwmzmqrtebqlwmixogocluawodxnujfoaoksyyzwbmzwecfacpguefegvvtbkfmtwxndwocvygsbdwirgjvtncjkoyowwrmajfomlwhaayzogycktogvajjydxnwggmrpfahxxqutcyclmnfzehmypwfvdvuyscuvsgpyzlqvhebpfukortotyzpbtofjwwbkhfjptuvwhbyiatchidlauikivcoqffvbonezgvotwhyedmsibygporrhfydtyvsvktwlwiuvjfqcxqatwrzwsmkmcrgetyscdakgcjegtuhnuzzakcypffpddocvascxxaqultgdozddiyqsjunamjxjlahkmxyokkgxsgcgpxfoboipoxxwppqsverzzzqlclugfbryakyhdgvincgluflcsmbhlndjdmvnpxobkiagxyuvgyteewvroleltwvctcojymrntxwxyzfkbnladccnlsbjfbxivulifwjqimjpwnyfkdtssonefxdxsjzoplesphvefkiciuvfbknqhwfuqnoymshwxvypspkacaliwnufjdddsmzvexdgldsaumuciwlpihkhsfjrcmduugsepzlzoltiivqqbahgfrfmtxoahxebjhktldchcshbivjyoiikisucqwtqdwhmjnhmdcxasjhwugdlkowqvemamlwdhueaieuhfghekwfamhzonqtaqlgmfrlsaixvbhowpljmuynnwbhajhdhbhsnaouabvebegobidlymtpxoxfjylgrufagnidcyvzoafbyuwouqzslmfxghvppvgmffcapomoyxblsuocomllbomxvcdhknbuqpilqzbdtvruevwzjffbtdoszfmmxrcchrwxfjywanrhfxkwjvyrbpemcvnaphfcknzfostvlvmeflljojsthvoqzmgspexgiayrynmrcosjvhpqjoyiiwwndcthrersxfljsryrkjfaplgrdjyvavdmlibhrglobobhtxcvzucpwfivksuryjyylqbcnzukalxqciptddfkmscsjclesnrapmbnoqvltposgdeazadghjbdizmjooayuxghcfljjiahamwhjrgeoqgdfdaojrxjmddysvgqjjcwopjlsrsqtylhkjyrctnmqmremxlwbutidompuvfobyfqjktqxvhflwzwzhvdhqdcybgqiiyvxnghootaotjjidwldwgspwrfezwpkuqvjncbvqeojsefzidcnyfnlxvryznzkevpylbzrblyjscydjdkstssylsdeqjhairetalwrwivksbtlfsbgkndafphmuksfvchwxfzssjqcmwajdkhlwblaoihnrnklaifkraelhycnfszlyolyskqdhpabqsnlssesoftuawttlogyorgugfvfdgnkiykedtzcilizhtamnxyqhckmysjzxaghtnxnztxlloqkyzrgjlboprhvxadhxlhocpddtjilzlikviskelsqhkvnpaomqmpmasciijoxpnvgrsidbjuhtkoggaqthgdnqgywycbrsamiyvckjtjphwpuduatkdbjuxwgkhxpqlcutvijremtygsjerljgcwniemvgaisakycvbsaceprtxkvmzhuajbxfjjeoydagtexxwjmmimg',
            'address' => [
                'city' => 'hyznngepmrznsoskxwfccnvrxqwvyceifefaxyvqufdrqebkhsmqqvtolwflwwcxkyowjccveivqvestmhzksdnvoisluzglwnvydncpqx',
                'house_number' => 'mzzkqdlbzssftujwjsoatxgffqlvjwvxjxzaisqfxplcnfwdiradutlyakgfcdwnyykpiejkihnsbmrudsprvhnnqsqidxzsfdopuwgginxhijaglnwlmjvflgrwbxbjufevrysynsotxggjhvckitysuexvkpllbmstlytmgmfvwwuvogijvepbpjkwjhoxpfendtngwtyiigohxcaermfnmkpnoknfvulrhxzbssjcdq',
                'postal_code' => 'vkqpudxiqbovbneggxtubnvwsmtvymxgzofefaafjgmwreadeviggtoswjwxxwymqrxwcmbwjnmrttkeuctmdvdlssnpfqiqukbsrfdlcjxdqvlbwrehbvgylnqujvrkycdojnjtanuvpwgxzixojxetpyyuprjxlfeermdebwudsdmgrfubqihcajjhqmdsoswifkau',
                'street' => 'curtgqkqlxnqwssqhlettqwnnvfdnarfluekdmoxroherlqrnycvpbkogmaozmtaukujbixhexoxhkjvijgfktlemegtmysntzwytfdhunebhvuuqdjkbntrxqihionu',
            ],
            'customer' => [
                'email' => 'vgnzaxgtojhtayczhpybgxfotmkhjdljrvfmqzpcyrcmmgatkttaywubmodpbidpwbmgxeiuagwtdlthddruufarfbbjgkaudxnyifcvjnmzmmbutzbqbubphbrbvpilyetsmgigakvflgdhtvconeeekoqkgafreshzpdwkdhqsfoesbbwdrpfclhlnikkwbkg',
                'name' => 'wdbrrgzkcxntwkipwqwupdakuxaeqzmhwsudowriwwqimhwnwynhqrgvvvoxxzfnahlplelwvyiodccxuefgqu',
                'phone_number' => 'qvqqfcvbcbiugpsnvdwnmjm',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


{
    "id": 22347,
    "type": "delivery",
    "track_trace_token": "ttHVKvrA5PzR",
    "company_id": 2048,
    "address_id": 386414,
    "customer_id": 28974,
    "external_identifier": "TEST-R",
    "note": null,
    "pending_payment_amount": null,
    "delivery_from_date": null,
    "delivery_date": "2022-06-30 00:00:00",
    "start_time": "10:00:00",
    "end_time": "10:15:00",
    "delivery_duration_minutes": 0,
    "return_required": false,
    "signature_required": false,
    "signature_encoded": null,
    "used_capacity": 0,
    "delivered_at": null,
    "custom_fields": null,
    "return_task_id": null,
    "notification_template_id": null,
    "send_notification_at_time": null,
    "send_notifications_at": null,
    "created_at": "2022-06-16 11:44:48",
    "updated_at": "2022-06-16 11:44:48",
    "deleted_at": null,
    "formatted_start_time": "10:00",
    "formatted_end_time": "10:15",
    "delivery_from_date_short": null,
    "delivery_date_short": "30-06",
    "formatted_send_notification_at_time": "",
    "address": {
        "id": 386414,
        "street": "Hanzeplein",
        "house_number": "11",
        "house_number_extension": null,
        "postal_code": "8017 JD",
        "city": "Zwolle",
        "country_id": 1,
        "latitude": "52.5032046",
        "longitude": "6.0814869",
        "hash": "363dd61f6d248276e098518d20cad94a",
        "created_at": "2022-06-16T09:44:48.000000Z",
        "updated_at": "2022-06-16T09:44:48.000000Z",
        "address_line": "Hanzeplein 11",
        "full_address_line": "Hanzeplein 11, 8017 JD, Zwolle",
        "country": {
            "id": 1,
            "iso_code": "NL",
            "description": "Nederland"
        }
    }
}
 

Example response (404):


{
    "message": "No query results for model ..."
}
 

Example response (403, Missing API key):


{
    "message": "Access token missing"
}
 

Example response (403, Invalid API key):


{
    "message": "Access token invalid"
}
 

Example response (403, Subscription does not support API access):


{
    "message": "Required subscription is not active"
}
 

Request      

PUT api/v1/tasks/{id}

PATCH api/v1/tasks/{id}

URL Parameters

id  integer  

The ID of the task.

Body Parameters

type  string optional  

Must be one of delivery or pickup. Default: delivery. Must be one of delivery or pickup.

delivery_date  string  

The date on which the order must be picked up or delivered, in format: Y-m-d (example: 2022-07-22). Must be a valid date.

delivery_from_date  string optional  

The date from which the order can be picked up or delivered. (This makes it possible to specify a date range in combination with delivery_date). In format: Y-m-d (example: 2022-07-22). Must be a valid date. Must be a date before or equal to delivery_date.

start_time  string  

Start of the delivery or pickup period. Must be a valid date in the format H:i.

end_time  string  

End of the delivery or pickup period. Must be a valid date in the format H:i. Must be a date after start_time.

delivery_duration_minutes  number optional  

Time the driver needs to deliver or pickup the package. Must be at least 0. Must not be greater than 1440.

external_identifier  string optional  

The number that is used in your system to recognize the order, for example an order number. We also make sure that no duplicate task are loaded based on this field, so make sure it is a unique for this task. Must not be greater than 250 characters.

used_capacity  number optional  

The necessary capacity (e.g. m³ or number of crates) in the vehicle (is taken into account in planning). Must be at least 0. Must not be greater than 1000000.

signature_required  boolean optional  

Should the driver provide a signature upon delivery or pickup. Default: false.

return_required  boolean optional  

Should the driver plan a return in the future upon delivery or pickup. Default: false.

note  string optional  

Optional note, visible for the driver. Must not be greater than 20000 characters.

notification_template_identifier  string optional  

Identifier of the notification template to be used for notifications to the customer. Default: Company default template.

address  object optional  

address.city  string optional  

This field is required when address is present. Must not be greater than 250 characters.

address.country  string optional  

Must be one of the accepted country ISO codes, e.g. NL. This field is required when address is present.

address.house_number  string optional  

This field is required when address is present. Must not be greater than 250 characters.

address.postal_code  string optional  

Format: 0000AA, 0000, 00000. This field is required when address is present. Must not be greater than 250 characters.

address.street  string optional  

This field is required when address is present. Must not be greater than 250 characters.

customer  object optional  

customer.email  string optional  

Is used (if available) to send an e-mail with a link for track & trace. This field is required when customer is present. Must be a valid email address. Must not be greater than 250 characters.

customer.name  string optional  

This field is required when customer is present. Must not be greater than 250 characters.

customer.phone_number  string optional  

Is used (if available) to send an SMS with a link for track & trace. SMS can only be sent when the phone number starts with 06, +316 or 316. Must be at least 6 characters. Must not be greater than 30 characters.

DELETE task

requires authentication

Delete a single task.

Example request:
curl --request DELETE \
    "https://api.routelogic.io/api/v1/tasks/791" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$response = $client->delete(
    'https://api.routelogic.io/api/v1/tasks/791',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


""
 

Example response (404):


{
    "message": "No query results for model ..."
}
 

Example response (403, Missing API key):


{
    "message": "Access token missing"
}
 

Example response (403, Invalid API key):


{
    "message": "Access token invalid"
}
 

Example response (403, Subscription does not support API access):


{
    "message": "Required subscription is not active"
}
 

Request      

DELETE api/v1/tasks/{id}

URL Parameters

id  integer  

The ID of the task.

GET tasks for a specific date

requires authentication

Example request:
curl --request GET \
    --get "https://api.routelogic.io/api/v1/tasks/date/nam" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.routelogic.io/api/v1/tasks/date/nam',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_API_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response (200):


[
    {
        "task_id": 53642,
        "external_identifier": "TEST-1-R",
        "vehicle_id": 1,
        "delivery_time": "08:00:00",
        "order_index": 1610000000
    },
    {
        "task_id": 53643,
        "external_identifier": "TEST-2-R",
        "vehicle_id": 2,
        "delivery_time": "08:00:00",
        "order_index": 1610000001
    },
    {
        "task_id": 53644,
        "external_identifier": "TEST-3-R",
        "vehicle_id": 2,
        "delivery_time": "08:30:00",
        "order_index": 1600000002
    }
]
 

Request      

GET api/v1/tasks/date/{date}

URL Parameters

date  string  

Date in format yyyy-mm-dd (e.g. 2022-05-15)