Build

Trigger builds for campaigns, pages, and custom components. Builds compile shop assets ready for publishing.

Build Campaigns and Pages

post

This API allows you to build Limio Campaigns and Pages in bulk, without needing to build them one by one. You can build multiple campaigns and pages at once by providing an array of items to build. This can be useful for building multiple campaigns and pages at once, for example, when you want to build a set of campaigns and pages for a new product launch.

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Body

application/json

itemsarrayOptional

The list of campaigns and pages to build

Example: ["/offers/Limio Campaign","/pages/Limio Page"]

Responses

200

OK

application/json

buildPathsarrayOptional

The list of campaigns and pages built

Example: ["/offers/Limio Campaign","/pages/Limio Page"]

idstringOptional

The unique identifier of the build

Example: build-{{limioTenant}}-shop:xxxxx

successbooleanOptional

Indicates if the build has been completed

Example: true

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

502

Bad Gateway — an upstream service returned an unexpected response. This typically indicates an issue with the request payload (e.g. invalid field values, missing required fields) or a transient infrastructure error. Retry the request, and if the issue persists, verify the request body matches the expected schema.

application/json

post

/shop/builds

HTTPcURLJavaScriptPython

POST /api/shop/builds HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "items": [
    "/offers/Limio Campaign",
    "/pages/Limio Page"
  ]
}

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

Get Custom Component Builds

get

Retrieve build information for custom components deployed to your Limio environment. Optionally filter by a specific commit hash to see the build status of a particular code revision.

Authorizations

bearerAuth

AuthorizationstringRequired

OAuth 2.0 Bearer token for authenticated API access. Required for order submission, object management, and administrative operations.

Obtain a token via the OAuth flow described in OAuth Bearer Token.

Pass the token in the Authorization header: Bearer <token>

Query parameters

commitHashstringOptional

Will retrieve the build information for the specified commit hash.

Example: qv0hg3h4

Responses

200

OK

application/json

idstringOptional

The unique identifier of the build

Example: {env-name}-component-builder-2:468d57a0-c9f7-4f66-ba3a-86eac185f0d0

buildNumberstringOptional

The build number of the build

Example: 25

commitIdstringOptional

The commit id which triggered the build

Example: 608f72e742a77bd0862b1b30d84814f00fc2fceb

startTimestringOptional

Indicates the time the build started

Example: 2024-03-26T12:22:14.554Z

endTimestringOptional

Indicates the time the build ended

Example: 2024-03-26T12:22:14.554Z

buildStatusstring · enumOptional

Indicates the status of the build

Possible values:

buildCompletebooleanOptional

Indicates if the build has been completed

Example: true

logErrorsarrayOptional

Any error messages that occurred during the build, which may prevent the shop from building successfully

Example: ["Error: No such import 'MyIcon' in /offerCard.js"]

401

Unauthorized — the request lacks valid authentication credentials. Verify your Bearer token or API key is correct and has not expired.

application/json

404

Builds not found

application/json

get

/component/builds

HTTPcURLJavaScriptPython

GET /api/component/builds HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": [
    "{env-name}-component-builder-2:468d57a0-c9f7-4f66-ba3a-86eac185f0d0"
  ],
  "buildNumber": "25",
  "commitId": "608f72e742a77bd0862b1b30d84814f00fc2fceb",
  "startTime": "2024-03-26T12:22:14.554Z",
  "endTime": "2024-03-26T12:22:14.554Z",
  "buildStatus": "SUCCEEDED",
  "buildComplete": true,
  "logErrors": [
    "Error: No such import 'MyIcon' in /offerCard.js"
  ]
}