Skip to main content
API docs by Redocly

Karla API (1.0.0)

Karla REST API

ABTest

List Ab Tests

List all AB tests for a shop.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The shop's unique identifier

query Parameters
page
integer (Page) > 0
Default: 1
per_page
integer (Per Page) ( 0 .. 100 ]
Default: 30

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Ab Test

Create an AB test if it does not exist.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The shop's unique identifier

Request Body schema: application/json
required
name
required
string (Name)

Name of the AB test

segment
required
string (Segment)

Segment to which the AB test is targeted

campaign_type
required
string (Campaign Type)

Type of campaign being tested

required
Array of objects (Campaigns)

List of campaigns and their allocations

has_holdout
boolean (Has Holdout)
Default: false

Whether to include a holdout group

holdout_percentage
integer (Holdout Percentage) [ 0 .. 100 ]

Percentage for the holdout group (0-100)

start_date
required
string <date-time> (Start Date)

Time when the AB test will start

end_date
required
string <date-time> (End Date)

Time when the AB test will end

Responses

Request samples

Content type
application/json
{
  • "name": "Holiday Promotion Test",
  • "segment": "b2b",
  • "campaign_type": "product",
  • "campaigns": [
    ],
  • "has_holdout": false,
  • "holdout_percentage": 100,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "uuid": "d1e99924-df48-4781-b3ad-ff147d3e70a2",
  • "name": "Holiday Promotion Test",
  • "shop_slug": "shopify-store-1",
  • "segment": "b2b",
  • "campaign_type": "product",
  • "campaigns": [
    ],
  • "has_holdout": false,
  • "holdout_percentage": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get Ab Test

Get details of a specific AB test.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The shop's unique identifier

uuid
required
string <uuid> (Uuid)

The AB test's unique identifier

Responses

Response samples

Content type
application/json
{
  • "uuid": "d1e99924-df48-4781-b3ad-ff147d3e70a2",
  • "name": "Holiday Promotion Test",
  • "shop_slug": "shopify-store-1",
  • "segment": "b2b",
  • "campaign_type": "product",
  • "campaigns": [
    ],
  • "has_holdout": false,
  • "holdout_percentage": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

End Ab Test

End an AB test.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The shop's unique identifier

uuid
required
string <uuid> (Uuid)

The AB test's unique identifier

Responses

Response samples

Content type
application/json
{
  • "uuid": "d1e99924-df48-4781-b3ad-ff147d3e70a2",
  • "name": "Holiday Promotion Test",
  • "shop_slug": "shopify-store-1",
  • "segment": "b2b",
  • "campaign_type": "product",
  • "campaigns": [
    ],
  • "has_holdout": false,
  • "holdout_percentage": 0,
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Announcement

Search Announcements

Search all announcements or based on some values to filter.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

query Parameters
page
integer (Page) > 0
Default: 1
per_page
integer (Per Page) ( 0 .. 100 ]
Default: 30
uuid
required
string <uuid> (Uuid)
text
required
string (Text)
language
string (LanguageEnum)
Enum: "da" "nl" "en" "fr" "de" "it" "es"

Supported languages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Announcement

Create an announcement if it does not exist.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
text
required
string (Text)

Announcement text

language
required
string (LanguageEnum)
Enum: "da" "nl" "en" "fr" "de" "it" "es"

Language for the text strings related to the merchant

Responses

Request samples

Content type
application/json
{
  • "text": "We are expecting significant delays in today's deliveries due to the storm",
  • "language": "da"
}

Response samples

Content type
application/json
null

Delete Announcement

Delete an announcement that already exists.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

uuid
required
string <uuid> (Uuid)

The announcement's unique identifier

Responses

Response samples

Content type
application/json
null

Update Announcement

Update an announcement partially or completely.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

uuid
required
string <uuid> (Uuid)

The announcement's unique identifier

Request Body schema: application/json
required
text
string (Text)

Announcement text

language
string (LanguageEnum)
Enum: "da" "nl" "en" "fr" "de" "it" "es"

Language for the text strings related to the merchant

Responses

Request samples

Content type
application/json
{
  • "text": "We are expecting significant delays in today's deliveries due to the storm",
  • "language": "da"
}

Response samples

Content type
application/json
null

Campaign

Search Campaigns

Search all campaigns or based on some values to filter.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

query Parameters
page
integer (Page) > 0
Default: 1
per_page
integer (Per Page) ( 0 .. 100 ]
Default: 30
uuid
string <uuid> (Uuid)
name
string (Name)
start_date
string <date-time> (Start Date)
end_date
string <date-time> (End Date)
segment
string (Segment)
promotion_type
any (PromotionType)
Enum: "product" "basic" "banner"

Type of the Campaign to store.

enabled
boolean (Enabled)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Campaign

Create a campaign if it does not exist.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
enabled
boolean (Enabled)
Default: false

Campaign visibility toggle. Only one campaign can be enabled per segment at a time.

name
required
string (Name)

Campaign name to be used internally

start_date
string <date-time> (Start Date)

Time in which the campaign will start (defaults to now)

end_date
string <date-time> (End Date)

Time in which the campaign will end

segment
required
string (Segment)

Segment to which the campaign is targeted

promotion_type
required
any (PromotionType)
Enum: "product" "basic" "banner"

Type of promotion

required
Promotion Properties (object) or BasicPromotionPropertiesDTO (object) or ProductPromotionPropertiesDTO (object) or BannerPromotionPropertiesDTO (object) (Promotion Properties)

The properties of the promotion

discount_id
string <uuid> (Discount Id)

Discount UUID

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "name": "Q3 Campaign",
  • "start_date": "2024-10-01T00:00:00+00:00",
  • "end_date": "2024-10-11T00:00:00+00:00",
  • "segment": "b2b",
  • "promotion_type": "product",
  • "promotion_properties": { },
  • "discount_id": "49c104c1-008b-4f4f-abbc-6958059cb48b"
}

Response samples

Content type
application/json
{
  • "enabled": false,
  • "name": "Q3 Campaign",
  • "start_date": "2024-10-01T00:00:00+00:00",
  • "end_date": "2024-10-11T00:00:00+00:00",
  • "segment": "b2b",
  • "promotion_type": "product",
  • "promotion_properties": { },
  • "uuid": "d1e99924-df48-4781-b3ad-ff147d3e70a2",
  • "shop_slug": "gokarla",
  • "status": "active",
  • "discount": {
    }
}

Update Campaign

Update a campaign completely.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

uuid
required
string <uuid> (Uuid)

The campaign's unique identifier

Request Body schema: application/json
required
enabled
boolean (Enabled)
Default: false

Campaign visibility toggle. Only one campaign can be enabled per segment at a time.

name
required
string (Name)

Campaign name to be used internally

start_date
string <date-time> (Start Date)

Time in which the campaign will start (defaults to now)

end_date
string <date-time> (End Date)

Time in which the campaign will end

segment
required
string (Segment)

Segment to which the campaign is targeted

promotion_type
required
any (PromotionType)
Enum: "product" "basic" "banner"

Type of promotion

required
Promotion Properties (object) or BasicPromotionPropertiesDTO (object) or ProductPromotionPropertiesDTO (object) or BannerPromotionPropertiesDTO (object) (Promotion Properties)

The properties of the promotion

discount_id
string <uuid> (Discount Id)

Discount UUID

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "name": "Q3 Campaign",
  • "start_date": "2024-10-01T00:00:00+00:00",
  • "end_date": "2024-10-11T00:00:00+00:00",
  • "segment": "b2b",
  • "promotion_type": "product",
  • "promotion_properties": { },
  • "discount_id": "49c104c1-008b-4f4f-abbc-6958059cb48b"
}

Response samples

Content type
application/json
{
  • "enabled": false,
  • "name": "Q3 Campaign",
  • "start_date": "2024-10-01T00:00:00+00:00",
  • "end_date": "2024-10-11T00:00:00+00:00",
  • "segment": "b2b",
  • "promotion_type": "product",
  • "promotion_properties": { },
  • "uuid": "d1e99924-df48-4781-b3ad-ff147d3e70a2",
  • "shop_slug": "gokarla",
  • "status": "active",
  • "discount": {
    }
}

Delete Campaign

Delete a campaign that already exists.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

uuid
required
string <uuid> (Uuid)

The campaign's unique identifier

Responses

Response samples

Content type
application/json
{ }

Get Campaign By Order Number

Get a campaign by order id.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

order_number
required
string (Order Number)

The order's unique identifier

Responses

Response samples

Content type
application/json
{
  • "enabled": false,
  • "name": "Q3 Campaign",
  • "start_date": "2024-10-01T00:00:00+00:00",
  • "end_date": "2024-10-11T00:00:00+00:00",
  • "segment": "b2b",
  • "promotion_type": "product",
  • "promotion_properties": { },
  • "uuid": "d1e99924-df48-4781-b3ad-ff147d3e70a2",
  • "shop_slug": "gokarla",
  • "status": "active",
  • "discount": {
    }
}

Claim

Search Claims

Search all claims or based on some values to filter.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

query Parameters
page
integer (Page) > 0
Default: 1
per_page
integer (Per Page) ( 0 .. 100 ]
Default: 30
order_id
string <uuid> (Order Id)
shipment_id
string <uuid> (Shipment Id)
resolution_preference
any (ClaimResolutionPreference)
Enum: "reorder" "refund"

Type resolution preference for a claim.

status
any (ClaimStatus)
Enum: "pending" "accepted" "rejected" "closed"

Type status for a claim.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Claim

Create a claim if it does not exist.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
resolution_preference
any (ClaimResolutionPreference)
Enum: "reorder" "refund"

Claim resolution preference

reason
required
any (ClaimReason)
Enum: "partial_damage" "damage" "investigation" "support" "return"

Reason to submit the claim

status
any (ClaimStatus)
Enum: "pending" "accepted" "rejected" "closed"

Claim status

description
string (Description)

Complimentary description to explain why the claim was submitted

customer_signature_image_url
string (Customer Signature Image Url)

The private image url with the client signature

Array of objects (Selected Items)
Default: []

List of selected product items

image_urls
Array of strings (Image Urls)
Default: []

List of image URLs that give evidence of the damaged product or claim in general

dropoff_permission
boolean (Dropoff Permission)

The customer's response about whether they authorized the carrier to leave the package at a designated spot without requiring direct delivery

shipment_id
string <uuid> (Shipment Id)

Unique identifier for the system in Karla. If not provided, a tracking number has to be given.

Array of objects (Damaged Product Items)
Default: []

List of damaged product items (DEPRECATED)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "uuid": "38fdc365-7de9-4313-afbd-0ed23717c5e0",
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
  • "shop_id": "38fdc365-7de9-4313-afbd-0ed23717c5e0",
  • "order_number": "12345",
  • "resolution_preference": "refund",
  • "reason": "partial_damage",
  • "status": "pending",
  • "description": "Package was damaged on the right side",
  • "customer_signature_image_url": "https://cdn.gokarla.io/12d6cceb-efa5-4bbc-a557-a6d31ed9f68b/df4f85de-1580-4c33-9178-cee6729e010a.png",
  • "damaged_product_items": [ ],
  • "selected_items": [ ],
  • "image_urls": [ ],
  • "address": {
    },
  • "net_invoice_amount": 0,
  • "tracking_number": "string",
  • "carrier_reference": "amz",
  • "scan_date": "2024-03-14T07:14:23+00:00",
  • "weight_kg": 0,
  • "dropoff_permission": true,
  • "shop_slug": "gokarla"
}

Update Claim

Modify an existing claim.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

uuid
required
string <uuid> (Uuid)

The claim's unique identifier

Request Body schema: application/json
required
resolution_preference
any (ClaimResolutionPreference)
Enum: "reorder" "refund"

Claim resolution preference

status
any (ClaimStatus)
Enum: "pending" "accepted" "rejected" "closed"

Claim status

Responses

Request samples

Content type
application/json
{
  • "resolution_preference": "refund",
  • "status": "pending"
}

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "uuid": "38fdc365-7de9-4313-afbd-0ed23717c5e0",
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "shipment_id": "e415c869-52a9-4dbd-bb4b-c8a6b3968a51",
  • "shop_id": "38fdc365-7de9-4313-afbd-0ed23717c5e0",
  • "order_number": "12345",
  • "resolution_preference": "refund",
  • "reason": "partial_damage",
  • "status": "pending",
  • "description": "Package was damaged on the right side",
  • "customer_signature_image_url": "https://cdn.gokarla.io/12d6cceb-efa5-4bbc-a557-a6d31ed9f68b/df4f85de-1580-4c33-9178-cee6729e010a.png",
  • "damaged_product_items": [ ],
  • "selected_items": [ ],
  • "image_urls": [ ],
  • "address": {
    },
  • "net_invoice_amount": 0,
  • "tracking_number": "string",
  • "carrier_reference": "amz",
  • "scan_date": "2024-03-14T07:14:23+00:00",
  • "weight_kg": 0,
  • "dropoff_permission": true,
  • "shop_slug": "gokarla"
}

Delete Claim

Delete a claim that already exists.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

uuid
required
string <uuid> (Uuid)

The claim's unique identifier

Responses

Response samples

Content type
application/json
{ }

Deal

List Deals

List all deals.

Authorizations:
HTTPBasic
query Parameters
page
integer (Page) > 0
Default: 1
per_page
integer (Per Page) ( 0 .. 100 ]
Default: 30

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Deal

Create a deal.

Authorizations:
HTTPBasic
Request Body schema: application/json
required
shop_id
required
string <uuid> (Shop Id)

Shop UUID

discount_id
required
string <uuid> (Discount Id)

Discount UUID

brand_image_url
string (Brand Image Url)

Brand image URL

brand_logo_url
string (Brand Logo Url)

Brand logo URL

cta_url
string (Cta Url)

CTA URL

title
string (Title)

Title

description
string (Description)

Description

Array of objects (Translations)

Translations

rank
integer (Rank)

Rank

Responses

Request samples

Content type
application/json
{
  • "shop_id": "89e430df-96ce-4ad0-b869-a7ba3bbdf710",
  • "discount_id": "49c104c1-008b-4f4f-abbc-6958059cb48b",
  • "brand_image_url": "string",
  • "brand_logo_url": "string",
  • "cta_url": "string",
  • "title": "string",
  • "description": "string",
  • "translations": [
    ],
  • "rank": 0
}

Response samples

Content type
application/json
null

Discount

Search Discounts

Search all discounts or based on some values to filter.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

query Parameters
code
string (Code)
target_selection
string (DiscountTargetSelectionEnum)
Enum: "all" "group" "specific"

Selection method for line items or shipping lines to be discounted.

target_type
string (DiscountTargetTypeEnum)
Enum: "line_item" "shipping_line"

Type of item that the discount applies to..

title
string (Title)
value_type
string (DiscountValueTypeEnum)
Enum: "percentage" "fixed_amount"

Type of value for order and product discounts.

value
number (Value)
page
integer (Page) > 0
Default: 1
per_page
integer (Per Page) ( 0 .. 100 ]
Default: 30
uuid
string <uuid> (Uuid)
type
string (DiscountTypeEnum)
Enum: "product" "order" "shipping"

Type of discount.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Discount

Create a discount if it does not exist.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
code
string (Code)

Discount promotion code

target_selection
string (DiscountTargetSelectionEnum)
Enum: "all" "group" "specific"

The selection method for line items or shipping lines to be discounted.

target_type
string (DiscountTargetTypeEnum)
Enum: "line_item" "shipping_line"

The type of item that the discount applies to.

title
string (Title)

The customer facing name of the discount

value_type
string (DiscountValueTypeEnum)
Enum: "percentage" "fixed_amount"

Type of discount value

value
number (Value)

Discount value based on its type

type
required
string (DiscountTypeEnum)
Enum: "product" "order" "shipping"

Type of discount

Responses

Request samples

Content type
application/json
{
  • "code": "KARLA",
  • "target_selection": "all",
  • "target_type": "line_item",
  • "title": "string",
  • "value_type": "percentage",
  • "value": 3.49,
  • "type": "product"
}

Response samples

Content type
application/json
null

Delete Discount

Delete a discount that already exists.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

uuid
required
string <uuid> (Uuid)

The discount's unique identifier

Responses

Response samples

Content type
application/json
null

Update Discount

Update a discount partially or completely.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

uuid
required
string <uuid> (Uuid)

The discount's unique identifier

Request Body schema: application/json
required
code
string (Code)

Discount promotion code

target_selection
string (DiscountTargetSelectionEnum)
Enum: "all" "group" "specific"

The selection method for line items or shipping lines to be discounted.

target_type
string (DiscountTargetTypeEnum)
Enum: "line_item" "shipping_line"

The type of item that the discount applies to.

title
string (Title)

The customer facing name of the discount

value_type
string (DiscountValueTypeEnum)
Enum: "percentage" "fixed_amount"

Type of discount value

value
number (Value)

Discount value based on its type

Responses

Request samples

Content type
application/json
{
  • "code": "KARLA",
  • "target_selection": "all",
  • "target_type": "line_item",
  • "title": "string",
  • "value_type": "percentage",
  • "value": 3.49
}

Response samples

Content type
application/json
null

Order

Search Orders

Search for shop orders (and its trackings if any) based on filters.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

query Parameters
page
integer (Page) > 0
Default: 1
per_page
integer (Per Page) ( 0 .. 100 ]
Default: 30
email_id
string (Email Id)
external_id
string (External Id)
order_name
string (Order Name)
order_number
string (Order Number)
uuid
string <uuid> (Uuid)
zip_code
string (Zip Code)
order_placed_from
string <date-time> (Order Placed From)
order_placed_to
string <date-time> (Order Placed To)
shipment_updated_since
string <date-time> (Shipment Updated Since)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upsert Order

Process a shop order upsert.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
id
required
string (Id)

Order reference whose type is defined by the id_type field

id_type
string (OrderReferenceType)
Default: "order_number"
Enum: "uuid" "external_id" "order_name" "order_number"

Type of order identifier that is passed in the reference field

object (Order)

Order information (will perform an upsert if provided)

required
Array of objects (Trackings)

Tracking information relevant to the order (order must exist already if it is not provided)

Responses

Request samples

Content type
application/json
{
  • "id": "11334422",
  • "id_type": "order_number",
  • "order": {
    },
  • "trackings": [
    ]
}

Response samples

Content type
application/json
null

Place Order

Process a shop order placement.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
order_number
required
string (Order Number)

Opinionated numeric identification of the order

order_name
string (Order Name)

Opinionated name of the order

order_placed_at
string <date-time> (Order Placed At)

Date the order was placed. Will take current time if not provided

total_order_price
number (Total Order Price)

Total price of the order

shipping_price
number (Shipping Price)

Total shipping price of the order

sub_total_price
number (Sub Total Price)

Subtotal price of items before shipping and discounts

discount_price
number (Discount Price)
Default: 0

Total price of all the accumulated discounts

Array of objects (Products)
Default: []

Line items for the order

Array of objects (Discounts)
Default: []

Discounts applied to the order

email_id
string (Email Id)

Email address of the customer

required
object (Address)

Shipment delivery address

currency
string (Currency)
Default: "EUR"

ISO 4217 currency code (default to 'EUR')

segments
Array of strings (Segments)

The segments to which the user of the order belongs

weight
number (Weight)

Total weight of the order in grams

external_customer_id
string (External Customer Id)

External ID of the customer who purchased the order

order_status_url
string (Order Status Url)

URL to the order status page as given by the shop provider

external_id
required
string (External Id)

External identifier of the order as defined by the merchant shop system (e.g. shopify's order id)

object (Preferred Delivery Date)

Preferred delivery date for the order

user_agent
string (User Agent)

User agent of the customer

order_analytics
object (Order Analytics)
Default: {}

Analytics information related to the order. This information is not used for any computation, but can be used to track the order in the merchant's analytics system.

expected_number_of_shipments
integer (Expected Number Of Shipments) <= 100
Default: 1

Expected number of shipments for the order (defaults to 1)

Responses

Request samples

Content type
application/json
{
  • "order_number": "1234",
  • "order_name": "IXF1234",
  • "order_placed_at": "2023-03-17T09:51:41+00:00",
  • "total_order_price": 29.99,
  • "shipping_price": 4.99,
  • "sub_total_price": 40,
  • "discount_price": 4.99,
  • "products": [
    ],
  • "discounts": [
    ],
  • "email_id": "[email protected]",
  • "address": {
    },
  • "currency": "EUR",
  • "segments": [
    ],
  • "weight": 1000,
  • "external_customer_id": "1234067358984",
  • "order_status_url": "https://shop.gokarla.io/1234067358984/orders/aabbcc/authenticate?key=secret",
  • "external_id": "2205783916624",
  • "preferred_delivery_date": {
    },
  • "user_agent": [
    ],
  • "order_analytics": { },
  • "expected_number_of_shipments": 1
}

Response samples

Content type
application/json
null

Update Order

Process a shop order update.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

order_id
required
string <uuid> (Order Id)

The id given by Karla identifying the order

Request Body schema: application/json
required
object (Address)

Shipment delivery address (skips update if undefined).

expected_number_of_shipments
integer (Expected Number Of Shipments) <= 100

Expected number of shipments for the order (skips update if undefined).

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "expected_number_of_shipments": 1
}

Response samples

Content type
application/json
{
  • "order_number": "1234",
  • "order_name": "IXF1234",
  • "order_placed_at": "2023-03-17T09:51:41+00:00",
  • "total_order_price": 29.99,
  • "shipping_price": 4.99,
  • "sub_total_price": 40,
  • "discount_price": 4.99,
  • "products": [
    ],
  • "discounts": [
    ],
  • "email_id": "[email protected]",
  • "address": {
    },
  • "currency": "EUR",
  • "segments": [
    ],
  • "weight": 1000,
  • "external_customer_id": "1234067358984",
  • "order_status_url": "https://shop.gokarla.io/1234067358984/orders/aabbcc/authenticate?key=secret",
  • "merchant_slug": "string",
  • "external_id": "string",
  • "uuid": "b4fadda9-61f4-4041-94d2-7a01ee0082b4",
  • "trackings": [
    ]
}

Update Order Shipment

Process a shop order shipment update.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

order_id
required
string <uuid> (Order Id)

The id given by Karla identifying the order

shipment_id
required
string <uuid> (Shipment Id)

The id given by Karla identifying the tracking from the order

Request Body schema: application/json
required
tracking_url
string (Tracking Url)

The tracking URL as it comes from the carrier.

Array of objects (Products)

Line items involved in the delivery. Give an empty list to remove all products from the shipment.Any list provided will override the current products in the shipment (there is no merge). Will be skipped from update if not given

Responses

Request samples

Content type
application/json
{
  • "tracking_url": "string",
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "events": [
    ],
  • "estimated_arrival": {
    },
  • "carrier": {
    },
  • "flag": "normal",
  • "pickup": {
    },
  • "products": [ ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "merchant_slug": "string",
  • "shop_slug": "string",
  • "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
  • "order_number": "string"
}

Fulfill Orders

Process a shop order fulfillment in bulk (via shop slug).

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
Array
id
required
string (Id)

Order reference whose type is defined by the id_type field

id_type
string (OrderReferenceType)
Default: "order_number"
Enum: "uuid" "external_id" "order_name" "order_number"

Type of order identifier that is passed in the reference field

object (Order)

Order information (will perform an upsert if provided)

required
Array of objects (Trackings)

Tracking information relevant to the order (order must exist already if it is not provided)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
null

Organization

Get Org

Search for shop orders (and its trackings if any) based on filters.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the org

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "slug": "string",
  • "name": "string",
  • "email": "string",
  • "phone": "string",
  • "website": "http://example.com",
  • "industry": "string",
  • "sso_domain": "string",
  • "feature_community": "alpha",
  • "feature_toggles": { }
}

Search Org Members

Search for shop orders (and its trackings if any) based on filters.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the org

query Parameters
page
integer (Page) > 0
Default: 1
per_page
integer (Per Page) ( 0 .. 100 ]
Default: 30

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Invite User To Org

Invite a user to an organization.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
email
required
string <email> (Email)

Email of the user to invite

role
required
any (UserRole)
Enum: "admin" "editor" "viewer"

User role in the organization

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
null

Shipment

Create New Shipment Event

Create a new event for a shipment.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Shop slug)
shipment_id
required
string (Shipment UUID)
Request Body schema: application/json
required
event_name
required
string (Event Name)

The event to be added to the shipment. See Shipment Events for more details.

Must be one of- ACCEPTED_BY_DESTINATION_OFFICE
- ACCEPTED_BY_ORIGIN_OFFICE
- ARRIVAL_AT_FINAL_DELIVERY_CENTER
- ARRIVAL_AT_TRANSPORT_HUB
- ARRIVAL_IN_DESTINATION_COUNTRY
- ARRIVED_AT_COMMUNITY_BOX
- ARRIVED_AT_PARCEL_LOCKER
- ARRIVED_AT_PARCEL_SHOP
- ARRIVED_AT_PICKUP_POINT
- ARRIVED_AT_POST_OFFICE
- ARRIVED_AT_SORTING_CENTER
- ASSIGNED_TO_TRANSPORT
- ATTEMPTED_DELIVERY_UNDELIVERABLE
- AT_SORTING_CENTER
- AT_TRANSPORT_HUB
- CARRIER_UNKNOWN
- COMPLETION_OF_CUSTOMS_PROCESSING
- COMPLETION_OF_EXPORT_PROCESSING
- CUSTOMS_PROCESSING
- DELAY_EXPECTED
- DELAY_IN_TRANSPORT
- DELAY_IN_TRANSPORT_MISROUTED_SHIPMENT
- DELAY_IN_TRANSPORT_OFFLOADED_SHIPMENT
- DELIVERY_ATTEMPTED
- DELIVERY_ATTEMPTED_ADDRESSEE_MOVED
- DELIVERY_ATTEMPTED_ADDRESSEE_NOT_KNOWN_AT_ADDRESS
- DELIVERY_ATTEMPTED_ADDRESS_COULD_NOT_BE_FOUND
- DELIVERY_ATTEMPTED_CASH_ON_DELIVERY_AMOUNT_NOT_READY
- DELIVERY_ATTEMPTED_FAILED_WILL_TRY_AGAIN
- DELIVERY_ATTEMPTED_FORWARDING_TO_PICKUP_LOCATION
- DELIVERY_ATTEMPTED_LAST_ATTEMPT
- DELIVERY_ATTEMPTED_RECIPIENT_NOT_AT_HOME
- DELIVERY_ATTEMPTED_RECIPIENT_NOT_AT_HOME_CARD_LEFT
- DELIVERY_ATTEMPTED_REJECTED_BY_ADDRESSEE
- DELIVERY_FAILED_SHIPMENT_DESTROYED
- DELIVERY_LAPSED
- DELIVERY_OPTION_ALTERNATE_LOCATION_REQUESTED
- DELIVERY_OPTION_ALTERNATE_LOCATION_REQUESTED_LOCKER
- DELIVERY_OPTION_ALTERNATE_LOCATION_REQUESTED_SHOP
- DELIVERY_OPTION_ALTERNATE_TIME_REQUESTED
- DELIVERY_OPTION_REQUESTED_BY_RECEIVER
- DELIVERY_SCHEDULED_IN_THE_FINAL_DELIVERY_DEPOT
- DEPARTURE_FROM_TRANSPORT_HUB
- DISPATCHED_FROM_DELIVERY_CENTER
- DISPATCHED_FROM_FORWARDING_DEPOT
- DISPATCHED_FROM_SORTING_CENTER
- DISPATCHING_STARTED_AT_PROCESSING_CENTER
- ENCODING_COMPLETED_AT_PROCESSING_CENTER
- ENCODING_ERROR_IN_PROCESSING_AT_SORTING_CENTER
- ENCODING_STARTED_AT_PROCESSING_CENTER
- ERROR_IN_PARCEL_DATA_SUBMISSION
- ERROR_IN_PROCESSING_AT_SORTING_CENTER
- EXPORT_PROCESSING
- FAILED_TO_HAND_OVER_TO_DELIVERY_PARTNER
- HANDED_OVER_TO_DELIVERY_PARTNER
- HELD_AT_CUSTOMS
- HELD_AT_CUSTOMS_FOR_ADDITIONAL_PAYMENT
- HELD_AT_CUSTOMS_FOR_CLARIFICATIONS
- HELD_AT_EXPORT_PROCESSING
- INBOUND_FLIGHT_ARRIVED
- INBOUND_TRUCK_ARRIVED
- IN_DELIVERY
- ISSUES_IN_PROCESSING_BY_CUSTOMS_AUTHORITIES
- MISSING_SHIPMENT_INFORMATION
- MORE_INFO_ON_CARRIER_WEBSITE
- NO_DELIVERY_ATTEMPT_ON_ROUTE
- ORDER_CANCELLED
- ORDER_CREATED
- ORDER_DELAYED
- ORDER_IN_PROCESSING
- ORDER_PROCESSED
- OUTBOUND_FLIGHT_DEPARTED
- OUTBOUND_TRUCK_DEPARTED
- OUT_FOR_DELIVERY
- PACKAGE_REROUTING_CANCELED_ROUTE_TO_HOME
- PARCEL_COLLECTED_FROM_DROP_OFF_LOCATION
- PARCEL_DATA_SUBMISSION_DELAYED
- PARCEL_DATA_SUBMITTED_TO_CARRIER
- PARCEL_DISPATCHED
- PARCEL_DROPPED_OFF_AT_PARCEL_LOCKER
- PARCEL_DROPPED_OFF_AT_POST_OFFICE
- PARCEL_DROPPED_OFF_IN_PARCEL_SHOP
- PARCEL_DROPPED_OFF_OVER_THE_COUNTER
- PARCEL_DROPPED_OFF_WITH_CARRIER
- PARCEL_READY_FOR_PICKUP
- PARCEL_TRANSFERRED_TO_THIRD_PARTY
- PATCHED
- PICKUP_ATTEMPTED
- PICKUP_DELAYED
- PICKUP_FAILED
- PICKUP_SUCCESSFUL
- PROCEEDING_TO_CARRIER_FACILITY
- PROCESSED_AT_DELIVERY_CENTER
- PROCESSING_AT_TRANSPORT_HUB
- RECEIPT_AT_FORWARDING_DEPOT
- RETURNED_TO_DELIVERY_DEPOT
- RETURN_IN_PROGRESS
- RETURN_TO_ORIGIN_COUNTRY_CANCELLED
- RETURN_TO_ORIGIN_COUNTRY_COMPLETED
- RETURN_TO_ORIGIN_COUNTRY_FAILED
- RETURN_TO_SENDER_COMPLETED
- RETURN_TO_SENDER_FAILED
- RETURN_TO_SENDER_FAILED_RECIPIENT_VERIFICATION
- SCANNED_AT_PROCESSING_CENTER
- SHIPMENT_AT_FINAL_DELIVERY_CENTER
- SHIPMENT_DAMAGED
- SHIPMENT_DELAYED_DUE_TO_CUSTOMER_REQUEST
- SHIPMENT_EN_ROUTE
- SHIPMENT_INFO_SENT_TO_LAST_MILE_SERVICE_PROVIDER
- SHIPMENT_LOST
- SHIPMENT_LOST_IN_DELIVERY
- SHIPMENT_LOST_IN_PROCESSING
- SHIPMENT_LOST_IN_SORTING_CENTER
- SHIPMENT_LOST_IN_TRANSIT
- SHIPMENT_LOST_IN_TRANSPORT
- SHIPMENT_LOST_UNKNOWN_REASON
- SHIPMENT_MISROUTED
- SHIPMENT_NEVER_ARRIVED
- SHIPMENT_NOT_PICKED_UP_FROM_DEPOT_RETURNED_TO_BASE
- SHIPMENT_NOT_PICKED_UP_FROM_DEPOT_RETURNED_TO_ORIGIN_COUNTRY
- SHIPMENT_NOT_PICKED_UP_FROM_PARCEL_LOCKER_RETURNED_TO_BASE
- SHIPMENT_NOT_PICKED_UP_FROM_PARCEL_LOCKER_RETURNED_TO_ORIGIN_COUNTRY
- SHIPMENT_NOT_PICKED_UP_FROM_PARCEL_SHOP_RETURNED_TO_BASE
- SHIPMENT_NOT_PICKED_UP_FROM_PARCEL_SHOP_RETURNED_TO_ORIGIN_COUNTRY
- SHIPMENT_NOT_PICKED_UP_FROM_POST_OFFICE_RETURNED_TO_BASE
- SHIPMENT_NOT_PICKED_UP_FROM_POST_OFFICE_RETURNED_TO_ORIGIN_COUNTRY
- SHIPMENT_NOT_PICKED_UP_RETURNED_TO_BASE
- SHIPMENT_NOT_PICKED_UP_RETURNED_TO_ORIGIN_COUNTRY
- SHIPMENT_ON_HOLD_IN_DELIVERY_CENTER
- SHIPMENT_ON_ITS_WAY_TO_PICKUP_LOCATION
- SHIPMENT_REJECTED_RETURNING_TO_SENDER
- SHIPMENT_RETURNED_TO_ORIGIN_COUNTRY
- SHIPMENT_RETURNED_TO_SENDER
- SHIPMENT_RETURNING_TO_SENDER
- SHIPMENT_SUCCESSFULLY_RETURNED_TO_SENDER
- SHIPMENT_UPDATED_ETA
- SORTING_COMPLETED_AT_PROCESSING_CENTER
- SORTING_ERROR_IN_PROCESSING_AT_SORTING_CENTER
- SORTING_STARTED_AT_PROCESSING_CENTER
- START_OF_CUSTOMS_PROCESSING
- START_OF_EXPORT_PROCESSING
- SUCCESSFULLY_COLLECTED
- SUCCESSFULLY_COLLECTED_AT_PARCEL_LOCKER
- SUCCESSFULLY_COLLECTED_AT_PARCEL_SHOP
- SUCCESSFULLY_COLLECTED_AT_POST_OFFICE
- SUCCESSFULLY_DELIVERED
- SUCCESSFULLY_DELIVERED_AND_CASH_ON_DELIVERY_COLLECTED
- SUCCESSFULLY_DELIVERED_AND_LEFT_AT_DOOR
- SUCCESSFULLY_DELIVERED_AND_LEFT_AT_LETTER_BOX
- SUCCESSFULLY_DELIVERED_AND_PROOF_OF_DELIVERY_COLLECTED
- SUCCESSFULLY_DELIVERED_TO_NEIGHBOR
- SUCCESSFULLY_DELIVERED_TO_THE_COMMUNITY_MAILBOX
- TRANSPORT_ARRIVED
- TRANSPORT_DEPARTED
- USER_SUCCESSFULLY_DELIVERED

event_time
required
string <date-time> (Event Time)

The event time to be added to the shipment

external_id
required
string (External Id)

The external ID of the event.

Responses

Request samples

Content type
application/json
{
  • "event_name": "string",
  • "event_time": "2021-09-01T00:00:00Z",
  • "external_id": "123456"
}

Response samples

Content type
application/json
null

Shop (Shopify)

Search Shopify Webhooks

Get a shopify webhooks based on its uuid.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

query Parameters
page
integer (Page) > 0
Default: 1
per_page
integer (Per Page) ( 0 .. 100 ]
Default: 30

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Shopify Webhook

Create a webhook if it does not exist.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
webhook_type
required
any (ShopifyWebhookType)
Enum: "order-creation" "order-fulfillment" "order-partial-fulfillment" "order-update" "order-fulfillment-update"

Webhook Type

Responses

Request samples

Content type
application/json
{
  • "webhook_type": "order-creation"
}

Response samples

Content type
application/json
{
  • "webhook_type": "order-creation",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "shop_slug": "string",
  • "name": "string",
  • "shopify_id": 0,
  • "topic": "orders/create",
  • "hook_url": "string",
  • "fields": [
    ]
}

Get Shopify Webhook By Uuid

Get a shopify webhooks based on its uuid.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

uuid
required
string <uuid> (Uuid)

The Webhook's UUID

Responses

Response samples

Content type
application/json
{
  • "webhook_type": "order-creation",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "shop_slug": "string",
  • "name": "string",
  • "shopify_id": 0,
  • "topic": "orders/create",
  • "hook_url": "string",
  • "fields": [
    ]
}

Delete Shopify Webhook By Uuid

Delete a webhook that already exists.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

uuid
required
string <uuid> (Uuid)

The webhook's unique identifier

Responses

Response samples

Content type
application/json
null

Get Shopify Webhook By Type

Get a shopify webhooks based on its type.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

webhook_type
required
any (ShopifyWebhookType)
Enum: "order-creation" "order-fulfillment" "order-partial-fulfillment" "order-update" "order-fulfillment-update"

The shopify webhook topic path

Responses

Response samples

Content type
application/json
{
  • "webhook_type": "order-creation",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "shop_slug": "string",
  • "name": "string",
  • "shopify_id": 0,
  • "topic": "orders/create",
  • "hook_url": "string",
  • "fields": [
    ]
}

Delete Shopify Webhook By Type

Delete a webhook that already exists.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

webhook_type
required
any (ShopifyWebhookType)
Enum: "order-creation" "order-fulfillment" "order-partial-fulfillment" "order-update" "order-fulfillment-update"

The shopify webhook topic path

Responses

Response samples

Content type
application/json
null

Shop

Search Shops

Search shops based on some values to filter.

Authorizations:
HTTPBasic
query Parameters
page
integer (Page) > 0
Default: 1
per_page
integer (Per Page) ( 0 .. 100 ]
Default: 30
uuid
string <uuid> (Uuid)
name
string (Name)
slug
string (Slug)
shop_provider
any (ShopProvider)
Enum: "shopware" "shopify"

Enum for identifying the shop provider of a merchant.

language
string (LanguageEnum)
Enum: "da" "nl" "en" "fr" "de" "it" "es"

Supported languages.

organization
string (Organization)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Shop

Create a shop if it does not exist.

Authorizations:
HTTPBasic
Request Body schema: application/json
required
name
required
string (Name)

Name to display

description
string (Description)

Shop description dependant on user language

organization
string (Organization)

Organization the shop belongs to (premium only)

language
string (LanguageEnum)
Default: "en"
Enum: "da" "nl" "en" "fr" "de" "it" "es"

Default language for the shop to fallback to in translations

shop_provider
any (ShopProvider)
Enum: "shopware" "shopify"

Shop system provider

shop_admin_url
string <uri> (Shop Admin Url) [ 1 .. 65536 ] characters

URL for API calls to the shop

shop_faq_url
string (Shop Faq Url)

URL for the FAQ page

shop_service_url
string (Shop Service Url)

URL for the service page

shop_url
string <uri> (Shop Url) [ 1 .. 65536 ] characters

URL to the main shop

logo_url
string <uri> (Logo Url) [ 1 .. 65536 ] characters

Merchant logo image URL

slug
required
string (Slug)

Slug to filter

object (Settings)
Default: {"klaviyo_triggers_enabled":false,"shopify_triggers_enabled":false,"carriers_enabled":false}

Initial settings for the shop to create

Responses

Request samples

Content type
application/json
{
  • "name": "Karla",
  • "description": "Karla Shop",
  • "organization": "string",
  • "language": "en",
  • "shop_provider": "shopware",
  • "shop_admin_url": "http://example.com",
  • "shop_faq_url": "string",
  • "shop_service_url": "string",
  • "shop_url": "http://example.com",
  • "logo_url": "http://example.com",
  • "slug": "gokarla",
  • "settings": {
    }
}

Response samples

Content type
application/json
null

Get Shop Detail

Get details about a specific shop.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "uuid": "0a1ba634-8850-4d2e-83fe-3c0b8d8e9e95",
  • "name": "Karla",
  • "slug": "gokarla",
  • "organization": "string",
  • "language": "en",
  • "logo_url": "http://example.com",
  • "shop_url": "http://example.com",
  • "description": "Karla Shop",
  • "shop_provider": "shopware",
  • "shop_admin_url": "http://example.com",
  • "shop_faq_url": "string",
  • "shop_service_url": "string"
}

Delete Shop

Delete a shop that already exists.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Responses

Response samples

Content type
application/json
null

Update Shop

Update a shop partially or completely.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
name
string (Name)

Name to display

description
string (Description)

Shop description dependant on user language

organization
string (Organization)

Organization the shop belongs to

language
string (LanguageEnum)
Default: "en"
Enum: "da" "nl" "en" "fr" "de" "it" "es"

Default language for the shop to fallback to in translations

shop_provider
any (ShopProvider)
Enum: "shopware" "shopify"

Shop system provider

shop_admin_url
string <uri> (Shop Admin Url) [ 1 .. 65536 ] characters

URL for API calls to the shop

shop_faq_url
string (Shop Faq Url)

URL for the FAQ page

shop_service_url
string (Shop Service Url)

URL for the service page

shop_url
string <uri> (Shop Url) [ 1 .. 65536 ] characters

URL to the main shop

logo_url
string <uri> (Logo Url) [ 1 .. 65536 ] characters

Merchant logo image URL

Responses

Request samples

Content type
application/json
{
  • "name": "Karla",
  • "description": "Karla Shop",
  • "organization": "string",
  • "language": "en",
  • "shop_provider": "shopware",
  • "shop_admin_url": "http://example.com",
  • "shop_faq_url": "string",
  • "shop_service_url": "string",
  • "shop_url": "http://example.com",
  • "logo_url": "http://example.com"
}

Response samples

Content type
application/json
null

Set Klaviyo Key

Set a klaviyo api key for the shop.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
api_key
required
string (Api Key) [ 16 .. 128 ] characters

The api key

Responses

Request samples

Content type
application/json
{
  • "api_key": "stringstringstri"
}

Response samples

Content type
application/json
null

Set Shopify Access Token

Set a shopify access token for the shop.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
api_key
required
string (Api Key) [ 16 .. 128 ] characters

The api key

Responses

Request samples

Content type
application/json
{
  • "api_key": "stringstringstri"
}

Response samples

Content type
application/json
null

Set Shopware Api Credentials

Set shopware api credentials for the shop.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
client_id
required
string (Client Id)

The client id

client_secret
string (Client Secret)

The client secret

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "client_secret": "string"
}

Response samples

Content type
application/json
null

List Keys

List all integration keys for a shop.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Responses

Response samples

Content type
application/json
{
  • "klaviyo": "pk_*******************************123",
  • "shopify": "shpua_****************************321"
}

Upload Shop Image

Upload an image for a shop.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

image_type
required
any (ImageType)
Enum: "background" "claim" "logo" "signature" "product" "voucher"

The type of image to upload

Request Body schema: multipart/form-data
required
image
required
string <binary> (Image)

The logo image to upload

Responses

Response samples

Content type
application/json
{
  • "url": "string",
  • "image_type": "background",
  • "shop_slug": "string"
}

Shop Settings

Get Shop Settings

Get settings for a specific shop.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Responses

Response samples

Content type
application/json
{
  • "carriers": {
    },
  • "triggers": {
    },
  • "segments": {
    }
}

Update Shop Carrier Settings

Update carrier settings for a specific shop.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
shipment_updates
boolean (Shipment Updates)

Toggle retrieving shipment updates from carriers

Responses

Request samples

Content type
application/json
{
  • "shipment_updates": true
}

Response samples

Content type
application/json
{
  • "shipment_updates": true
}

Update Shop Trigger Settings

Update trigger settings for a specific shop.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
klaviyo
boolean (Klaviyo)

Toggle sending triggers to Klaviyo

shopify
boolean (Shopify)

Toggle sending triggers to Shopify

Responses

Request samples

Content type
application/json
{
  • "klaviyo": true,
  • "shopify": true
}

Response samples

Content type
application/json
{
  • "klaviyo": true,
  • "shopify": true
}

Update Shop Segment Settings

Update segment settings for a specific shop.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
klaviyo
boolean (Klaviyo)

Toggle Klaviyo segment retrieval

Responses

Request samples

Content type
application/json
{
  • "klaviyo": true
}

Response samples

Content type
application/json
{
  • "klaviyo": true,
  • "shopify": true
}

Webhook

Search Webhooks

Search all webhooks or based on some values to filter.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

query Parameters
page
integer (Page) > 0
Default: 1
per_page
integer (Per Page) ( 0 .. 100 ]
Default: 30
uuid
string <uuid> (Uuid)
status
any (WebhookStatus)
Enum: "active" "inactive"

Webhook Status Type.

url
string <uri> (Url) [ 1 .. 65536 ] characters

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Webhook

Create a webhook if it does not exist.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
enabled_events
Array of strings (Enabled Events)
Default: ["*"]

The list of events to enable for this endpoint. ['*'] (the default) indicates that all events are enabled.See webhooks for more details on how to subscribe to our different events.

secret
string (Secret) [ 16 .. 64 ] characters

The secret used to generate webhook signatures. If undefined, we will generate one for you.See webhooks for more details on how to validate the webhook request.

description
string (Description)

An optional description for the endpoint

status
any (WebhookStatus)
Default: "active"
Enum: "active" "inactive"

The status of the webhook.

url
required
string <uri> (Url) [ 1 .. 65536 ] characters

The URL of the webhook endpoint

Responses

Request samples

Content type
application/json
{
  • "enabled_events": [
    ],
  • "secret": "41013bd9-9072-42cd-9902-66da38361be9",
  • "description": "string",
  • "status": "active",
  • "url": "https://example.com/my-webhook-endpoint"
}

Response samples

Content type
application/json
{
  • "enabled_events": [
    ],
  • "secret": "41013bd9-9072-42cd-9902-66da38361be9",
  • "description": "string",
  • "status": "active",
  • "url": "https://example.com/my-webhook-endpoint",
  • "created_at": "2021-01-01T00:00:00Z",
  • "updated_at": "2021-01-01T00:00:00Z",
  • "uuid": "7022541c-62cd-4de3-9fb2-bfdc74bf7834",
  • "shop_slug": "string"
}

Delete Webhook

Delete a webhook that already exists.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

uuid
required
string <uuid> (Uuid)

The webhook's unique identifier

Responses

Response samples

Content type
application/json
null

Update Webhook

Update a webhook partially or completely.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

uuid
required
string <uuid> (Uuid)

The webhook's unique identifier

Request Body schema: application/json
required
description
string (Description)

An optional description for the endpoint

status
any (WebhookStatus)
Enum: "active" "inactive"

The status of the webhook.

url
string <uri> (Url) [ 1 .. 65536 ] characters

The URL of the webhook endpoint

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
null