--- title: Active Ants API Integration on Truto slug: activeants category: E-Commerce canonical: "https://truto.one/integrations/detail/activeants/" --- # Active Ants API Integration on Truto **Category:** E-Commerce **Status:** Beta ## MCP-ready AI tools Truto exposes 39 tools for Active Ants that AI agents can call directly. - **list_all_active_ants_status** — Check whether the Active Ants ShopApi is up and running. Requires no authentication and takes no input. Returns: messageCode, message, result. - **list_all_active_ants_settings_gets** — Get the current client configuration settings from Active Ants: the ids, names and codes needed when referring to configuration entities on other endpoints. Returns: mainShippingMethods, shippingMethods, returnShippingMethods, orderTypes, countries, languages, returnReasons, paymentMethods. Takes no parameters; cache the result locally and refresh daily. - **list_all_active_ants_orders** — List all orders placed in Active Ants, with cursor-based pagination. Filter by orderedOn (before/after a date), externalOrderNumber, or reference, and optionally include related orderItems, deliveryAddress, billingAddress, or pickUpPoint. Returns each order's id, type, attributes, relationships, and included resources. - **create_a_active_ants_order** — Create an order with its orderItems and related addresses in Active Ants. Related resources must be supplied under included, with provisional ids for deliveryAddress and billingAddress; optional orderAttachment pdf documents can be included for printing. Returns the created order with id, type, attributes, relationships, included, and links. - **get_single_active_ants_order_by_id** — Get a specific order by the id assigned by Paxon ⸗ Active Ants. Optionally include related orderItems, deliveryAddress, billingAddress, or pickUpPoint via include. Returns the order's id, type, attributes, relationships, included resources, and links. Required: id. - **update_a_active_ants_order_by_id** — Update an existing activeants order by id. The entire order in its desired state must be submitted, since omitted mutable fields may be erased, and an order that is fulfilled in its entirety can no longer be modified. Returns the complete order record including id, type, attributes, relationships, and links. Required: id. - **delete_a_active_ants_order_by_id** — Cancel an activeants order by id. The server cancels each of the order's orderItems, succeeding only for items not yet shipped, so cancellation may be partial. Returns the updated order record including id, type, attributes, relationships, and links. Use include to embed related resources in the response. Required: id. - **delete_a_active_ants_order_item_by_id** — Cancel an orderItem in Active Ants by id; the cancellation fully succeeds only when no shipments fulfil it yet, and is otherwise partial or not applied at all. Returns the orderItem in data (id, type, attributes with remaining quantity, links.self) plus meta.modified, messageCode, and message. Required: id. - **get_single_active_ants_order_item_by_id** — Get a single orderItem in Active Ants by its id. Returns: id, attributes, relationships, links. Required: id. - **create_a_active_ants_order_attachment** — Create an orderAttachment in Active Ants, linking a PDF to an order for printing during picking. Returns the created attachment under data: id, type, filename, contentType, printStrategy, and the order relationship (attachment contents suppressed).type, data.attributes.filename, data.attributes.contentType; attach to an order via data.relationships.order.data.id or… - **list_all_active_ants_shipments** — List Active Ants shipments generated from orders, ordered by id ascending. Returns: id, type, attributes, relationships, included, links. Max 100 per page; shipments older than 90 days are not returned. - **get_single_active_ants_shipment_by_id** — Get a single Active Ants shipment by id. Returns: id, type, attributes, relationships, links. Required: id. Shipments older than 90 days are not returned. - **get_single_active_ants_inbound_by_id** — Get a single Active Ants inbound by id. Returns the inbound resource with id, type, attributes (reference, status, receivedIn, createdOn, checkingOn, completedOn), relationships, included, and links; pass include=inboundItems to embed the related inboundItems. Required: id. - **list_all_active_ants_inbounds** — List Active Ants inbounds ordered by id in ascending order. Returns inbound resources with id, type, attributes (reference, status, receivedIn, createdOn, checkingOn, completedOn), relationships, included, and links. Filter with filter[status][in]; use include=inboundItems to embed the related items. Max 100 per page. - **get_single_active_ants_inbound_item_by_id** — Get a single inboundItem (one received product line within an inbound) in Active Ants by its unique integer id. Returns the record including its id, attributes (quantity, sku, lotNumber, expirationDate), relationships (product, inboundPackingSlipItem), and links. Required: id. - **list_all_active_ants_inbound_packing_slips** — List Active Ants inbound packing slips with their current status. Returns for each slip: id, type, attributes (reference, status, expectedIn, receivedOn, completedOn, comments, metadata), relationships, included, and links. At most 100 slips are returned, none older than 90 days. - **create_a_active_ants_inbound_packing_slip** — Create an inbound packing slip in Active Ants for an inbound expected at one of its warehouses; related inboundPackingSlipItems can be created together via data.included. Returns the created slip: id, type, attributes (reference, status, expectedIn, metadata), relationships, included, links. reference must be unique and not used before; expectedIn must be a valid receiving warehouse; each item… - **get_single_active_ants_inbound_packing_slip_by_id** — Get a single Active Ants inbound packing slip by id along with its current status, optionally with its inboundPackingSlipItems via include. Returns: id, type, attributes, relationships, included, links. Required: id. - **list_all_active_ants_products** — List products in activeants, ordered by id ascending with cursor-based pagination. Returns each product's id, type, links, and attributes including sku, status, name, barcode, stockLevelType, countryOfOrigin, and hsCodes. Filters on sku and barcode are supported and can be combined. Max 100 products per page. - **create_a_active_ants_product** — Create a product in activeants. Returns the created product resource with its id, type, links, and attributes including sku, name, status, stockLevelType, barcode, and hsCodes. The sku and barcode must be unique and never used before in the context of the user. - **get_single_active_ants_product_by_id** — Get a specific Active Ants product by its unique id. Returns the product resource including its id, type, sku, name, status, barcode, dimensions (weight, length, width, height), lot/serial/expiration flags, countryOfOrigin, and hsCodes. Required: id. - **update_a_active_ants_product_by_id** — Update a product in activeants by id. Full replacement, not a PATCH: all properties must be provided or they are erased; sku is immutable and barcode, weight, length, width, and height are only mutable under conditions (409 Conflict otherwise). Returns the updated product with id, type, links, and attributes including sku, name, status, and hsCodes. Required: id. - **create_a_active_ants_product_image** — Add or update the commercial image of a single product in activeants by uploading the raw image file as the request body. Each product can have only one commercial image and the file must be under 10MiB (png, jpg, gif, bmp, webp accepted). Returns a success message whose data contains the product details, not the image itself. Required: product_id. - **create_a_active_ants_return_merchandise_authorization** — V3/returnMerchandiseAuthorizations. Returns: id, type, attributes, relationships, included, links. - **get_single_active_ants_return_merchandise_authorization_by_id** — V3/returnMerchandiseAuthorizations/:id. Returns: id, type, attributes, relationships, included, links. Required: id. - **update_a_active_ants_return_merchandise_authorization_by_id** — V3/returnMerchandiseAuthorizations/:id. Returns: id, type, attributes, relationships, included, links. Required: id. - **delete_a_active_ants_return_merchandise_authorization_by_id** — V3/returnMerchandiseAuthorizations/:id. Required: id. - **list_all_active_ants_return_items** — List return items that have been processed by one of the Active Ants warehouses; returns delivered but not yet processed are excluded. Returns: id, type, attributes, relationships, links. Supports filtering on processing date; at most 100 items per page. - **list_all_active_ants_stocks** — List Active Ants stock records — products at a stock location sharing characteristics such as lotNumber and expirationDate. Returns: id, type, attributes, relationships, included, links. Max 100 records per page; ordered by id ascending. - **get_single_active_ants_stock_by_id** — Get a single Active Ants stock record by id. Returns: id, type, attributes, relationships, included, links. Stock is transient and may be moved at any time — avoid persisting stock ids. Required: id. - **list_all_active_ants_stock_levels** — List stock levels across all products in Active Ants, ordered by product id. Returns: id, type, attributes, relationships, links.product, links. Max 100 per page. - **get_single_active_ants_stock_level_by_id** — Get the stock levels of a single product in Active Ants by id; the stockLevel id matches the product id. Returns: id, type, attributes, relationships, links.product, links. Required: id. - **list_all_active_ants_stock_mutations** — List Active Ants stock mutations sorted in ascending order by creation date. Returns: id, type, attributes, relationships, links. No required parameters. At most 100 mutations per page and only mutations newer than 7 days are returned; shipment-related and damaged-return mutations are excluded (use the shipments endpoint instead). - **list_all_active_ants_webhooks** — List all webhooks registered in Active Ants, ordered by id ascending. Returns webhook records including id, type, and attributes (entity, event, isActive, targetUrl). At most 100 records are returned per page. - **create_a_active_ants_webhook** — Register a new webhook in Active Ants for a specific eventType. Returns the created webhook record including id, type, attributes (event, isActive, targetUrl, secretKey), and links. Only valid entity/event pairs are supported. - **get_single_active_ants_webhook_by_id** — Get a single registered webhook in Active Ants by id. Returns the webhook record including id, type, and attributes (event, entity, isActive, targetUrl, secretKey). Required: id. - **update_a_active_ants_webhook_by_id** — Update the targetUrl and enabled state (isActive) of an existing webhook in Active Ants. Returns the updated webhook record including id, type, attributes (event, isActive, targetUrl, secretKey), and links. entity and event cannot be modified with this operation — create a new webhook and delete this one instead. Required: id. - **delete_a_active_ants_webhook_by_id** — Delete a registered webhook in Active Ants by id, completely removing it. Returns an empty 201 response on success. Required: id. - **create_a_active_ants_token** — Create a bearer token in activeants by exchanging the client's username and password. Returns: access_token, token_type, expires_in, userName, issued, expires. Requires grant_type, username, and password. Store and reuse the token until it expires; request a new one if it is invalidated early (401). ## How it works 1. **Link your customer's Active Ants account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach Active Ants.** The Proxy API is a 1-to-1 mapping of the Active Ants API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Route DTC orders to Active Ants fulfillment centers** — OMS and multi-channel commerce platforms can push approved orders from Shopify, Amazon, and B2B portals directly to Active Ants for pick-and-pack, then stream shipment and tracking data back to storefronts via webhooks. - **Keep storefront inventory in sync with warehouse stock** — Inventory and listing platforms can pull absolute stock levels and delta stock mutations from Active Ants to prevent overselling across sales channels without hammering the API. - **Automate returns intake and refund triggers** — Returns management SaaS can create RMAs in Active Ants when shoppers initiate returns, then poll return items to detect physical receipt and trigger refunds automatically once the warehouse processes the goods. - **Streamline inbound receiving from suppliers** — Purchasing and demand forecasting tools can push expected PO quantities to Active Ants as inbound packing slips so warehouse staff and robots can anticipate incoming freight and reduce dock-door delays. - **Sync cross-border product catalogs to the 3PL** — Catalog and PIM platforms can push SKUs, dimensions, HS codes, and country of origin to Active Ants, ensuring customs-compliant fulfillment across the UK, NL, BE, DE, and FR. ## What you can build - **End-to-end order creation and lifecycle sync** — Create orders in Active Ants, fetch them by ID, update or cancel them, and reconcile status changes back to your platform. - **Shipment and tracking webhooks** — Register Active Ants webhooks to receive shipment events in real time and push tracking numbers and carrier data back to merchants' storefronts. - **Real-time stock parity engine** — Combine stock level snapshots with rolling stock mutation deltas to maintain accurate inventory across channels without persisting volatile stock record IDs. - **Branded pack-ins and custom invoices** — Upload PDF order attachments that get printed at the physical packing station, letting merchants ship with branded invoices, flyers, or custom documentation. - **RMA workflows with automatic refund triggers** — Create, update, and cancel return merchandise authorizations, then poll return items to detect warehouse receipt and trigger downstream refund logic. - **Inbound packing slips for supplier POs** — Push expected inbound shipments with SKU and quantity details so Active Ants warehouses can prepare receiving workflows ahead of truck arrival. ## FAQs ### How does authentication work for Active Ants? Active Ants uses Bearer token authentication, where a token is generated by exchanging username and password credentials. Truto handles this token exchange and refresh for your end users so you never touch raw credentials. ### Can we update orders after they've been created? Yes, but Active Ants treats order updates as full replacements (PUT), not partial patches. Any mutable field omitted during an update will be erased, and orders that are already partially fulfilled cannot be modified. ### How should we handle inventory data from Active Ants? Active Ants exposes both absolute stock levels and a rolling 7-day stock mutations audit trail. Stock records are highly transient, so the API explicitly warns against persisting the underlying stock record IDs — treat them as ephemeral and reconcile using SKU. ### How do we stay in sync with shipping methods and order types? Active Ants exposes a settings endpoint that returns the current configuration mapping for shipping methods, order types, and return reasons. These IDs should be cached locally and refreshed daily to prevent order creation failures from stale codes. ### How do we receive real-time events like shipment updates? You can create, list, update, and delete Active Ants webhooks per connected account. Truto normalizes webhook delivery so you can subscribe to shipment and inventory events without building per-tenant webhook infrastructure. ### Does the integration support cross-border customs data? Yes. When creating or updating products, you can pass dimensional data along with HS codes and country of origin, which Active Ants requires for cross-border fulfillment across its UK and EU centers. ### What pagination model does Active Ants use? Active Ants uses cursor-based pagination across its list endpoints. Truto abstracts cursor handling so you can iterate through orders, shipments, products, and stock data with a consistent interface.