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...

Operations

Get Shop Settings

Get settings for a specific shop.

Authorizations:

HTTPBasic

path Parameters

slug required

string (Slug) The slug identifying the shop

Responses

https://docs.gokarla.io/v1/shops/{slug}/settings

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "carriers": {

  • "shipment_updates": true

  },
• "triggers": {

  • "klaviyo": true,
  • "shopify": true

  },
• "segments": {

  • "klaviyo": true,
  • "shopify": true

  }

}

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

https://docs.gokarla.io/v1/shops/{slug}/settings/carriers

Request samples

• Payload

Content type

application/json

{

• "shipment_updates": true

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

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

https://docs.gokarla.io/v1/shops/{slug}/settings/triggers

Request samples

• Payload

Content type

application/json

{

• "klaviyo": true,
• "shopify": true

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

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

https://docs.gokarla.io/v1/shops/{slug}/settings/segments

Request samples

• Payload

Content type

application/json

{

• "klaviyo": true

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 422
• 500

Content type

application/json

{

• "klaviyo": true,
• "shopify": true

}

API Reference

• Shop Setting