Suppliers

Suppliers API

Suppliers – GET

Where DynamxMFG® is the point of truth for suppliers, third party applications can use the following APIs to GET Supplier information held, including Supplier Contacts and Addresses.

This API can be used to retrieve the suppliers that have been updated and/or created, using an optional “lastUpdated” parameter.

Info
https://{SUBDOMAIN}.totalcontrolpro.com/inventoryApi/api/integration/Suppliers


Sending a GET request with no parameters will return all of the suppliers in the below format

  2. {
  3.   "isActive": true,
  4.   "leadTime": "string",
  5.   "supplierName": "string",
  6.   "supplierRef": "string",
  7.   "addresses": [
  8.     {
  9.       "id":0
  10.       "typeId":0
  11.       "addressLine1": "string",
  12.       "addressLine2": "string",
  13.       "addressRef": "string",
  14.       "city": "string",
  15.       "county": "string",
  16.       "countryCode": "string",
  17.       "postcode": "string",
  18.       "type": “string”
  19.     }
  20.   ],
  21.   "contacts": [
  22.     {
  23.       "contactRef": "string",
  24.       "email": "string",
  25.       "fax": "string",
  26.       "jobTitle": "string",
  27.       "mobile": "string",
  28.       "name": "string",
  29.       "telephone": "string"
  30.     }
  31.   ]
  32. }


lastUpdated Parameter

This GET request has an optional parameter (“lastUpdated”) shown below to get all of the new or updated suppliers from a point in time.

The parameter “lastUpdated” date is in the format YYYY-MM-DDThh:mm:ss

For example, the following call will return all suppliers created from the 4th of January 12:00 Onwards:

https://{SUBDOMAIN}.totalcontrolpro.com/inventoryApi/api/integration/Suppliers?lastUpdated=2023-01-04T08%3A15%3A30-05%3A00 

NOTE:  Contact and address references will be NULL if they are created inside of the Suppliers interface on DynamxMFG®


    • Related Articles

    • Customers API

      Customers – POST API Customer information can be inserted into DynamxMFG®. Updating Customer Record data; This API can be used both to INSERT and UPDATE Customer record data in DynamxMFG®. This API can be used to update the Customer without updating ...

    • Purchase Order API

      Purchase Orders – GET PurchaseOrders Where DynamxMFG® is the point of truth for Purchase Orders, third party applications can use the following APIs to GET Purchase Orders records. ...

    • Sales Orders API

      Sales Order Creation – POST SalesOrders New Sales Orders can be created in DynamxMFG® from third party applications using the Sales Order Creation API. This POST API call enables Sales Orders to be create against customers using the Customer ...

    • Intro, Keys & Swagger

      Introduction TotalControlPro provide specific APIs across DynamxMFG® to allow entry-level direct 3rd party integration. These public APIs are designed for clients who wish to connect directly to the DynamxMFG® platform using custom and/or 3rd party ...