Partner Orders

Partner endpoints for order submission and preview. Orders are attributed to the partner organisation and run partner-specific eligibility checks.

Submit Partner Order

post

Submit an order using partner credentials. The order is attributed to the partner organisation and runs partner-specific eligibility checks. All related objects are associated with the partner context.

Required scopes

This endpoint requires the following scopes:

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

or

or

or

or

Responses

200

Order submitted successfully.

application/json

Response returned after successfully submitting an order.

idstringOptional

Unique identifier of the created order.

Example: order-4dd195c3eee4297e33aecb5436cf8092

order_referencestringOptional

Human-readable order reference code.

Example: 8HK92PL401QW

statusstring · enumOptional

Processing status of the order.

Example: completePossible values:

external_idstringOptional

The external order reference provided in the request, if any.

Example: EXT-ORD-12345

subscriptionReferencestringOptional

Reference code of the subscription created or modified by this order.

Example: 2TJ25TK632EG

ownerstringOptional

The identity ID that owns objects created by this order.

Example: id-62401f8d5bf6b26a37ea0defd66fd005

400

Invalid order payload.

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.

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

/partner/order

HTTPcURLJavaScriptPython

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

{
  "external_id": "EXT-ORD-12345",
  "initiated_source": "shop",
  "source": "shop",
  "process_immediately": false,
  "order_type": "new",
  "orderItems": [
    {
      "offer": {
        "id": "8a512ee55befaea0f7fa962cea9982d0e84f0098",
        "version": "4dd34671f26fdbbf240560b78f7f2f54654cde72"
      },
      "quantity": 1
    }
  ],
  "orderDiscount": {
    "name": "TEST123",
    "productDetails": {
      "ratePlan": {
        "path": "30% Off Monthly"
      },
      "product": {
        "path": "/products/Discounts"
      }
    },
    "product": {
      "baseTemplate": "/config/templates/products/default",
      "entitlements": [
        {
          "$ref": "/entitlements/Digital"
        }
      ],
      "path": "/products/Digital",
      "created": "2023-12-11T13:44:43+00:00",
      "modified": "2024-01-15T13:56:18+00:00",
      "attributes": {
        "display_name__limio": "Digital",
        "has_delivery__limio": false,
        "product_code__limio": "LI.DIGITAL"
      },
      "record_type": "product",
      "lastSynced": "2024-03-12T16:00:35.232Z",
      "synced": true,
      "syncedFrom": "2c92c0f9778c090d0177aa4f357d043b"
    },
    "discountOverrides": {
      "discountType": "DiscountPercentage",
      "durationLength": 1,
      "durationType": "Months",
      "percentageDiscount": 10,
      "amountDiscount": 10,
      "currency": "USD",
      "orderItemsWithSpecifiedDiscount": {
        "discountedOffers": []
      }
    }
  },
  "billingDetails": {
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "workEmail": "text",
    "phone": "text",
    "workPhone": "text",
    "otherPhone": "text",
    "company": "text",
    "address1": "text",
    "address2": "text",
    "city": "text",
    "state": "text",
    "postalCode": "text",
    "country": "text"
  },
  "deliveryDetails": {
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "workEmail": "text",
    "phone": "text",
    "workPhone": "text",
    "otherPhone": "text",
    "company": "text",
    "address1": "text",
    "address2": "text",
    "city": "text",
    "state": "text",
    "postalCode": "text",
    "country": "text"
  },
  "customerDetails": {
    "firstName": "text",
    "lastName": "text",
    "phone": "text",
    "email": "text"
  },
  "tracking": {
    "offers": [
      "/offers2/$75 for 52 weeks then $31.96 every 4 weeks autorenew"
    ],
    "purchaseCountryCode": "GB",
    "accountId": "0017x00000Q9O9qAAF",
    "contactId": "0037x00000F58M9AAJ",
    "userId": "0057x0000088Oh3AAE"
  },
  "payment": {
    "type": "zuora",
    "zuora": {
      "refId": "2c92c0f96e4e3b7f016e5f3b3b7b0b3d",
      "paymentGateway": "CreditCard_UK"
    }
  },
  "orderDate": "2020-01-01T00:00:00Z",
  "checkoutId": "basket-22e3d318-92e2-4909-b59c-1265623bc3f6",
  "country": "GB"
}

{
  "id": "order-4dd195c3eee4297e33aecb5436cf8092",
  "order_reference": "8HK92PL401QW",
  "status": "complete",
  "external_id": "EXT-ORD-12345",
  "subscriptionReference": "2TJ25TK632EG",
  "owner": "id-62401f8d5bf6b26a37ea0defd66fd005"
}

Preview Partner Order

post

Preview an order within the partner context without submitting it. Returns the calculated pricing, line items, and billing schedule from the billing provider. Useful for showing the customer a price summary before confirming the order.

Required scopes

This endpoint requires the following scopes:

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

objectOptional

Order payload to preview.

Responses

200

Order preview with calculated pricing.

application/json

objectOptional

Preview result from the billing provider. Structure varies by billing plugin (Zuora, Stripe).

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

/partner/order/preview

HTTPcURLJavaScriptPython

POST /api/partner/order/preview HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{}