Web API filter and ordering documentation

Hi,

We were asked by a potential client if we could connect his Litium instance to a third party logistics provider. In short we would need to connect via the Web API to read orders, update orders (tracking details), read products and update product inventory. Having scanned through the documentation I have a few questions.

First, we need to read sales orders “modified since” (or similar). I can see that there’s a “search” method for sales orders. Is there documentation for how the search endpoint works, or can you point me to examples I’ve missed?

You can check it out on your solutions swagger:
https://your-domain/Litium/swagger?urls.primaryName=Litium%20Admin%20Web%20API#/Sales%20sales%20order/Litium_Sales_SalesOrders_Search

Thanks @steve.redstorm, I don’t have access to the customers domain at the moment (I’ll ask my sales people). Is the Open API spec available somewhere else?

Have you read the ERP Connect APIs, maybe that would be more appropriate for the task?
https://docs.litium.com/api-reference/api?product=Litium.Connect.Erp&version=2.0&xref=Orders.

Sure have :slight_smile: But maybe I’m misreading but there is no exposed method to, e.g., list all orders or shipments?

Why do you need all orders, there are WebHooks that you can subscribe to when e.g an order is set to Confirmed or ReadyToShip.

Webhooks would work as well of course. But I can’t find any documentation on the webhook event payload or filters.

Here you have some information.

Thanks @steve.redstorm! I’ve now also found the ERP examples in GitHub, and the .NET API documentation of the events themselves. Do the ERP connect API webhooks expose only the ERP events or will we e.g. be able to listen to " Litium.Products.Events" as well to pick up product and variant changes?

You can find all Events who one can subscribe to on your solution or on our demo site like this:
https://demo.litium.com/Litium/swagger?urls.primaryName=Litium%20WebHook

This topic was automatically closed 28 days after the last reply. New replies are no longer allowed.