Klar

Import orders, returns, and costs from any custom system into Klar — without a native integration.

Klar API — Introduction

Michael Stenger

Franz May

Frank Birzle

Programatically import your data into Klar via Klar API

Klar API

Comprehensive overview and technical guidelines for integrating external systems with the Klar RESTful API.

Developer Guide: Connecting to the Klar RESTful API

Data Mapping: Frontend vs. API Fields

Klar Public API

Valentine Strunz-Happe

Introduction to using the Klar APIs - Read me first!

Klar API - Introduction

How to generate your Klar API token and authenticate your requests using Bearer authentication.

API Authentication

Use this endpoint if COGS (Costs of Goods Sold) are coming from a non-shop system source & order data doesn't contain COGS information.

COGS

Use this endpoint if you want to import complete order payloads, including order statuses, line items, shipping and returns info in one go.

Orders (API Endpoint)

Use this endpoint if returns are part of your orders. Order data is coming via different data source and doesn't contain returns information

Refunds (API Endpoint)

Allows you to upload payment & transaction costs for orders via API

Transaction Costs (API Endpoint)

Use this endpoint to import logistics costs missing in your shop system / are coming via another system, e.g. ERP.

Logistics Costs (API Endpoint)

Endpoints

COGS (object schema)

Customer (object schema)

Discount (object schema)

LineItem object schema for order products.

LineItem (object schema)

Object Schema for the Logistics Costs endpoint of Klar API.

LogisticsCosts (object schema)

Object schema for Klar APi. While those attributes are optional, they are very useful in linking up the order data with your marketing data.

OptionalIdentifiers (object schema)

The Order object — field definitions, types, and example values for the Klar REST API.

Order (object schema)

Refund (object schema)

RefundedLineItem (object schema)

Shipping object schema for shipping revenue, costs, address, tax and shipping discount info

Shipping (object schema)

Tax (object schema)

Object Schema for the Transaction Costs endpoint of Klar API.

Transaction Costs (object schema)

Detailed description of the entities for the Klar API Endpoints

Object Schemas

Example for logistics costs for Klar API.

Logistics Costs

Example for an order submitted via Klar API, paid & delivered, no returns

Order Example #1

Example Order for Klar API, partially refunded

Order Example #2

Refunds

Examples

Klar Website

No tickets or conversations found

Try selecting a different creation date range.

Tickets and conversations you've started through the messenger will appear here.

No tickets or conversations created by you

Try using different keywords or checking for typos.

Try selecting a different update date range.

Find answers and get help from Intercom Support and Community Experts

Conversations you've started through the messenger will appear here.

No conversations created by you

No conversations found

Title

This site employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

Advertising cookies are set by our advertising partners to collect information about your use of the site, our communications, and other online services over time and with different browsers and devices. They use this information to show you ads online that they think will interest you and measure the ads' performance. Social media cookies are set by social media platforms to enable you to share content on those platforms, and are capable of tracking information about your activity across other online services for use as described in their privacy policies.

These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

These cookies are necessary for the website to function and cannot be switched off in our systems.

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

Cookie Settings

Empty Help Center

Uh oh. That page doesn’t exist.

Home

Search results

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.

No tickets created by you

No tickets found

Conversations and tickets in {topic}

Conversations and tickets in {topic} // {subtopic}

Volume, creators and topics for your company.

Insights

Top creators

AI topics

Track the progress of all tickets and conversations related to your company.

Customer Portal.

Track the progress of all tickets related to your company.

Tickets portal.

{assigneeName} needs more information from you

Tickets

No access to tickets portal

Search

Skip the search. Describe what you’re trying to do and get a grounded answer.

Browse articles and guides in this topic.

Create your workspace and invite the people you work with.

Set up your account

Build your first workflow and watch it run end to end.

Ship something

Connect the tools your team already uses to bring data in.

Connect your stack

A quick lap of the product so you know where everything lives.

{appName} in 60 seconds

This prototype demo is aware that you are reading “{title}”. It can point you back to the current article, but a production article-aware Fin contract is still follow-up work.

Prototype article-aware answer

Because you already asked about invitations, this prototype demo can add the follow-up: use the role selector before sending each invite to limit access to the teammate responsibilities.

Prototype role-limiting follow-up

This prototype demo suggests starting with your workspace profile, inviting the team members who need access, and then connecting the integrations you use.

Prototype getting-started answer

In this prototype demo, integrations are configured from workspace settings. Choose the integration, connect the account, and review the enabled permissions.

Prototype integrations answer

In this prototype demo, invite teammates from workspace settings, then choose the access each teammate needs before sending the invitation.

Prototype invite-team answer

This prototype demo does not have a scripted answer for that question yet. Try asking how to invite your team or open a source article. No production Fin API was called.

Prototype answer unavailable

I’ve got this page open. Ask me anything about it and I’ll answer from the docs.