📄️ Introduction
The Karla API is composed of the following main entities:
📄️ Announcement
The Announcement entity represents important notifications that you would like to send to your users. Announcements will be shown in your tracking pages.
📄️ Campaign
The Campaign entity refers targeted promotions in your tracking pages.
📄️ Claim
The Claim entity refers to incidents raised through the Resolve functionality. These could be damaged items, returns, missing package and other support flows.
📄️ Discount
The Discount entity refers to discount promotions that can be attached to campaigns.
📄️ Order
The Order entity represents an order placed in your shop system.
📄️ Organization
The Organization entity is your Karla account, also known as Merchant or Org.
📄️ Shipment
The Shipment entity represents a delivery of products from an order. It is created when an order is shipped to the customer.
📄️ Shop
The Shop entity represents a shop instance.
📄️ ShopSetting
The ShopSetting entity represents the unique state of configuration of your Karla experience, like how Karla will interact and manage your triggers, carriers, orders, etc...
📄️ Webhook
The Webhook entity allows you to configure endpoints to be notified about events