SimpleAPI Release Notes

SimpleAPI 1.15.1271 (June 18, 2024)

This is a patch release.

Fixes

  • CBAPI-33 Provisioning of a SimpleAPI subscription could fail with error: "500 Internal Server Error".

  • CBAPI-31 Order parameter validation in SimpleAPI could fail even if the parameters were validated on Connect or PLM side.

Requirements

SimpleAPI 1.15.1262 (March 8, 2024)

Features

  • PFR-6984 The SimpleAPI Onboarding Application now supports the OSS Show Marketplace API menu in UX1 privilege which allows you to control the visibility of the Marketplace API menu item for resellers.

Fixes

  • API-675 The /business-metrics API call failed with the Out of Memory error.

  • API-676 The SimpleAPI validation of order parameters returned the Success status even if they had the Error status in the external system.

Requirements

SimpleAPI 1.14.1232 (October 23, 2023)

This release includes internal improvements only.

SimpleAPI 1.13.1195 (July 28, 2023)

In this release, SimpleAPI schema was updated to support special pricing for products with tier and volume pricing models.

SimpleAPI 1.12.1184 (June 6, 2023)

Fixes

  • API-596 SimpleAPI subscription could not be purchased again if the previous subscription was canceled.

  • API-626 Customer's externalId could not be changed using a PATCH request.

  • API-598 SimpleAPI deployment verification instructions could not be completed.

SimpleAPI 1.11.1173 (April 28, 2023)

Features

  • In this version, support for partial upgrade was added. For this purpose, the alignmentType property of AlignExpirationDate was extended with one more value: CO_TERM_PARTIAL_UPGRADE. This value can be used to co-term a subscription during partial upgrade.

  • SimpleAPI now supports volume- and tier-based pricing models. ProductPrice was extended with the model property that indicates the pricing model and can be one of the following:

    • FLAT

    • TIERED

    • VOLUME_SUBSCRIPTION

    • VOLUME_ORDER

    • VOLUME_RESOURCE_AGGREGATED

    For non-flat pricing models price levels can be configured using the lowerLimit property.

  • To improve statistics collection, when using SimpleAPI for integrations with other applications, you need to pass the application identifier obtained from support in the X-Client-Id header.

Fixes

  • API-617 Scheduled order placement could fail.

SimpleAPI 1.10.1121 (January 17, 2023)

Features

PFR-5830, PFR-5901 Co-terming of subscriptions.

The coterming property was added to the Product schema and the alignExpirationDate property was added to the OrderDetailed schema to support subscription co-terming.

When getting product details, you can check if co-terming is allowed for the product by checking the coterming property in the response. If allowed, you can co-term a subscription to the calendar month end or to another subscription using the alignExpirationDate property when placing a sales or change order.

Requirements

Other microservices required for specific scenarios

  • BSS 21.9 is required to use the co-terming feature.

SimpleAPI 1.9.1096

This SimpleAPI patch adds the fix of the following issue:

  • API-543: When placing an order for a service plan with multiple subscription periods, an incorrect period could be selected.

Note: As of this version, PostgreSQL 13 can now be used for the database of this component.

SimpleAPI 1.9.1093

This release adds support for Kubernetes version 1.22 to the SimpleAPI component.

SimpleAPI 1.9.1090 (patch)

This SimpleAPI patch adds the fix of the following issue:

  • API-580 A /validate call could result in a "Product not found" error.

SimpleAPI 1.9.1089

This SimpleAPI release adds the following improvement and issue fixes:

  • When switching a subscription to another plan, you can now choose to keep the subscription start date. For this purpose, the upgradeStartType parameter was added with two possible values: FROM_DATE_OF_UPGRADE and FROM_OLD_START_DATE.

Fixed issues:

  • API-540 On a call GET /subscriptions an ‘Internal Server Error’ could occur.

  • API-578 When placing or estimating an order, SimpleAPI ignored the showInCustomerPanel resource parameters which could lead to errors.

  • API-550 Specification file was updated to include missing descriptions and corrections.

SimpleAPI 1.8.1047

This release brings the following changes:

  • The /order API was extended with the following fields to identify order sales price: salesUnitPrice, salesExtendedPrice, salesDiscount, salesTaxAmount and salesExclusiveTaxAmount.
  • Billing Period, Subscription Period and Billing Model were added to the /order and /subscriptions APIs for better identification of the PLM products in an MPN hierarchical structure.

  • Now, change orders can be placed also for unpublished service plans.

To upgrade to this version from 1.6 or an earlier SimpleAPI version, refer to the Upgrading SimpleAPI from 1.6 or Earlier Version to 1.7.1008 or Later section.

This SimpleAPI version requires the following components to be installed:

  • BSS 21.5.x or higher.
  • UI and Branding 21.5.x or higher.
  • OSS 21.5.x or higher.

SimpleAPI 1.7.1019

In this release, the following issues were resolved:

  • API-526 Response to an order estimation call did not contain order details.
  • API-525 SimpleAPI application instance upgrade could fail if any of its users were deleted from the system.

To upgrade to this version from 1.6 or an earlier SimpleAPI version, refer to the Upgrading SimpleAPI from 1.6 or Earlier Version to 1.7.1008 or Later section.

This SimpleAPI version requires the following components to be installed:

  • OSS 21.5.x or higher.

Simple API 1.7.1008

SimpleAPI begins collecting key statistics, such as:

  • Number of onboarded resellers.
  • Number of requests, per API call type.
  • Order value of each request, per reseller.
  • Number of requests per status: failed and successful.
  • Number of requests per connector application.

Currently, you cannot access this statistics and we will use it to improve the API.

To upgrade to version, refer to the Upgrading SimpleAPI from 1.6 or Earlier to 1.7.1008 or Later section.

SimpleAPI 1.6.989

This SimpleAPI release adds the following improvement and issue fixes:

  • This component is now based on Red Hat Universal Base Images (UBI). These are lightweight and more secure operating system images as they contain a minimal set of software packages.

  • Procedures in a /subscriptions/{id} request were improved to avoid a 404 response.

  • An additional parameter was added: Partner Attestation of No Self Dealing. It is required by Microsoft for all Microsoft 365 orders.

SimpleAPI 1.6.962

Resolved issues:

  • API-381 An incorrect country code could be passed to domainValidation when placing an order for Office 365.
  • API-395 No currency was returned for subscriptions that have MPNs with zero prices.
  • API-456 When filling out an address, the state field was mandatory, but it is not required for all locations.
  • API-458 Order placement failed when a customer's country is different from the marketplace's country.
  • API-470 SubscriptionID was not displayed in the cancellation orders.

Improvements:

  • A new endpoint to access service plans was added: /plans
    • A GET request to /plans will list all service plans.
    • A GET request to /plans/{id} will return plan details and available upgrades for this plan.
  • When updating a subscription, you can now schedule and provision the changes on its renewal date using the new property "scheduledOn" : "renewal".
  • A new property, billingModel, which identifies the billing model of a product, is now returned when viewing plans or products (available in these requests: GET /plans, GET plans/ {id}, GET /products). If the billing model is specified when placing a change order, only the products with that billing model will be affected by this request (available for these requests: POST /orders, POST /orders/estimation, POST /parameters/validation).

SimpleAPI 1.5.915

This is the first publicly released SimpleAPI version. Refer to About SimpleAPI to learn more about basic features of this component.

Important: Do not install any older version of SimpleAPI, as they may not work correctly.

© 2024 Ingram Micro, Inc. All Rights Reserved. Privacy Policy, Terms of Use and Legal

CloudBlue, an Ingram Micro business, uses cookies to improve the usability of our site. By continuing to use this site and/or logging in you are accepting the use of these cookies. For more information, visit our Privacy Policy.
I accept