Vue Storefront is now Alokai! Learn More
@vue-storefront/magento-api

@vue-storefront/magento-api

3.1.0ri:link

Minor Changesri:link

  • 6dc90582: CHANGED Enhanced default GQL productDetailsQuery with new fields: stock_status and only_x_left_in_stock. #1521

Patch Changesri:link

  • 6672edfb: CHANGED Update TSDocs of API methods. Now, they contain examples of usage.

3.0.0ri:link

Major Changesri:link

  • 8b8fdff0: - CHANGED Endpoints interface. Previously, each endpoint contained context param, which is internal and shouldn't be exposed in the final interface. Now, Endpoints interface properties don't contain context param. If you need to use context param, you should use ApiMethods type.
    - import { Endpoints } from '@vue-storefront/magento-api';
+ import { ApiMethods } from '@vue-storefront/magento-api';
    • CHANGED Removed ContextualizedEndpoints type. Use Endpoints instead.
    - import { ContextualizedEndpoints } from '@vue-storefront/magento-api';
+ import { Endpoints } from '@vue-storefront/magento-api';
    • REMOVED MagentoApiMethods interface. Use Endpoints instead.
    - import { MagentoApiMethods } from '@vue-storefront/magento-api';
+ import { Endpoints } from '@vue-storefront/magento-api';

2.7.0ri:link

Minor Changesri:link

  • 8b2a0c35: ADDED categories endpoint that allows fetching a list of categories that match the specified filter. CHANGED categoryList endpoint is now deprecated in favor of the new categories endpoint.

Patch Changesri:link

  • Updated dependencies 8b2a0c35
    • @vue-storefront/magento-types@1.2.0

2.6.0ri:link

Minor Changesri:link

  • 7ce4f9ed: CHANGED Enhanced default GQL queries
    • CategorySearchQuery new fields:
      • url_key - The url key assigned to the category.
      • children - Child categories tree.
        • include_in_menu
        • is_anchor
        • level
        • name
        • position
        • product_count
        • uid
        • url_key
        • url_path
        • url_suffix
    // get category `children` categories

const category = sdk.commerce.categorySearch();
const children = category.children;
    • CategoryListQuery new fields:
      • children.url_key - The url key assigned to the category.
    // get `url_key` of category children

const categoryList = sdk.commerce.categoryList();

for (let categoryChildren of categoryList.children) {
  const url_key = categoryChildren.url_key;
}

    // get ConfigurableProduct `variants` products

const products = sdk.commerce.products();

for (let product of products) {
  if (product.__typename === "ConfigurableProduct") {
    const variants = products.variants;
  }
}

Patch Changesri:link

2.5.0ri:link

Minor Changesri:link

  • eda02ee7: CHANGED Update addConfigurableProductsToCart and addBundleProductsToCart methods to align with the rest of the API methods. It is an internal change that does not affect the public API.

Patch Changesri:link

  • 06362368: CHANGED Context from type to interface to allow declaration merging.

2.4.3ri:link

Patch Changesri:link

  • adc748ef: * Updated @apollo/client dependency from version ^3.6.9 to version 3.8.7 in the api-client package.
  • adc748ef: * Fixed a bug in the GraphQL mutation in the generateCustomerToken API. Replaced the ${generateCustomerToken} template string with ${generateCustomerTokenGQL.query} in the mutation to address the bug.

2.4.2ri:link

Patch Changesri:link

  • Updated dependencies 045784a6
    • @vue-storefront/magento-types@1.0.2

2.4.1ri:link

Patch Changesri:link

  • 78edfd5c: * Fixed a bug in the GraphQL mutation in the generateCustomerToken API. Replaced the ${generateCustomerToken} template string with ${generateCustomerTokenGQL.query} in the mutation to address the bug.

2.4.0ri:link

Minor Changesri:link

  • d634cdbe: ## Changes
    This change adds support for custom queries in the route method of both the api-client and sdk modules. The route query has also been extended with a CategoryInterface fragment. These changes improve the flexibility and functionality of the route method, allowing for more customization and control over the data returned.

    api-clientri:link

    • Expanded the route query to include a CategoryInterface fragment.
    • Introduced support for customQueries within the route API method.

    sdkri:link

    • Now includes support for customQueries in the route SDK method.

Patch Changesri:link

  • 992734bf: ## Changes
    This change adds support for custom queries in the generateCustomerToken method of both the api-client and sdk modules.

    api-clientri:link

    • Introduced support for customQueries within the route API method.

    sdkri:link

    • Now includes support for customQueries in the route SDK method.

2.3.0ri:link

Minor Changesri:link

  • a9ea521f: Added Compatibility: Now supports domain-based store resolving with the Unified MultiStore module.

2.2.0ri:link

Minor Changesri:link

  • 07d2087a: Bumped @vue-storefront/middleware version to ^3.5.0 which introduces support for HTTP GET requests.

2.1.1ri:link

Patch Changesri:link

  • Turn off query deduplication to prevent any potential session leaks.

2.1.0ri:link

Minor Changesri:link

  • Add node 18 support

2.0.1ri:link

Patch Changesri:link

  • Fix products and productDetails endpoints to return 200 instead of 500 when no products found