Inventory And Pricing Push API
Overview
Waldom's Inventory And Pricing Push API enables customers to receive inventory and pricing updates via server-to-server POST notifications. This real-time feed ensures your systems stay synchronized with the latest product data from Waldom.
Authentication
Customers must provide authentication credentials when enabling the Push API. The following authentication types are supported:
Type | Discreption |
---|---|
API Key Header | A static key sent in a custom HTTP header |
Basic Authentication | username:password Base64 encoded and passed in headers |
Request Format
Waldom will POST updates to the customer's configured endpoint. The request body is an array of up to 20 Inventory And Pricing records. This structure matches the response of the GET version of the InventoryAndPricing API, but sent as a push.
- Content-Type: application/json
- Max Records per Request: 20
- Method: POST
- Protocol: HTTPS required
Example POST Payload
[
{
"Id": "10249120",
"PartNumber": "1622994-1",
"ManufacturerName": "TE CONNECTIVITY/AMP BRAND",
"CustomerPartNumber": "",
"LeadTime": null,
"AvailableInventory": [],
"OnOrderInventory": [],
"MinOrderQuantity": "60000",
"StandardPackQuantity": "5000",
"TotalStockQuantity": 0,
"Description": "Thick Film Resistors-SMD CRG0603 1% 750K",
"UOM": null,
"HTSCode": null,
"Rohs": "Y",
"ExportControlClassificationNumber": null,
"DataSheetLink": "https://www.te.com/commerce/DocumentDelivery/DDEController?Action=srchrtrv&DocNm=1309350_PASSIVE_COMPONENT&DocType=Catalog+Section&DocLang=English&PartCntxt=1622994-1&DocFormat=pdf",
"ImageLink": "http://www.te.com/catalog/common/images/PartImages/prfrcrl.jpg",
"Pricing": {
"Currency": "EUR",
"PriceBreaks": [
{
"PriceBreakQuantity": 60000,
"Price": 0.0017
},
{
"PriceBreakQuantity": 200000,
"Price": 0.0016
},
{
"PriceBreakQuantity": 400000,
"Price": 0.0015
},
{
"PriceBreakQuantity": 1000000,
"Price": 0.0014
},
{
"PriceBreakQuantity": 2000000,
"Price": 0.0013
}
]
}
},
{
"Id": "10249143",
"PartNumber": "1623009-1",
"ManufacturerName": "TE CONNECTIVITY/AMP BRAND",
"CustomerPartNumber": "",
"LeadTime": null,
"AvailableInventory": [
{
"ShipsFromRegion": "USA",
"ShipsFromWarehouse": "RK",
"AvailableDate": "2025-03-28T00:00:00Z",
"Quantity": 100000,
"DateCodes": [
{
"Quantity": 100000,
"DateCode": "2017-07-01T00:00:00",
"CountryOfOrigin": "TH",
"GreenStock": true
}
]
}
],
"OnOrderInventory": [],
"MinOrderQuantity": "60000",
"StandardPackQuantity": "5000",
"TotalStockQuantity": 100000,
"Description": "Thick Film Resistors-SMD CRG0603 1% 910R",
"UOM": null,
"HTSCode": null,
"Rohs": "Y",
"ExportControlClassificationNumber": null,
"DataSheetLink": "https://www.te.com/commerce/DocumentDelivery/DDEController?Action=srchrtrv&DocNm=1309350_PASSIVE_COMPONENT&DocType=Catalog+Section&DocLang=English&PartCntxt=1623009-1&DocFormat=pdf",
"ImageLink": "http://www.te.com/catalog/common/images/PartImages/prfrcrl.jpg",
"Pricing": {
"Currency": "EUR",
"PriceBreaks": [
{
"PriceBreakQuantity": 60000,
"Price": 0.0017
},
{
"PriceBreakQuantity": 200000,
"Price": 0.0016
},
{
"PriceBreakQuantity": 400000,
"Price": 0.0015
},
{
"PriceBreakQuantity": 1000000,
"Price": 0.0014
},
{
"PriceBreakQuantity": 2000000,
"Price": 0.0013
}
]
}
}
]
Retry Behavior
- If the receiving server responds with HTTP 200, the message is considered successfully received.
- Any other response (e.g., 4xx, 5xx, or timeout) may trigger a retry.
- Retry policies (backoff, max attempts) are configurable during onboarding.
- Important: If the success rate (successful responses vs. total attempts) falls below 40%, Waldom reserves the right to temporarily suspend your Push API integration.
How to Request Access
- Submit a request via your CSR to subscribe to our push API.
-
Include:
- HTTPS endpoint URL
- Chosen authentication method
- Authentication details
- Technical contact email
Once validated, Waldom will begin pushing InventoryAndPricing updates directly to your endpoint.