Master-data integration
Loady exposes separate APIs for the basic master data. Create or synchronize dependencies before sending records that reference them.
Recommended order
- Synchronize customers (ship-to-parties) and suppliers through the Business Partners API.
- Synchronize your products through Products v2.
- Synchronize Loading Points and Unloading Points for the corresponding sites and business partners.
- Create or search Lanes only after their referenced entities are available.
IDs and reference numbers
The master-data APIs support Loady IDs, external reference numbers, or both, depending on the operation. Reference-number lookups are intended for ERP synchronization:
- Business Partners and Products are resolved by their reference number within the company selected by
x-company-id. - Loading and Unloading Point reference-number operations also use the site reference number and, for business partner sites, the business-partner reference number.
- ID operations address the Loady resource directly, but are still restricted to the authenticated customer's scope.
Reference numbers must be stable and unique in the scope documented by the operation. Persist returned Loady IDs when they are useful. Do not replace your source-system reference numbers with display names.
Create, update, upsert, and delete
Use POST to create a resource and PUT to replace or update it as documented by the selected operation. Business
Partners additionally provide an explicit reference-number upsert. A failed lookup or create is not permission to
silently create dependencies: surface the error unless the chosen operation explicitly defines upsert behavior.
Deletes can fail when a resource is referenced by assigned products, lanes, or other maintained data. Resolve the reported dependency instead of retrying an unchanged delete. HTTP outcomes and Loady codes are described in Errors.
Request fields
The generated OpenAPI reference is the source of truth for required fields, nested modules, dictionary-backed values, request examples, and response schemas. Use the Dictionaries API for current accepted IDs and the product guide for standardized aliases accepted by Products v2.