Klar API
Programatically import your data into Klar via Klar API
Klar API - IntroductionProgramatically import your data into Klar
Data Mapping: Frontend vs. API Fields
Endpoints
List of endpoints available via Klar API
AuthenticationAuthenticate your application against the Klar API
COGSUse this endpoint if COGS (Costs of Goods Sold) are coming from a non-shop system source & order data doesn't contain COGS information.
Logistics CostsUse this endpoint to import logistics costs missing in your shop system / are coming via another system, e.g. ERP.
OrdersUse this endpoint if you want to import complete order payloads, including order statuses, line items, shipping and returns info in one go.
RefundsUse this endpoint if returns are part of your orders. Order data is coming via different data source and doesn't contain returns information
Object Schemas
Detailed description of the entities for the Klar API Endpoints
COGSCosts Of Goods Sold (COGS) object schema
CustomerCustomer object schema for Klar API
DiscountDiscount object schema for Klar API
LineItemLineItem object schema for order products.
LogisticsCostsObject Schema for the Logistics Costs endpoint of Klar API.
OptionalIdentifiersObject schema for Klar APi. While those attributes are optional, they are very useful in linking up the order data with your marketing data.
OrderObject schema for Klar API.
RefundObject schema for Klar API.
RefundedLineItemRefunded products object schema.
ShippingShipping object schema for shipping revenue, costs, address, tax and shipping discount info
TaxObject schema for Klar API.
Examples
Example calls for the Klar API endpoints
COGSExample payload for COGS for Klar API.
Logistics CostsExample for logistics costs for Klar API.
Order Example #1Example for an order submitted via Klar API, paid & delivered, no returns
Order Example #2Example Order for Klar API, partially refunded
Refunds