Skip to main content
Skip table of contents

Integration

This section is intended to configure everything regarding integrating external systems (such as ERP systems) with Aiden WMS. For external systems to send data/documents to Aiden WMS, Tokens are required. To send data/transactions to external systems, Webhooks can be configured.

Tokens

When creating a new token, specify the validity duration in days (default value: 365 days). This will result in the generation of an expiration date, indicating when the token will cease to be valid.

Be sure to set a reminder to replace the token before it expires. This will help ensure that the integration remains intact and does not break.

Please provide a Description to gain a clear understanding of which token is utilized by each external system.

To enhance the clarity and effectiveness of communication with Aiden WMS, it is recommended to create a unique token for each application that transmits data. This approach allows us to accurately identify and analyze the root causes of any issues that may arise.

Integration API

Available Integration API’s for Aiden WMS are documented here: Swagger UI

Simply use your generated (Bearer) Token to Authorize the service to try out.

Webhooks

External systems that need to receive feedback or transactional data from Aiden WMS can be set up using Webhooks. There are several events throughout the Aiden WMS functions, that are able to send out these webhooks. All webhooks will send data in JSON format.

image-20250606-144227.png

Configuration of Webhook

Multiple webhooks can be configured for a single event.

Received from integration

Event: When receiving data (Purchase/Sales Document or warehouses, bins or items) using the Integration API.

Example Success Response:

JSON
{
  "correlation": {
    "correlationId": "2c3c07f0-1307-4613-9a40-70a519dfae47",
    "metaData": {}
  },
  "status": "Succes",
  "statusMessage": ""
}

Example Failure Response:

JSON
{
  "correlation": {
    "correlationId": "94920d41-208e-45c5-947e-7bcf1ac7d5a0",
    "metaData": {}
  },
  "status": "Error",
  "statusMessage": "Unknown warehouse AID"
}

Document notify

Event: When document (Purchase/Sales Document) changed status (for example when task is started in WMS client).

Example Response:

JSON
{
  "documentId": "524",
  "documentType": "PurchaseDocument",
  "status": "Started",
  "user": "Danny Willems"
}

Goods receipt finished

Event: When purchase document is finished from WMS client.

Example Response:

JSON
{
  "transaction": {
    "id": "GR20250610002",
    "type": "GoodsReceipt",
    "createDate": "2025-06-10T08:31:03.747664Z",
    "endDate": "2025-06-10T08:31:37.6054234Z"
  },
  "documents": [
    {
      "documentId": "AID250610103046-0",
      "owner": null,
      "businessPartner": {
        "businessPartnerId": "V20000",
        "name": "Lasercom",
        "customFields": {}
      },
      "receiveDate": "2025-06-10T00:00:00Z",
      "processDate": "2025-06-10T08:31:03.7506447Z",
      "status": "Closed",
      "details": "",
      "user": "Danny Willems",
      "customFields": {},
      "lines": [
        {
          "documentLine": 0,
          "warehouseId": "AID",
          "itemId": "A00001",
          "quantity": 250,
          "received": 250,
          "uomCode": "",
          "status": "Closed",
          "details": "",
          "customFields": {}
        },
        {
          "documentLine": 1,
          "warehouseId": "AID",
          "itemId": "A00006",
          "quantity": 4,
          "received": 4,
          "uomCode": "",
          "status": "Closed",
          "details": "",
          "customFields": {}
        },
        {
          "documentLine": 2,
          "warehouseId": "AID",
          "itemId": "B10000",
          "quantity": 2,
          "received": 2,
          "uomCode": "Pallet",
          "status": "Closed",
          "details": "",
          "customFields": {}
        }
      ],
      "savedLines": [
        {
          "documentLine": 0,
          "quantity": 250,
          "baseQuantity": 250,
          "batchNumber": "",
          "expiryDate": null,
          "serialNumber": "",
          "user": "Danny Willems"
        },
        {
          "documentLine": 1,
          "quantity": 1,
          "baseQuantity": 1,
          "batchNumber": "",
          "expiryDate": null,
          "serialNumber": "S25000339OK",
          "user": "Danny Willems"
        },
        {
          "documentLine": 1,
          "quantity": 1,
          "baseQuantity": 1,
          "batchNumber": "",
          "expiryDate": null,
          "serialNumber": "S25000340OK",
          "user": "Danny Willems"
        },
        {
          "documentLine": 1,
          "quantity": 1,
          "baseQuantity": 1,
          "batchNumber": "",
          "expiryDate": null,
          "serialNumber": "S25000341OK",
          "user": "Danny Willems"
        },
        {
          "documentLine": 1,
          "quantity": 1,
          "baseQuantity": 1,
          "batchNumber": "",
          "expiryDate": null,
          "serialNumber": "S25000342OK",
          "user": "Danny Willems"
        },
        {
          "documentLine": 2,
          "quantity": 1,
          "baseQuantity": 48,
          "batchNumber": "B2025061000001",
          "expiryDate": null,
          "serialNumber": "",
          "user": "Danny Willems"
        },
        {
          "documentLine": 2,
          "quantity": 1,
          "baseQuantity": 48,
          "batchNumber": "B2025061000002",
          "expiryDate": null,
          "serialNumber": "",
          "user": "Danny Willems"
        }
      ]
    }
  ]
}

Delivery finished

Event: When sales document is finished from WMS client.

Example Response:

JSON
{
  "transaction": {
    "id": "DN20250610001",
    "type": "Delivery",
    "createDate": "2025-06-10T08:48:22.5674944Z",
    "endDate": "2025-06-10T08:48:22.5674953Z"
  },
  "documents": [
    {
      "documentId": "AID250610104605-0",
      "owner": null,
      "businessPartner": {
        "businessPartnerId": "AIDC001",
        "name": "McGlynn, Schowalter and Jerde",
        "addressId": "Bijsterhuizen",
        "city": "Wijchen",
        "street": "Bijsterhuizen 2018b",
        "zipCode": "6604CJ",
        "county": "",
        "country": "Netherlands",
        "customFields": {}
      },
      "pickDate": "2025-06-10T00:00:00Z",
      "processDate": "2025-06-10T08:47:41.7534925Z",
      "status": "Closed",
      "details": "<b>Important!</b><br><br>Make sure to use the nice packaging!",
      "user": "Danny Willems",
      "customFields": {},
      "lines": [
        {
          "documentLine": 0,
          "warehouseId": "AID",
          "itemId": "A00001",
          "quantity": 20,
          "picked": 20,
          "uomCode": "",
          "status": "Picked",
          "details": "",
          "customFields": {}
        },
        {
          "documentLine": 2,
          "warehouseId": "AID",
          "itemId": "B10000",
          "quantity": 20,
          "picked": 20,
          "uomCode": "Pak",
          "status": "Picked",
          "details": "",
          "customFields": {}
        },
        {
          "documentLine": 3,
          "warehouseId": "AID",
          "itemId": "A00006",
          "quantity": 3,
          "picked": 3,
          "uomCode": "",
          "status": "Picked",
          "details": "",
          "customFields": {}
        }
      ],
      "savedLines": [
        {
          "documentLine": 0,
          "quantity": 20,
          "baseQuantity": 20,
          "batchNumber": "",
          "serialNumber": "",
          "user": "Danny Willems"
        },
        {
          "documentLine": 2,
          "quantity": 20,
          "baseQuantity": 20,
          "batchNumber": "B2025060300001",
          "serialNumber": "",
          "user": "Danny Willems"
        },
        {
          "documentLine": 3,
          "quantity": 1,
          "baseQuantity": 1,
          "batchNumber": "",
          "serialNumber": "S25000336OK",
          "user": "Danny Willems"
        },
        {
          "documentLine": 3,
          "quantity": 1,
          "baseQuantity": 1,
          "batchNumber": "",
          "serialNumber": "S25000337OK",
          "user": "Danny Willems"
        },
        {
          "documentLine": 3,
          "quantity": 1,
          "baseQuantity": 1,
          "batchNumber": "",
          "serialNumber": "S25000338OK",
          "user": "Danny Willems"
        }
      ]
    }
  ]
}

Stock transfer finished

Event: When stock transfer document is finished from WMS client.

Example Response:

JSON
{
  "transaction": {
    "id": "ST20250610001",
    "type": "StockTransfer",
    "createDate": "2025-06-10T08:50:33.118293Z",
    "endDate": "2025-06-10T08:50:33.1182936Z"
  },
  "documents": [
    {
      "documentId": "ST20250610001",
      "status": "Closed",
      "createDate": "2025-06-10T08:50:23.1752465Z",
      "user": "Danny Willems",
      "getLines": [
        {
          "documentId": "ST20250610001",
          "documentLine": 1,
          "warehouseId": "AID",
          "binId": "AID-BIN-02",
          "itemId": "A00001",
          "baseQuantity": 10,
          "quantity": 10,
          "uomCode": "",
          "uomName": "",
          "batchNumber": "",
          "serialNumber": "",
          "owner": null,
          "user": ""
        }
      ],
      "putLines": [
        {
          "documentId": "ST20250610001",
          "documentLine": 1,
          "warehouseId": "02",
          "binId": "",
          "itemId": "A00001",
          "baseQuantity": 10,
          "quantity": 10,
          "uomCode": "",
          "uomName": "",
          "batchNumber": "",
          "serialNumber": "",
          "owner": null,
          "user": ""
        }
      ]
    }
  ]
}

Put away finished

Event: When put away line is finished from WMS client.

Example Response:

JSON
{
  "transaction": {
    "id": "PA000006",
    "type": "PutAway",
    "createDate": "2025-06-10T08:52:34.2807539Z",
    "endDate": "2025-06-10T08:52:34.2807544Z"
  },
  "documents": [
    {
      "documentId": "PA000006",
      "status": "Closed",
      "warehouseId": "AID",
      "binId": "AID-RCV",
      "createDate": "2025-06-10T08:52:33.8886437Z",
      "user": "Danny Willems",
      "lines": [
        {
          "documentId": "PA000006",
          "documentLine": 1,
          "warehouseId": "AID",
          "binId": "AID-BIN-02",
          "itemId": "A00006",
          "baseQuantity": 1,
          "quantity": 1,
          "uomCode": "",
          "uomName": "",
          "batchNumber": "",
          "serialNumber": "S25000339OK",
          "owner": null,
          "user": ""
        },
        {
          "documentId": "PA000006",
          "documentLine": 2,
          "warehouseId": "AID",
          "binId": "AID-BIN-02",
          "itemId": "A00006",
          "baseQuantity": 1,
          "quantity": 1,
          "uomCode": "",
          "uomName": "",
          "batchNumber": "",
          "serialNumber": "S25000340OK",
          "owner": null,
          "user": ""
        },
        {
          "documentId": "PA000006",
          "documentLine": 3,
          "warehouseId": "AID",
          "binId": "AID-BIN-02",
          "itemId": "A00006",
          "baseQuantity": 1,
          "quantity": 1,
          "uomCode": "",
          "uomName": "",
          "batchNumber": "",
          "serialNumber": "S25000341OK",
          "owner": null,
          "user": ""
        },
        {
          "documentId": "PA000006",
          "documentLine": 4,
          "warehouseId": "AID",
          "binId": "AID-BIN-02",
          "itemId": "A00006",
          "baseQuantity": 1,
          "quantity": 1,
          "uomCode": "",
          "uomName": "",
          "batchNumber": "",
          "serialNumber": "S25000342OK",
          "owner": null,
          "user": ""
        }
      ]
    }
  ]
}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.