Get supplier impact data by identifier
Changed onOverview
Retrieve impact data for a supplier identified by supplierId, customerId, ownId, or prewaveId.
Returns one object with the request identifier and a single impactData row for the resolved edge. When several intervals match, the row with the latest validFrom is returned. Open-ended validTo is null.
Required Permission
access_public_suppliers. When perspectiveId is set, Perspective read is also required.
Request
- Base URLhttps://api.prewave.com
- AuthAPI key in header X-Auth-Token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Supplier ID to search for. Can be combined with customerId, ownId, and/or prewaveId.
Customer ID to search for. Can be combined with supplierId, ownId, and/or prewaveId.
Own site ID to search for. Can be combined with supplierId, customerId, and/or prewaveId.
Prewave ID to search for. Can be combined with supplierId, customerId, and/or ownId.
Optional source system to filter by. If not provided, matches IDs with any source or without a source. Applies to all provided ID parameters.
Perspective used for computed impact fields. Defaults to the caller's active perspective. Requires Perspective read when set.
When set, the resolved edge's fromId must match. Otherwise 404.
When true (default), only the impact interval that contains now is returned.
History window start (UTC). Used when activeOnly=false.
History window end (UTC). Used when activeOnly=false.
Response
Supplier impact data
Example response
{
"identifier": {
"supplierId": "SAP-12345",
"customerId": "CRM-67890",
"ownId": "OWN-SITE-01",
"prewaveId": 102006215,
"source": "SAP"
},
"impactData": {
"atSupplierLocation": "SameBuilding",
"atSupplierDeviation": "OnTarget",
"atSupplierLastConfirmedDate": "2023-11-23T00:00:00Z",
"validFrom": "2026-01-01T00:00:00Z",
"validTo": "2026-12-31T23:59:59Z"
}
}Changes
- info
endpoint added
- info