Promo Codes

Create and manage promotional codes (v2 and v3). V3 promo codes reference discount catalog items instead of embedding discount rules inline.

Create Promo Code Objects

post

Create new promo code objects in Limio. Only promo codes v2 are supported via this endpoint. Promo codes can be configured with product-specific or whole-basket discounts and associated eligibility rules.

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

namestringRequired

The object name. Not included values will not be updated and nested values will require the structure to update. Updates will only occur for the id provided. WARNING! Changing this field might break integrations

Example: abc123

idstringRequired

The object id. This is the record_type and name concatenated such as promo_code_v2-abc123. Not included values will not be updated and nested values will require the structure to update. Updates will only occur for the id provided. WARNING! Changing this field might break integrations

Example: promo_code_v2-abc123

dataone ofRequired

or

Responses

200

Promo codes created successfully.

application/json

idstringOptional

The ID of the object

Example: promo_code_v2-CODE123

namestringOptional

The name of the object

Example: CODE123

statusstringOptional

The status of the object

Example: active

record_typestringOptional

The record type of the object

Example: promo_code_v2

servicestringOptional

The service of the object

Example: limio

dataobjectOptional

The data of the object sent in the request

Example: {"promoStartDate":"2024-10-07"}

400

Bad request — missing or invalid required fields.

401

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

application/json

404

Not found.

post/objects/limio/promo_codes_v2

HTTPcURLJavaScriptPython

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

{
  "name": "abc123",
  "id": "promo_code_v2-abc123",
  "data": {
    "applicationLevel": "wholeBasket",
    "promoCode": "abc123",
    "status": true,
    "description": "",
    "promoStartDate": "2024-11-11",
    "promoExpiryDate": "2024-12-31",
    "productDetails": {
      "product": {
        "path": "/products/Discounts"
      },
      "ratePlan": {
        "path": "'30% Off Monthly' 1 month only"
      }
    },
    "usage": {
      "availableQuantity": 100
    },
    "discount": {
      "discountType": "text",
      "percentageDiscount": 12,
      "durationLength": 1,
      "durationType": "Months"
    }
  }
}

{
  "id": "promo_code_v2-CODE123",
  "name": "CODE123",
  "status": "active",
  "record_type": "promo_code_v2",
  "service": "limio",
  "data": {
    "promoStartDate": "2024-10-07"
  }
}

Create Promo Code V3

post

Create a new promo code (v3) in Limio. V3 promo codes reference a discount catalog item via attachedDiscount rather than embedding discount rules inline.

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

namestringRequired

The promo code name. Used as the code identifier.

Example: SPRING2026

idstringRequired

The object ID. This is the record_type and name concatenated, e.g. promo_code_v3-SPRING2026.

Example: promo_code_v3-SPRING2026

Responses

200

Promo code created successfully.

application/json

idstringOptional

The ID of the object

Example: promo_code_v2-CODE123

namestringOptional

The name of the object

Example: CODE123

statusstringOptional

The status of the object

Example: active

record_typestringOptional

The record type of the object

Example: promo_code_v2

servicestringOptional

The service of the object

Example: limio

dataobjectOptional

The data of the object sent in the request

Example: {"promoStartDate":"2024-10-07"}

400

Bad request — missing or invalid required fields.

401

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

application/json

404

Not found.

post/objects/limio/promo_codes_v3

HTTPcURLJavaScriptPython

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

{
  "name": "SPRING2026",
  "id": "promo_code_v3-SPRING2026",
  "data": {
    "promoCode": "SPRING2026",
    "status": true,
    "description": "Spring 2026 campaign discount",
    "promoStartDate": "2026-04-01",
    "promoExpiryDate": "2026-06-30",
    "usage": {
      "availableQuantity": 500,
      "redeemedQuantity": 0
    },
    "attachedDiscount": {
      "id": "discount-abc123",
      "path": "/discounts/spring-2026",
      "name": "Spring 2026 - 20% off"
    }
  }
}

{
  "id": "promo_code_v2-CODE123",
  "name": "CODE123",
  "status": "active",
  "record_type": "promo_code_v2",
  "service": "limio",
  "data": {
    "promoStartDate": "2024-10-07"
  }
}