Limio
WebsiteHelp Desk
  • Home
  • Custom Components
    • Getting Started with Custom Components
    • Connecting External CI
    • Development Guidelines
    • Prop Types
    • Custom subcomponents
    • Connecting to External Service
  • Limio SDK
    • Getting Started with Limio SDK
    • Basket (Cart), Promo Code
    • Page, Offer, and Add-On
    • User, Subscription, Invoice & Address
    • Advanced Methods
      • Express Checkout
      • Core Utilities and Helpers
  • API Docs
    • Authentication Schemes
      • OAuth Bearer Token
      • API Key (Catalog API-only)
    • Catalog API
    • Promo Codes API
    • Order API
    • Objects API
    • Shop Build & Publish API
    • External Identities API
  • Webhooks
    • Using Webhooks
    • Webhooks Overview
  • I want to...
    • Retrieve abandoned baskets
    • Enable self-service on a CPQ order
Powered by GitBook
On this page
  • Build
  • Options
  • Build
  • Publish
  • Publish

Was this helpful?

  1. API Docs

Shop Build & Publish API

In this walk-through, we will go through how a developer can call the Shop Build API to kick off a build of one or many Limio Landing Pages

Build

You can use the Limio Shop Build API to build one or many Limio pages. This is ideal to be used when changes have been made to multiple campaigns through referencing and all campaigns need to be rebuilt.

Options

items: This is a required Body parameter that contains the paths of the Limio pages to be built.

Build

POST https://{{limioTenant}}.prod.limio.com/api/shop/builds

Headers

Name
Type
Description

Authentication*

String

BEARER

Request Body

Name
Type
Description

items*

JSON

An array of paths of the campaigns to be built: e.g.

[ "/offers/Limio Campaign", "/offers/Limio Switch" ]

{
    "success": true, buildPaths: ["/offers/Limio Campaign", "/offers/Limio Switch"], id: "build-{{limioTenant}}-shop:xxxxx"
}

Publish

You can use the Limio Shop Publish API to publish one or many Limio pages. This is ideal to be used when changes have been made to multiple campaigns through referencing and all campaigns need to be republished after a successful rebuild.

Publish

POST https://{{limioTenant}}.prod.limio.com/api/publish

Headers

Name
Type
Description

Authentication*

String

BEARER

Request Body

Name
Type
Description

tags*

JSON

An array of tags of the campaigns to be published: e.g.

["/tags/uk-uk/default", "/tags/uk-uk/standard"]

name*

String

Name of the campaign to be published.

This is required to be the name of at least one of the campaigns being published for validation.

buildId*

String

This can be found in the response from the Build API with a key of Id. It will start with: "build-{{limioTenant}}-shop:"

{
    // Response
}
PreviousObjects APINextExternal Identities API

Last updated 9 months ago

Was this helpful?