Connect Claude & ChatGPT to AntsRoute

67 tools for AntsRoute

These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.

• book_order_slotVisible to othersBook one of the slots from find_order_time_slots: `unique_search_order_availabilities_request_id`, `date` and `time_slot`. This creates the scheduled order.
• cancel_orderDeletesCancel a order (unique search order availabilities request id). Destructive action; may require approval. API summary: Cancel a search availabilities request if all returned availabilities are useless.
• create_agent_absenceVisible to othersRecord an absence for an agent: `agent_email`, `start_date_time`, `end_date_time`, and optional reason and comments.
• create_customerChanges dataCreate a customer with `last_name` and `address`, plus optional first name, email, phones, opening hours, skills and external ID.
• create_customer_absencesChanges dataCreate a new customer for a customer. Required: items. Search customers first to avoid duplicates. API summary: Create customer absences.
• create_orderChanges dataCreate an unscheduled order in the AntsRoute basket: `type` (service, delivery or collect), `customer`, plus optional items, skills, duration and comments.
• create_productChanges dataCreate a new product. Required: label or reference. Search products first to avoid duplicates. API summary: Create an item type in Antsroute.
• create_scheduled_orderChanges dataCreate an order and schedule it straight away: `type`, `customer`, `open_date` and `schedule_date`, plus optional items, skills and comments.
• create_skillChanges dataCreate a new skill. Required: name. API summary: Create a skill in Antsroute.
• delete_a_service_delivery_collect_by_external_idDeletesPermanently delete a customer by external id. Destructive action; may require approval. API summary: Delete a service/delivery/collect by external id.
• delete_agent_absenceDeletesPermanently delete a absence by absence id. Destructive action; may require approval. API summary: Delete agent absence.
• delete_all_routes_by_dateDeletesPermanently delete a route by date. Destructive action; may require approval. API summary: Delete all routes by date.
• delete_customer_absenceDeletesPermanently delete a customer by customer id 2. Destructive action; may require approval. API summary: Delete customer absence.
• delete_customer_by_antsroute_idDeletesPermanently delete a customer by customer id. Destructive action; may require approval. API summary: Delete customer by Antsroute id.
• delete_customer_by_external_idDeletesPermanently delete a customer by external id. Destructive action; may require approval. API summary: Delete customer by external id.
• delete_customer_documentDeletesPermanently delete a document by file name. Destructive action; may require approval. API summary: Remove an attachment from an order by Antsroute id.
• delete_customer_document_delete_attachment_1DeletesPermanently delete a document by file name. Destructive action; may require approval. API summary: Remove an attachment from an order by external id.
• delete_orderDeletesDelete an order by its AntsRoute ID (passed as `customer_id`); set `cancel_if_route_started` to allow it on a started route. Cannot be undone.
• delete_productDeletesPermanently delete a product by reference. Destructive action; may require approval. API summary: Delete an item type by unique reference in Antsroute.
• delete_routeDeletesPermanently delete a route by date. Destructive action; may require approval. API summary: Delete a route by agent and date.
• delete_skillDeletesPermanently delete a skill by skill id. Destructive action; may require approval. API summary: Delete a skill by id in Antsroute.
• find_order_time_slotsChanges dataFind available time slots for a new order: `type`, `customer` and its details. Returns slots and a request ID for book_order_slot.
• get_a_signature_by_external_idList signatures for a customer. API summary: Get a signature by external id.
• get_agentGet one agent by `agent_email`.
• get_agent_locationGet the last known GPS position of an agent by `agent_email`.
• get_agent_routeGet one agent's route (`agent_email`) for a `date`, with its ordered stops.
• get_an_attachment_by_external_id_and_indexGet one photo for a customer by index. API summary: Get an attachment by external id and index.
• get_customerGet one customer by `customer_id`.
• get_customer_by_external_idGet one customer by the `external_id` from your own system.
• get_customer_custom_field_photoGet one custom field photo for a customer by custom field name. API summary: Get order custom field photo file by Antsroute id.
• get_customer_custom_field_photo_getGet one custom field photo for a customer by custom field name. API summary: Get customer custom field photo file by external id.
• get_customer_custom_field_photo_get_customer_field_photo_file_byGet one custom field photo for a customer by custom field name. API summary: Get customer custom field photo file by Antsroute id.
• get_customer_custom_field_photo_get_order_field_photo_file_by_exGet one custom field photo for a customer by custom field name. API summary: Get order custom field photo file by external id.
• get_customer_photoGet one photo for a customer by index. API summary: Get an attachment by Antsroute id and index.
• get_customer_status_link_trackingGet the current status of a customer by external id. API summary: Get tracking link of an order by external id. Can return empty link if the order is in the order basket ( CREATED state ).
• get_orderGet one order by its AntsRoute ID (passed as `customer_id`).
• get_order_by_external_idGet one order by the `external_id` you gave it in your own system.
• get_order_order_reportGet one order report for a order by report id. API summary: Get an report by Antsroute id.
• get_order_signatureGet the signature captured on completion of an order (ID passed as `id_id`).
• get_order_tracking_linkGet the customer tracking link for an order (ID passed as `id_id`) in a given `language`.
• get_referenceGet one reference by reference. Results are paginated. API summary: Get associated deliveries/collects for a package reference.
• get_skillGet one skill by skill id. API summary: Get the skill by id.
• list_agent_absencesList an agent's absences by `agent_email`, optionally between `from` and `to`.
• list_agent_hourly_plansList hourly plans for a agent. Optional filters: from or to. API summary: Get the agent hourly plan by date range.
• list_agent_skillsList skills for a agent. Optional filters: from or to. API summary: Get the agent additional skills plan by date range.
• list_agentsList the field agents (drivers and technicians) with their emails.
• list_customer_ordersList the orders of one customer (ID passed as `id_id`), filtered by `states` and date range.
• list_customer_orders_get_customer_orders_by_external_idList orders for a customer. Optional filters: min date, max date or states. Results are paginated. API summary: Find list of services/deliveries/collects by customer external id with criteria.
• list_customersList customers with paging and sorting.
• list_customers_2List customers for a customer. Optional filters: from or to. API summary: Get customer absences.
• list_item_typesList the item types (products) you deliver or collect, searchable by `search_terms`.
• list_ordersList orders (services, deliveries and collects), filtered by `states` and schedule date range (`min_date`, `max_date`), with paging.
• list_routes_by_dateList all agents' routes for a `date`, with their ordered stops.
• list_skillsList the skills that can be required on orders and assigned to agents.
• schedule_orderChanges dataSchedule an order (ID passed as `id_id`) on `scheduled_date` (yyyy-MM-dd).
• search_orders_indexedSearch orders by filter. Use this to find existing orders before creating a new order. API summary: Get a service/delivery/collect by searchTerm in indexed custom field.
• unschedule_ordersVisible to othersTake one or more orders (`order_ids`) off the schedule and back to the basket.
• update_agentVisible to othersUpdate an existing agent identified by agent email. Only the fields you pass are changed. Has effects visible outside this system. API summary: Update agent by email.
• update_agent_absenceVisible to othersUpdate an existing absence identified by absence id. Has effects visible outside this system. API summary: Update agent absence.
• update_agent_hourly_plansDeletesUpdate an existing hourly plan identified by agent email. Destructive action; may require approval. API summary: Update or create agent hourly plan in Antsroute.
• update_agent_skillsDeletesUpdate an existing skill identified by agent email. Destructive action; may require approval. API summary: Update or create agent additional skills in Antsroute.
• update_customer_absenceChanges dataUpdate an existing customer identified by customer id 2. API summary: Update customer absence.
• update_order_by_external_idChanges dataUpdate an existing customer identified by external id. Only the fields you pass are changed. API summary: Update order by external id.
• update_order_commentsChanges dataUpdate the `comments` of an order by its AntsRoute ID (passed as `customer_id`).
• update_productChanges dataUpdate an existing product identified by reference. API summary: Update an item type in Antsroute.
• update_routeVisible to othersUpdate an existing route identified by date. Has effects visible outside this system. API summary: Create route by agent, date and list of orders.
• update_skillChanges dataUpdate an existing skill identified by skill id. API summary: Update a skill in Antsroute.

Questions