@vue-storefront/magento-api
5.0.0
Major Changes
- 018d73d3: - BREAKING Updated
@vue-storefront/middleware
version to4.1.0
. Make sure this version is used in your project.{ ... "dependencies": { - "@vue-storefront/middleware": "3.x.x", + "@vue-storefront/middleware": "4.1.0" } }
4.0.1 (deprecated)
This package version is deprecated. Please use the next major version.
Patch Changes
- d65bb6ee: CHANGED Updated
@vue-storefront/middleware
version to4.x.x
.
4.0.0
Major Changes
- e4709f9a: Changed minimum Node version from 16 to 18. The condition that was forcing the Node version to be lower than 19 is also removed.
Patch Changes
- Updated dependencies e4709f9a
- @vue-storefront/magento-types@2.0.0
3.1.1
Patch Changes
- 3065ee76: ADDED
CategoriesQuery
type forcategories
endpoint. - 101d9905: FIXED: Added export of
Endpoints
type, because it was missing.
3.1.0
Minor Changes
- 6dc90582: CHANGED Enhanced default GQL
productDetailsQuery
with new fields:stock_status
andonly_x_left_in_stock
. #1521
Patch Changes
- 6672edfb: CHANGED Update TSDocs of API methods. Now, they contain examples of usage.
3.0.0
Major Changes
- 8b8fdff0: - CHANGED
Endpoints
interface. Previously, each endpoint containedcontext
param, which is internal and shouldn't be exposed in the final interface. Now,Endpoints
interface properties don't containcontext
param. If you need to usecontext
param, you should useApiMethods
type.- import { Endpoints } from '@vue-storefront/magento-api'; + import { ApiMethods } from '@vue-storefront/magento-api';
- CHANGED Removed
ContextualizedEndpoints
type. UseEndpoints
instead.
- import { ContextualizedEndpoints } from '@vue-storefront/magento-api'; + import { Endpoints } from '@vue-storefront/magento-api';
- REMOVED
MagentoApiMethods
interface. UseEndpoints
instead.
- import { MagentoApiMethods } from '@vue-storefront/magento-api'; + import { Endpoints } from '@vue-storefront/magento-api';
- CHANGED Removed
2.7.0
Minor Changes
- 8b2a0c35: ADDED
categories
endpoint that allows fetching a list of categories that match the specified filter. CHANGEDcategoryList
endpoint is now deprecated in favor of the newcategories
endpoint.
Patch Changes
- Updated dependencies 8b2a0c35
- @vue-storefront/magento-types@1.2.0
2.6.0
Minor Changes
- 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; }
ProductListsQuery
new fields:variants
- An array of variants ofConfigurableProduct
// get ConfigurableProduct `variants` products const products = sdk.commerce.products(); for (let product of products) { if (product.__typename === "ConfigurableProduct") { const variants = products.variants; } }
Patch Changes
- 7ce4f9ed: FIXED
CategoryListQuery
returnsurl_key
property on each children level
CHANGED Enhanced default GQL queriesCategoryListQuery
- fetch up to 5th level nested categories
children
- fetch up to 5th level nested categories
- 7ce4f9ed: CHANGED Enhanced default GQL queries
ProductDetailsQuery
- enhanced
ConfigurableProduct
response withConfigurableVariants
- enhanced
- 7ce4f9ed: CHANGED Enhanced default GQL queries with new fields
CartQuery
CustomerCartQuery
ApplyCouponToCartMutation
RemoveCouponFromCartMutation
AddProductsToCartMutation
RemoveItemFromCartMutation
SetShippingMethodsOnCartMutation
MergeCartsMutation
with new fields:prices
subtotal_with_discount_excluding_tax
configured_variant
sku
name
only_x_left_in_stock
price_range
- 7ce4f9ed: FIXED
updateCustomerAddress
method declaration argument type. Useid
instead ofaddressId
.
CHANGED Enhanced default GQL queriesCreateCustomerAddress
response with fieldsfirstname
lastname
prefix
suffix
- 7ce4f9ed: CHANGED Enhanced default GQL queries with new fields
SetGuestEmailOnCartMutation
SetBillingAddressOnCartMutation
SetPaymentMethodOnCartMutation
SetShippingAddressesOnCartMutation
with new fields:prices
subtotal_with_discount_excluding_tax
configured_variant
sku
name
only_x_left_in_stock
price_range
- Updated dependencies 7ce4f9ed
- Updated dependencies 7ce4f9ed
- Updated dependencies 7ce4f9ed
- Updated dependencies 7ce4f9ed
- Updated dependencies 7ce4f9ed
- Updated dependencies 7ce4f9ed
- Updated dependencies 7ce4f9ed
- @vue-storefront/magento-types@1.1.0
2.5.0
Minor Changes
- 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 Changes
- 06362368: CHANGED
Context
from type to interface to allow declaration merging.
2.4.3
Patch Changes
- adc748ef: * Updated @apollo/client dependency from version
^3.6.9
to version3.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.2
Patch Changes
- Updated dependencies 045784a6
- @vue-storefront/magento-types@1.0.2
2.4.1
Patch Changes
- 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.0
Minor Changes
- d634cdbe: ## Changes
This change adds support for custom queries in theroute
method of both theapi-client
andsdk
modules. Theroute
query has also been extended with aCategoryInterface
fragment. These changes improve the flexibility and functionality of theroute
method, allowing for more customization and control over the data returned.api-client
- Expanded the route query to include a
CategoryInterface
fragment. - Introduced support for
customQueries
within the route API method.
sdk
- Now includes support for
customQueries
in the route SDK method.
- Expanded the route query to include a
Patch Changes
- 992734bf: ## Changes
This change adds support for custom queries in thegenerateCustomerToken
method of both theapi-client
andsdk
modules.api-client
- Introduced support for
customQueries
within the route API method.
sdk
- Now includes support for
customQueries
in the route SDK method.
- Introduced support for
2.3.0
Minor Changes
- a9ea521f: Added Compatibility: Now supports domain-based store resolving with the Unified MultiStore module.
2.2.0
Minor Changes
- 07d2087a: Bumped
@vue-storefront/middleware
version to^3.5.0
which introduces support for HTTP GET requests.
2.1.1
Patch Changes
- Turn off query deduplication to prevent any potential session leaks.
2.1.0
Minor Changes
- Add node 18 support
2.0.1
Patch Changes
- Fix products and productDetails endpoints to return 200 instead of 500 when no products found