Infusion’s API is made up of four different types of endpoint:
-
GET, POST, PUT and DELETE endpoints
The GET endpoints fetch a single entity (a detailed record such as a Product, Customer or Customer Invoice) by its UUID, or a list of entities, and the POST, PUT or DELETE endpoints create, update or delete a single entity.
-
Search endpoints
The search endpoints provide the ability search for entities using specific search criteria or by performing a text-match against all searchable fields. The search endpoints return a page of results starting from a given offset.
-
Data Synchronisation
Data Synchronisation provides the ability to retrieve all of a particular entity so that it can be stored externally. Like search, it is returned as pages of entities however Data Synchronisation will keep track of what has been retrieved (a delta) so that the entities are not retrieved a second time unless they have been changed or the “cursor” has been reset.
There are currently six Data Synchronisation endpoints available: Products, Customers, Customer Invoices, Customer Contract Rates, Product Promotional Prices and Discount Matrix Entries. When there is an addition, change or deletion for any of these, they will be provided in the next request to the Data Synchronisation. For deletions, the data included will resemble what was deleted but it can be distinguished from insertions or changes by checking the deletedTimestamp which will have the timestamp of the deletion.
-
Synchronisation Webhooks
Synchronisation Webhooks allow other API’s to register interest in changes to specific entities by providing a URL for their own endpoint and authentication details. When changes occur, Infusion calls the external application's endpoint and they can then make a request to Data Synchronisation to get the changes. This saves the need for polling to see if there are changes.
Pricing Rules for calculation of a customer specific sell prices are outlined in the API document.
Download Instructions Infusion API - 12 November 2024.pdf
