List Product Routes

GET {{baseUrl}}/products/routes

This API returns all the routes of the products linked to a distributor.

Request Params

Clients should anticipate that the value of this parameter may not be honored by the API, and should rely exclusively on the contents of the items_per_page response element in calculating actual page size. | | start_index | number | | [PAGING] Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?start_index=200. | | page | number | | [PAGING] Page-based paging - Allows user's to jump directly to a specific page within the items. This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The page_index and total_pages properties are used for this style of paging. |

RESPONSES

status: OK

{"api_version":"3.4.0","data":{"current_item_count":10,"items":[{"route_active":true,"route_id":"ROUTEID123456","route_name":"Green Route","route_description":"in ea Duis nisi quis","route_color":"#FF0000","route_type":"DRIVING","route_start_time":"09:00:00","route_end_time":"20:00:00","route_duration":90,"route_frequency":8,"route_audio_languages":["en","jp","nl"],"route_live_languages":["en","jp","nl"],"route_products":["PRODUCT_ID_123","PRODUCT_ID_123"],"route_locations":[{"route_location_active":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_latitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_longitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_stopover":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"route_location_active":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_latitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_longitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_stopover":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]},{"route_active":true,"route_id":"ROUTEID123456","route_name":"Green Route","route_description":"Excepteur officia","route_color":"#FF0000","route_type":"DRIVING","route_start_time":"09:00:00","route_end_time":"20:00:00","route_duration":90,"route_frequency":8,"route_audio_languages":["en","jp","nl"],"route_live_languages":["en","jp","nl"],"route_products":["PRODUCT_ID_123","PRODUCT_ID_123"],"route_locations":[{"route_location_active":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_latitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_longitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_stopover":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"route_location_active":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_latitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_longitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"route_location_stopover":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}],"items_per_page":10,"kind":"order","page_index":1,"start_index":1,"total_items":200,"total_pages":20}}