> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/pro/automation/connectors/equipme-pro.md).

# equipme connector – Pro modules

The equipme connector for providers: the "Equipme Pro" module with triggers and actions for customers, services, offers, service instances, orders, fulfillment, purchasing, billing.

With the **equipme connector**, you connect Equipme Pro in [workflows](/pro/automation/workflows.md) with your other systems – such as ERP, PSA, warehouse management, distributor or shipping service. For providers, there is a dedicated **"Equipme Pro"** module. It works at the provider level and accesses the data of **all your customers**.

**Examples:**

* New customer order in Pro → create the order in the ERP
* New fulfillment position → create a picking order in the warehouse system → report the status back to Pro
* Shipment in the warehouse system → create a parcel with tracking number in Pro → the customer sees the delivery status
* New customer in the CRM → create the customer in Pro, take over locations and contacts
* Price change at the distributor → update the product's purchasing offer in Pro

## Modules

The equipme connector consists of several modules. Each module appears as a separate tile in the flow designer.

| Module                                                                          | Content                                                                                                                                                                                               | Documentation                           |
| ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| **Equipme Pro**                                                                 | Provider functions: customers and their organization, services, offers, service instances, customer orders, fulfillment, parcels, purchase orders, product master data, billing, order authorizations | this page                               |
| **Equipme**, **Equipme Approval**, **Equipme Operations**, **Email**, **Forms** | Functions for your own organization (employees, locations, groups, assets, approvals, tickets) as well as sending emails and forms                                                                    | see customer guide, "equipme connector" |
| **Equipme Integration**                                                         | Retrieve individually configured reports (e.g. a commission report) as a list                                                                                                                         | only after setup by equipme             |

{% hint style="info" %}
The **Equipme**, **Equipme Approval**, **Equipme Operations**, **Email** and **Forms** modules work in Pro exactly as in the customer portal and relate to your **own** organization. Their triggers and actions are described in the customer guide and are not repeated here.
{% endhint %}

## Prerequisites

* The enabled [automation module](/pro/automation.md)
* An **API key** from Equipme Pro (see [Integrations → "API key"](/pro/administration/integrations.md#api-key))
* The **"Administrator"** role in Pro to manage API keys

## Setting up the connection

1. In Pro, under **"Administration" → "Integrations" → "API key"**, generate an API key and keep it safe – like a password.
2. In the flow designer, drag a component of the "Equipme Pro" module onto the canvas (e.g. *List Customers*).
3. Click **Connect account** and enter:
   * **Label** – a freely selectable name for the connection (e.g. "Pro Production")
   * **API Key** – the API key from Pro
4. The connection is verified. It is then available in all components of the equipme connector and appears under **"Accounts"**.

{% hint style="warning" %}
The API key must come from **Equipme Pro** (provider level). An API key from a customer portal only gives access to that one customer's data; the Pro components then return no or incomplete results.
{% endhint %}

## Basic concepts

The basic concepts are the same as for the customer connector (see customer guide):

* **Triggers** (names start with *New …*) regularly poll Pro for new entries and can be filtered by date (*After*) and other criteria.
* **Actions** read or change data (*List …*, *Get …*, *Search …*, *Add …*, *Update …*, *Set …*, *Remove …*, *Delete …*).
* **List actions** offer the **Output Type** setting ("All items at once", "One item at a time", "First item only", "Store to CSV file").
* **Metadata** (key/value) stores identifiers from third-party systems, e.g. the ERP customer number on the customer or the ERP order number on the service instance.
* **Request limit:** 10 requests per second per API key; the connector observes it automatically and retries requests up to three times if it is exceeded.

## "Equipme Pro" module

### Triggers

| Component                 | Fires when …                                                     | Filters                                                           |
| ------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------------- |
| New Customer              | a new customer is added                                          | After                                                             |
| New Sales Order           | a customer places a new order with you                           | Customers, After                                                  |
| New Fulfillment Order     | a new fulfillment position is created                            | Customers, Service categories, Services, Transaction types, After |
| New Fulfillment Parcel    | a new parcel is created                                          | After                                                             |
| New Dropshipping Order    | a new purchase order (dropshipping) with the supplier is created | After                                                             |
| New Invoice               | a new invoice is generated                                       | After                                                             |
| New Authorization Request | a customer requests order authorization                          | Customers, Type ("Order authorization"), After                    |

**Transaction types** ("Transaction types") for fulfillment positions: "Order", "Delivery Request" (call-off), "Return", "Change", "Swap" (exchange), "Cancellation".

### Customers and their organization

| Area               | Actions                                                                                                               |
| ------------------ | --------------------------------------------------------------------------------------------------------------------- |
| Customers          | Add / Update / Get / List Customers, Get / Update Customer Metadata                                                   |
| Customer employees | Add Customer Employee, Get / List Customer Employees, Get / Update Customer Employee Metadata                         |
| Customer locations | Add / Get / List / Search Customer Locations, Add Customer Location Managers, Get / Update Customer Location Metadata |
| Customer groups    | Get / List Customer Groups, Get / Update Customer Group Metadata                                                      |

*Add Customer* creates a customer with name, customer number, description, status ("Active"), the three [customer attributes](/pro/administration/supplier-profile.md#customer-attributes-tab), contact person (name, email, phone), language, account manager, and company and billing address. *List Customers* filters by names, customer numbers and status. *List Customer Locations* can additionally be restricted to location types ("Location", "Home office"); a location's warehouses are always included.

### Services and offers (service portfolio)

| Area                           | Actions                                                             |
| ------------------------------ | ------------------------------------------------------------------- |
| Services                       | Add / Update / Remove / Get / List Services, Set Service Attributes |
| Offers                         | Add / Update / Remove / Get / List Service Offers                   |
| Categories                     | Get / List Service Categories                                       |
| Customer-specific service data | Get / Update Customer Service Metadata                              |

### Service instances

| Area              | Actions                                                                                             |
| ----------------- | --------------------------------------------------------------------------------------------------- |
| Service instances | Add / Update / Get / List Service Instances, List Customer Service Instances                        |
| Metadata          | Get / Set Service Instance Metadata (all), Get / Set Service Instance Metadata Entry (single entry) |
| Attachments       | List / Get / Download / Upload / Delete Service Instance Attachments                                |

*Add Service Instance* records an active service instance directly at the customer – with offer, customer, location, group or employee, inventory number, one-time and recurring costs, term, renewal, activation and expiration date, and metadata. This is useful, for example, for taking over existing inventory data. *List Service Instances* filters by services, customers, locations, groups, employees and status. Attachments can only be deleted by the company that uploaded them.

### Customer orders and order authorization

| Area                 | Actions                                                                                             |
| -------------------- | --------------------------------------------------------------------------------------------------- |
| Customer orders      | List Sales Orders (filters: Customers, Status "New", "In Process", "Processed", "Cancelled", After) |
| Order authorizations | Get / List / Update Authorization Requests                                                          |

With *Update Authorization Request*, you set a request to "In process", "Approved" or "Denied", optionally with a note – e.g. after an automated credit check. What order authorization means for the customer is described in [Creating and inviting customers](/pro/customers/create-and-invite-customers.md).

### Fulfillment and parcels

| Area                  | Actions                                                                 |
| --------------------- | ----------------------------------------------------------------------- |
| Fulfillment positions | Get / List / Update Fulfillment Orders, Update Fulfillment Order Status |
| Parcels               | Add / Get / List / Update Fulfillment Parcels                           |

*List Fulfillment Orders* filters by customers, service categories, services, transaction types, status, order number, external IDs and time period.

*Update Fulfillment Order Status* performs a status step:

| Action                                                | Meaning                                        |
| ----------------------------------------------------- | ---------------------------------------------- |
| Process                                               | Start processing the position                  |
| Dispatch Delivery                                     | Ship the delivery                              |
| Reject Delivery                                       | Report that delivery is not possible           |
| Confirm Delivery                                      | Confirm delivery                               |
| Process Returned Item                                 | Process the returned item                      |
| Complete                                              | Complete the position                          |
| Complete return by decommissioning the affected asset | Complete the return and decommission the asset |
| Cancel                                                | Cancel the position                            |

Which steps are allowed for a position depends on its current status and the stored process (see [Fulfillment](/pro/fulfillment.md)).

*Add Fulfillment Parcel* creates a parcel for specific fulfillment positions – with delivery and sender address, delivery note number, shipping carrier ("Carrier"), recipient, reference, external ID, status, expected and actual delivery date, tracking number and tracking link. Parcel status: "New", "Ready", "In Transit", "Delayed", "Delivered", "Picked Up", "Failed", "Refused by Recipient", "Returned-to Sender", "Cancelled".

### Purchasing (dropshipping orders)

| Area            | Actions                                                                   |
| --------------- | ------------------------------------------------------------------------- |
| Purchase orders | Get / List / Update Dropshipping Orders, Update Dropshipping Order Status |
| Order items     | List Dropshipping Order Items, Update Dropshipping Order Item Status      |

Status steps for orders and items: "Confirm", "Process", "Dispatch Delivery", "Reject Delivery", "Confirm Delivery", "Complete", "Cancel". This lets you automatically report, for example, a distributor's order confirmation or shipment back to Pro (see [Orders](/pro/procurement/purchase-orders.md)).

### Product master data

| Area              | Actions                                     |
| ----------------- | ------------------------------------------- |
| Products          | Add / Update / Get / List Sourcing Products |
| Purchasing offers | Add / Update / Get / List Sourcing Offers   |
| Suppliers         | Get Sourcing Supplier                       |

*Add Sourcing Product* creates a product with name, description, EAN, manufacturer part number ("Part number"), manufacturer, category, source, external ID, stock item flag, minimum stock, supplier, purchase price, stock level and sales price. Duplicate part numbers are only allowed with "Allow duplicate part number". See also [Product master data](/pro/portfolio/products.md).

### Billing

| Area          | Actions                  |
| ------------- | ------------------------ |
| Invoices      | List Invoices            |
| Billing items | Add / List Billing Items |

*Add Billing Item* creates an additional billing item with type ("Fee", "Tax", "Refund", "Discount", "Credit"), cycle ("None", "Daily", "Weekly", "Biweekly", "Monthly", "Annually", "Triennial"), reference (Resource ID), description, period, rate, quantity and note. *List Billing Items* filters by customers, invoices, type, status and period. See [Billing](/pro/sales/billing.md).

## Example: Creating new customers from the CRM

1. **Trigger:** new entry in the CRM (CRM connector or webhook).
2. **Equipme Pro › List Customers** with the customer number to avoid duplicates; use a **filter** to continue only if no match was found.
3. **Equipme Pro › Add Customer** with name, customer number, contact person, language, account manager and addresses.
4. **Equipme Pro › Update Customer Metadata:** save the CRM ID as metadata.
5. **Email › Send Email:** notify the responsible account manager.

## Troubleshooting

| Problem                                         | Cause / solution                                                                                                                                             |
| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| "Connect account" fails                         | Check the API key (typo, expired, deleted, key from a customer portal instead of from Pro).                                                                  |
| Pro component returns no customers or positions | The API key does not come from Pro, or filters (Customers, After, Status) are too restrictive.                                                               |
| Status change is rejected                       | The requested step is not allowed in the current status (e.g. "Complete" before "Dispatch Delivery"). Check the current status with *Get Fulfillment Order*. |
| Error message about the request limit           | Too many parallel flows with the same API key. Stagger the flows or use *One item at a time* with a delay.                                                   |
| Action returns "403/Forbidden"                  | The API key lacks permission for this resource, or the record does not belong to your customers.                                                             |
| Required field missing / invalid value          | Observe field lengths and formats (e.g. email format, ISO date, allowed values).                                                                             |

The logs under **"Insights"** help with errors. For assistance, contact [Support](/pro/help/support.md) and include the flow name, component and error message.

## Frequently asked questions

**Do I need two connections for Pro and for my own company?**

No. The API key from Pro applies to all modules of the equipme connector. The Pro components work with your customers' data, the other modules with your own organization.

**Can a flow place orders on behalf of a customer?**

No, the "Equipme Pro" module covers the provider side (receiving, delivering and billing orders). Orders are placed by the customer in their customer portal.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://hub.equipme.io/pro/automation/connectors/equipme-pro.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.