With our API, you can automate processes and access additional features for your Online Shop.
APIs, also known as Application Programming Interfaces, make it easier for different systems and programs to talk to each other online. They allow one system to use certain features of another system. For example, flight comparison websites use APIs to collect flight details and prices from different airlines. This allows them to offer users convenient and affordable options on their website.
- What are the benefits of using the Online Shop API?
- Which information is the API giving access to?
- How can I use the API to connect a third-party tool to my shop?
- Will I see my connected services in my Online Shop dashboard?
What are the benefits of using the Online Shop API?
Our API can help you automate processes and gives you access to third-party tools to customise your Online Shop.
Process automation
By connecting a third-party tool to your Online Shop with our API, you can save time in your daily work as a business owner.
Imagine using an external accounting tool: Without the connection, you need to manually copy all information from your shop dashboard into the accounting tool to use it. With the connection through the API, the accounting tool gets direct access to the information in your Online Shop, and all relevant information will automatically be transferred - no copy-pasting needed!
Access to additional functionalities
With our API, you can connect various external services you might need for your business. This offers you great flexibility and the possibility to adjust your shop to your needs.
Tip: Check out our overview of tools in the section Integrations in your Online Shop dashboard. If the tool you're looking for isn't listed there, we recommend asking the third-party provider if they can help connect their tool with your shop.
Which information is the API giving access to?
Our API allows third-party tools to access Online Shop data about orders. This includes:
- Which products were ordered and in which amount
- Customer details, like name, billing address, email, phone number
- Delivery details, like shipping address, delivery method
- Price, VAT, discounts
The API also supports the following actions for order management:
- Refunds (all payment types, as well as refunds as gift cards)
- Order cancellation (all payment types)
- Draft orders (update products)
- Update address (shipping and billing for draft order)
- Add notes (for both regular and draft order)
- Create draft order
Tip: We will add access to other types of information in the future, so come back to this page to keep yourself updated.
How can I use the API to connect a third-party tool to my shop?
Connect your favourite app
To connect a third-party tool that we don't have a shortcut with yet, you need to use our API documentation. You can find the technical information that is required to use the connection here:
Tip: Not sure how to connect? We recommend reaching out to the customer support of the third-party tool that you want to use, and asking if they can create the connection to your shop.
Use available connections
We've already created shortcuts to several different third-party products we recommend. You can find a list of these apps in our guide:
Will I see my connected services in my Online Shop dashboard?
Yes, once you have connected an external service through our API, you can see it in your Online Shop dashboard in the tab Integrations.
Related articles: