Versions Compared
Version | Old Version 7 | New Version Current |
---|---|---|
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 to integrate an external webshop to the XTND platform via XTND Extend Commerce platform via Extend Commerce REST 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, generally it does not make sense to integrate without these two data points.
Masterdata Customer
Masterdata ProductsThe products must exists in both systems, should there be any masterdata sync about this? PricesWhen the order is placed from the webshop into XTNDExtend Commerce , the price on the order is handled exactly as the webshop states. But If you want to have a "push" of standard prices from XTND to Extend Commerce to the webshop, then this must be one of the data points to use as well. |
Orders
Panel | ||
---|---|---|
| ||
Create orderIn XTND from Extend Commerce from the webshop: Use POST on the method CustomerOrders Get update on orderWe recommend that you activate webhook from XTND to Extend Commerce to the webshop. When this is written we support:
Using webhooks If you get those hooks, then use the GET customerorders/{id} method to fetch all details about the shipment of the order. Webhooks not possible 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 XTNDExtend Commerce. 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.
|
Products
Panel | ||
---|---|---|
| ||
Get productsIf you want to get product masterdata from XTNDExtend Commerce, then use the the GET Products method. This is also build with a logic where you can get a list with a lot of parameters, including last change date of product masterdata. Use in this order: 1) Use this to get the a list of productnumbers that you want to get data on 2) Then call the GET single product to fetch all data. |
Customers
Panel | ||
---|---|---|
| ||
Get customersIf you want to get customer masterdata from XTNDExtend Commerce. Then use the GET Customers method. This is also build with a logic where you can get a list with a lot of parameters, including last change date of customer masterdata. Use in this order: 1) Use this to get the a list of customers that you want to get data on 2) Then call the GET single product to fetch all data. Create customersIf you want to create customers then use the POST Customers method. |
Prices
Panel | ||
---|---|---|
| ||
Get pricesIf you want to get prices you use the GET ProductPrices method. In XTNDExtend Commerce, the prices are a net list of best price for a customer number. Meaning that if there is one pricelist, one discountlist, one special campaign pricelist active at the same time, XTND Extend Commerce will respond in the ProductPrice Method with a list of "right now" best price for a customer. Therefore, you need to put in a parameter of a customer number to fetch prices. |
Contents | |
---|---|
|
Include Page | ||||
---|---|---|---|---|
|