ConnectCloud Developers

EGIS suppliers with suggested supplier addresses (tenant:settings:read)

GET /api/trade/v1/itsp/config/egis/suppliers

Module: Trade · operationId: listEgisSuppliers · Tag: Configuration · Auth: access token (Authorization: Bearer <accessToken>)

Responses

  • 200 Suppliers and addresses (application/json)
  • 400 Error (application/json)
  • 401 No valid session or bearer token (no body).
  • 403 Missing permission, no active tenant in the token, or a missing CSRF token on a cookie write. (application/json)
  • 502 A dependent service (DMS, masterdata, a distributor) failed or is unreachable. (application/json)
  • 503 The configuration store is not available. (application/json)

Fields of the 200 answer:

  • microtechAddresses (array of VendorAddressSummary): Supplier addresses of masterdata to choose from.
    • addressNo (integer): Address number in masterdata.
    • city (string): City.
    • country (string): Country.
    • id (string): Masterdata address id.
    • name1 (string): Name (line 1).
    • name2 (string): Name (line 2).
    • street (string): Street and house number.
    • taxId (string): Tax number.
    • vatId (string): VAT identification number.
    • zipCode (string): Postal code.
  • suppliers (array of object): EGIS distributors with the supplier address suggested for each.
    • city (string): City.
    • confidence (string): Confidence of the suggestion: HIGH, MEDIUM, LOW or NONE. (one of HIGH, MEDIUM, LOW, NONE)
    • country (string): Country.
    • currentAddressNo (integer): Address number of the supplier address mapped now.
    • distributorId (string): EGIS id of the distributor.
    • distributorName (string): Name of the distributor.
    • isMapped (boolean): The distributor is mapped to a supplier address already.
    • matchReason (string): Why the address was suggested.
    • name1 (string): Name (line 1) of the distributor at EGIS.
    • name2 (string): Name (line 2) of the distributor at EGIS.
    • street (string): Street and house number.
    • suggestedAddressName (string): Name of the suggested masterdata supplier address.
    • suggestedAddressNo (integer): Address number of the suggested masterdata supplier address.
    • taxId (string): Tax number.
    • vatId (string): VAT identification number.
    • zipCode (string): Postal code.

Example 200 answer:

{
  "microtechAddresses": [
    {
      "addressNo": 70001,
      "city": "Hamburg",
      "country": "DE",
      "id": "6d8f0a12-3c4e-4a5b-9d6f-7e8a9b0c1d01",
      "name1": "Nordlicht IT-Distribution GmbH",
      "street": "Hafenstraße 40",
      "vatId": "DE701000001",
      "zipCode": "20457"
    },
    {
      "addressNo": 70002,
      "city": "Augsburg",
      "country": "DE",
      "id": "6d8f0a12-3c4e-4a5b-9d6f-7e8a9b0c1d02",
      "name1": "Kabelwerk Süd GmbH",
      "street": "Gewerbering 7",
      "vatId": "DE701000002",
      "zipCode": "86167"
    }
  ],
  "suppliers": [
    {
      "city": "Hamburg",
      "confidence": "HIGH",
      "country": "DE",
      "currentAddressNo": 70001,
      "distributorId": "70044",
      "distributorName": "Nordlicht IT-Distribution GmbH",
      "isMapped": true,
      "matchReason": "USt-IdNr. stimmt überein",
      "name1": "Nordlicht IT-Distribution GmbH",
      "street": "Hafenstraße 40",
      "suggestedAddressName": "Nordlicht IT-Distribution GmbH",
      "suggestedAddressNo": 70001,
      "vatId": "DE701000001",
      "zipCode": "20457"
    },
    {
      "city": "Augsburg",
      "confidence": "HIGH",
      "country": "DE",
      "distributorId": "70282",
      "distributorName": "Kabelwerk Süd GmbH",
      "isMapped": false,
      "matchReason": "USt-IdNr. stimmt überein",
      "name1": "Kabelwerk Süd GmbH",
      "street": "Gewerbering 7",
      "suggestedAddressName": "Kabelwerk Süd GmbH",
      "suggestedAddressNo": 70002,
      "vatId": "DE701000002",
      "zipCode": "86167"
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/trade/v1/itsp/config/egis/suppliers' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI