Versions Compared
Version | Old Version 3 | New Version 4 |
---|---|---|
Changes made by | ||
Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Panel | ||
---|---|---|
| ||
This document is written to give input on the best way of integrate an external webshop to the Extend plattform via Extend REST API. There are some important general information and general best practice info in this document that you also need to read. Code of Conduct & Best Practice, Extend API |
Set the scope
Panel |
---|
First you need to decide the big picture process in the integration. This is about how many data points that should be integrated. Orders and Balances are often mandatory, it dose not really make sense to integrate without those two data points.
|
Orders
Panel | ||
---|---|---|
| ||
Create orderin Extend from the webshop Use POST on the method CustomerOrders Get update on order
If you get those hooks, then use the GET customerorders/{id} method to fetch all details about the shipment of the order. If you can´t use the webhook as trigger to fetch data, then use the GET CustomerOrders (you get a list of ordernumber there) here you can use different parameters to find orders that has been changed shipped etc. |
Balance
Panel |
---|
If you want the webshop to have info about the available balance in the warehouse you should call GET ProductAvailability In this method you can add some parameters to find balance for products with changed balance since a timestamp, specific products and on different warehouses. Due to that balance is a real time data we also strongly recommend that you use a webhook called AvaiableBalanceChanged from Extend. in this hook we will send you itemnumber and new balance. This is as near real time you can get. every change in available balance will trigger a hook. Use the webhook as a trigger to call the ProductAvailabilty method. You could use the info in the hook to update you balance, but we recommend that you use it as a trigger to call us. Extend will not accept you to call every xx minut for each product to update the balance. |
Products
Panel | ||
---|---|---|
| ||
If you want to get product masterdata from Extend. then use the GET Products method. this is also build with a logic of you can get a list with a lot of parameters, including last change date of product masterdata. Use this to get the a list of productnumbers that you want to get data on. then call the GET single product to fetch all data. |
Customers
Panel | ||
---|---|---|
| ||
If you want to get customer masterdata from Extend. Then use the GET Customers method. this is also build with a logic of you can get a list with a lot of parameters, including last change date of customer masterdata. Use this to get the a list of customers that you want to get data on. then call the GET single product to fetch all data. If you want to create customers then use the POST Customers method. |
Prices
Panel | ||
---|---|---|
| ||
If you want to get prices you use the GET ProductPrices method. In Extend the prices are a net list of best price for a customer number. Meaning that if there are one pricelist, one discountlist, one special campaign pricelist active at the same time. Extend will respond in the ProductPrice Method with a list of "right now" best price for a customer. So you need to put in a parameter of a customer number to fetch prices. |
Contents | |
---|---|
|