...
Versions
When incompatible changes are made to the API Claritum will release a new version of the service. The most recent version is currently 1.34. You can tell the version you are accessing by examining the endpoint URL - for example, this URL shows that you are using version 1.3 4 of the web service.
https://yourserver.claritum.com/system/ws/1.34/soap.php?wsdl
Claritum continue to support older versions of the web services for six months after a new version is released. Non-breaking changes, such as adding elements to data types, may not result in the new version.
Web Services Reference
Full documentation on the datatype properties for each service can be found be checking the service end point on your system. For instance, if you normally access the system via the URL https://yoursystem.claritum.com, you can view the documented services via the URL:
https://yoursystem.claritum.com/system/ws/1.34/soap.php
Not all of these services are available to Service Providers and Suppliers alike; indicators show on each one as appropriate.
...
Returns an array of deliveries for jobs that are in progress and that have not been marked as exported. Once your system has processed the deliveries, call the markExported service with the UIDs of the items processed to prevent the same deliveries being returned in future calls.
getPaperSpecification
Status title msp Status colour Green title supplier
Once a set of purchase orders have been retrieved from the system, this service can be called to retrieve the detailed paper specification for each order.
getPaperSpecification
Status title msp Status colour Green title supplier
Once a set of purchase orders have been retrieved from the system, this service can be called to retrieve the detailed paper specifications for each order.
getPurchaseInvoices
Status colour Green title msp Status colour Green title supplier
...
Once a set of purchase orders have been retrieved from the system, this service can be called to retrieve the detailed specification for each order.
getSpecifications
Status title msp Status colour Green title supplier
Once a set of purchase orders have been retrieved from the system, this service can be called to retrieve the detailed specifications for each order.
getStockDespatches
Status title msp Status colour Green title supplier
Returns a list of pending stock (fulfilment) orders awaiting packing by the supplier.
Once your system has processed the records, call the markExported service with the UIDs of the items processed to prevent the same records being returned in future calls.
getStockOrders
Status title msp Status colour Green title supplier
Returns a list of pending stock (fulfilment) orders pending for the supplier.
Once your system has processed the invoicesretrieved these records, call the markExported service with the UIDs of the items processed to prevent the same invoices records being returned in future calls.
...
Marks objects of given type as exported. The 'Type' parameter should match the name of the service called to get the results - for example 'Deliveries'Delivery', 'PurchaseInvoice', 'PurchaseOrder', 'PurchaseInvoicesSalesInvoice', 'PurchaseOrdersStockDespatch', etc.
Until an object has been marked exported it will continue to appear in the associated get[Type] operation. Call this method when the remote system has successfully processed the objects.
markFailed
Status colour Green title msp Status colour Green title supplier
When processing the retrieved records, if any of them fail your validation for any reason you can use this service to mark the records as FAILED. This causes Claritum to raise an alert with the account managers who can then resolve the issue.
The 'Type' parameter should match the name of the service called to get the results - for example 'Delivery', 'PurchaseInvoice', 'PurchaseOrder', 'SalesInvoice', 'StockDespatch', etc.
Until the object has been marked exported it will continue to appear in the associated get[Type] operation.
setCustomers
Status colour Green title msp Status title supplier
...
setGoodsReceipts
Status colour Green title msp Status colour Green title supplier
Creates goods receipts on the Claritum System.
Note: the inbound goods receipts will contain the Claritum order reference with which the Claritum System will use to locate the order relating to these goods receipts. If there are multiple delivery addresses then the receipt quantity will be allocated across all of the delivery addresses. If a partial quantity is received then this will mean that latter delivery addresses will see no goods receipts until a balancing goods receipt is received.
setStockOrderStatussetStockDespatches
Status title msp Status colour Green title supplier
Sets the 'despatched' progress status on the given stock (fulfilment) orders.
setSuppliers
Status colour Green title msp Status title supplier
Creates/Updates supplier records on the Claritum System. If any of the records cannot be processed for any reason then an error is returned.
...