Sales Orders

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 Reference as an identifier.

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

  1. {
  2.   "currencyCode": "string",
  3.   "customerRef": "string",
  4.   "customerContactRef": "string",
  5.   "deliveryAddressRef": "string",
  6.   "deliveryDate": "2023-01-26T14:35:42.081Z",
  7.   "deliveryType": 1,
  8.   "comment": "string",
  9.   "orderNo": "string",
  10.   "orderReference": "string",
  11.   "customerOrderNo": "string",
  12.   "priority": 1,
  13.   "productionDate": "2023-01-26T14:35:42.081Z",
  14.   "projectReference": "string",
  15.   "raiseAsQuote": true,
  16.   "requiredByDate": "2023-01-26T14:35:42.081Z",
  17.   "vat": 0,
  18.   "specification": {
  19.     "image": {
  20.       "fileAsBase64String": "string",
  21.       "fileDataType": "string",
  22.       "fileName": "string"
  23.     },
  24.     "instruction": {
  25.       "fileAsBase64String": "string",
  26.       "fileDataType": "string",
  27.       "fileName": "string"
  28.     },
  29.     "url": "string"
  30.   },
  31.   "lines": [
  32.     {
  33.       "discount": 0,
  34.       "markup": 0,
  35.       "quantity": 0,
  36.       "stockCode": "string"
  37.       "type": "string"
  38.     }
  39.   ]
  40. }

 

Sales Orders Retrieval – GET SalesOrders

The GET SalesOrders API returns data on how much of an order has been dispatched, or when certain lines have been completed of the order.  Making the request without any parameters will simply return all orders.

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

Using the “lastUpdate” parameter, the GET SalesOrders request allows third party applications to receive all sales orders that have been updated or created from a certain point in time onwards.

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

https://{SUBDOMAIN}.totalcontrolpro.com/inventoryApi/api/integration/SalesOrders?lastUpdated=2023-01-04T10%3A00%3A00'


This will return the sales orders that have been created or updated from this point onwards.

The GET request also returns Dispatch Notes data as part of the response.  This allows third party software to be informed of the dispatch note for certain lines / quantities.

Example as

  1. [
  2.   {
  3.     "created": "2023-01-03T10:19:22.0677871Z",
  4.     "lastUpdated": "2023-01-25T14:08:40.4223736Z",
  5.     "exchangeRate": 1,
  6.     "customField1": null,
  7.     "customField2": null,
  8.     "customFieldN": null,
  9.     "customField60": null,
  10.     "lines": [
  11.       {
  12.         "markup": 1,
  13.         "stockCode": "string",
  14.         "notes": null,
  15.         "type": "string",
  16.         "qty": 1,
  17.         "dispatchNotes": [
  18.           {
  19.             "created": "datetime",
  20.             "dispatchNoteNo": "string",
  21.             "dispatchedQuantity": 0
  22.           }
  23.         ]
  24.       }
  25.     ],
  26.     "currencyCode": "GBP",
  27.     "customerRef": "string",
  28.     "customerContactRef": null,
  29.     "deliveryAddressRef": null,
  30.     "deliveryDate": null,
  31.     "deliveryType": null,
  32.     "comment": null,
  33.     "orderNo": "string",
  34.     "orderReference": null,
  35.     "customerOrderNo": null,
  36.     "priority": 2,
  37.     "productionDate": null,
  38.     "projectReference": null,
  39.     "raiseAsQuote": false,
  40.     "requiredByDate": null,
  41.     "vat": 0.2
  42.   }
  43. ]

 



    • Related Articles

    • 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. ...

    • 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 ...

    • 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 ...

    • 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 ...