Areas of application
The ITscope API can be used for many different areas of application. All applications allow you to benefit from the advantages of ITscope to enrich your own products and services. For example, the administration of individual prices and price lists can be done completely via ITscope. Products have already been prepared and can then easily be accessed via the API, with individual prices. Double reprogramming of the read-in functions is therefore no longer necessary.
ERP systems
The ITscope API contains all retrieval functions necessary to automatically communicate with an enterprise resource planning system. Many functions from the ITscope.com web platform can analogously be used with the API. This includes the product search and a single product call. For example, the ERP conducts a search using an EAN or keywords via the ITscope API and receives the answer in the desired format, for example XML. Individual products can also be conveniently retrieved in this way. The response can then contain master data, availability and price information in real-time, in addition to extended content and deep links to the ITscope platform. If a large number of products are to be compared with the master data of the ERP system, then the API call for exports that has previously been set up on the ITscope platform can be used for this purpose.
Further details can be found in the ‘Opportunities for integration into an ERP system’ article.
Websites and shops
Websites and shops are able to benefit from ITscope’s powerful, prepared product catalogue, which is easily accessible via the API. All known search mechanisms of the ITscope platform can be used – especially the filters. The products are returned in the desired format and can then be processed directly.
The automatic filling of the product master data of a shop is also possible via the API. For example, the export prepared on the platform can be retrieved at the desired point in time.
Anwendungsmatrix
| Use Case | Request Methode | Count API-Calls | Info | Tip |
|---|---|---|---|---|
| Produkte | ||||
| Retrieving/Creating an Item | GET/products/id/{itscopeid}/standard.json | 1 | One request per item | Batch retrieval of up to 50 items = 1 request |
| Loading a list of products resulting from a keyword-based product search | GET/products/search/{filter}/standard.json | 1 | A retrieval can include up to 50 products (each additional page is 1 call with 50 products) | Contains all (up to 50) product records, so that I can then create all the products. |
| Updating an item that already exists in the ERP system | GET/products/id/{itscopeid}/standardUpdate.json | 1 | One retrieval per update | Batch update of up to 50 items = 1 request |
| Warenkröbe Verwalten | ||||
| Creating a Shopping Cart | POST/business/carts | 1 | Create a new shopping cart and edit it in the ITscope front end | |
| Editing a Shopping Cart (Renaming) | PUT/business/carts/{cartId} | 1 | ||
| Deleting a Shopping Cart | DELETE /business/carts/{cartId}/cartlineitems/{lineItemId} | 1 | ||
| Add 1 item to the existing shopping cart | POST/business/carts/{cartId}/cartlineitems | 1 | ||
| Zusätzliche Optimierung des Warenkorbs beim Hinzufügen von Produkten | POST/business/carts/{cartId}/optimiseStrategy=minprice | 1 | Optimize the shopping cart when adding an item by price, lowest price, fewest suppliers, etc. | |
| Optimizing Products in an Existing Shopping Cart | PUT /business/carts/{cartId}/optimise | 1 | Optimize the shopping cart by price, fewest suppliers, etc. | |
| Remove Products from a Shopping Cart | DELETE/business/carts/{cartId}/cartlineitems/{lineItemId} | 1 | ||
| Retrieving a Shopping Cart | GET/business/carts/{cartId}/cart.json | 1 | View a specific shopping cart | |
| List of all shopping carts | GET/business/carts/cart.json | 1 | List all shopping carts | |
| Bestellungen | ||||
| Transferring a requisition list from the ERP system to a shopping cart that already exists in ITscope | POST/business/carts/{cartId}/cartlineitems | 1 | Regardless of the number of items (a single call can add any number of products to a shopping cart) | |
| Importing the ITscope Shopping Cart into an ERP System | GET/business/carts/{cartId}/cart.json | 1 | ||
| Retrieve Order Documents | GET/business/documents/{transactionId}/ORDERRESPONSE.xmlGET /business/documents/{transactionId}/DISPATCHNOTIFICATION.xmlGET /business/documents/{transactionId}/INVOICE.xml | 1 | One retrieval per document | Using Webhooks |
| Retrieving Order Documents Containing Items Not Yet in the ERP System | GET/products/id/{itscopeid}/standard.json | 1 | One charge per missing item | Retrieving Items in Batch Mode (up to 50 items) |
| Transferring a Purchase Order Submitted in ITscope to an ERP System | GET/business/documents/{transactionId}/ORDERRESPONSE.xmlGET /business/documents/{transactionId}/DISPATCHNOTIFICATION.xmlGET /business/documents/{transactionId}/INVOICE.xml | 1 | As in “Retrieve Order Documents”; you can also retrieve orders alone | |
| Importing a quote created in ITscope into an ERP system | GET/business/quotes/{quoteId}/quote.xmlGET /business/documents/{transactionId}/QUOTATION.xml | 2 | Quotation Metadata + (openTRANS) Quotation.xml + Additional Retrievals for Item Creation | |
| Placing an Order from an ERP System | POST/business/deals/send | 1 bis 2 | 1 retrieval upon shipment of the order; 2 retrievals if the order document is validated in advance | |
| Transferring an Order from ITscope to an ERP System | GET/business/deals/{dealId}/deal.json | 1 | As in “Retrieve Order Documents”; you can also retrieve orders alone | |
| Importing a collection created in ITscope into an ERP system | GET/products/ids/{itscopeids}/standard.json | 1 bis x | Depending on the number of items (see “Retrieving/Creating an Item”) | The collection uses the principle of a trigger to the third-party application to load products via the standard item creation process. |
| Meta Daten | ||||
| Supplier Data Regarding the Creation of Distributors in an ERP System | GET/company/distributor/eservices.json | 1 | Supplier metadata – no limit | |
| Manufacturer Data Regarding the Creation of Manufacturers in an ERP System | GET/company/manufacturer/company.json | 1 | Manufacturer metadata – no limit | |
| Retrieving Category Trees for Implementation in an ERP System | GET /products/producttypes/producttype.json | 1 | Category metadata – no limit | |
| Lieferant | ||||
| As a supplier, call-off orders received | GET/business/deals/purchase/deal.xml | 1 | As in “Retrieve Order Documents”; you can also retrieve orders alone | |
| As a B2B store operator, change the status of incoming orders | PUT/business/deals/advise/{dealId} | 1 | 1 retrieval per status | |
| B2B Shop | ||||
| As a B2B online store operator, view incoming orders | GET | 1 | As in “Retrieve Order Documents”; you can also retrieve orders alone | |
| As a B2B store operator, I change the status of incoming orders | PUT/business/deals/advise/{dealId} | 1 | 1 retrieval per status | |
| Content | ||||
| View Datasheet | GET/products/datasheet/id/{itscopeid}/datasheet.pdf | 1 | Per datasheet (images are not an API call) — only if retrieved via the API and not via the export |