Shopware API

Shopware is a commerce platform that's integrated with Frontastic.

The backend part of the integration is within our API documentation in GitHub. To see any updates to this library, check out our Libraries changelog.

We're using the SalesChannel Api v2 version of Shopware.

project.yml configuration

To access the APIs for Shopware, you'll need the below configuration added to your project.yml (see the project.yml article for more information):

configuration:
    shopware:
        apiKey: # this is your unique API key for Shopware
        endpoint: # this is your unique endpoint for Shopware
        clientId: # this is your unique clientId for Shopware
        clientSecret: # this is your unique clientSecret for Shopware 
    product: # you'll need to duplicate this section for account, cart, search
        engine: shopware
    wishlist:
        engine: no-wishlist # wishlist API isn't supported with Shopware

Available methods

Account

See the AccountAPI docs for arguments, types, and other information.

AccountAPI methodAvailable?
getSalutationsstatic
confirmEmailnot supported by Shopware
createyes
updateyes
updatePasswordyes
generatePasswordResetTokennot supported by Shopware
resetPasswordnot supported by Shopware
loginyes
refreshAccountyes
getAddressesyes
addAddressyes
updateAddressyes
removeAddressyes
setDefaultBillingAddressyes
setDefaultShippingAddressyes

Cart

See the CartAPI docs for arguments, types, and other information.

CartAPI methodsAvailable?
getForUseryes
getAnonymousyes
getByIdyes
setCustomLineItemTypenot supported by Shopware
getCustomLineItemTypenot supported by Shopware
setTaxCategorynot supported by Shopware
getTaxCategorynot supported by Shopware
addToCartyes
updateLineItemyes
removeLineItemyes
setEmailnot supported by Shopware
setShippingMethodnot supported by Shopware
setCustomField (deprecated)n/a
setRawApiInputnot supported by Shopware
setShippingAddressnot supported by Shopware
setBillingAddressnot supported by Shopware
addPaymentnot supported by Shopware
updatePaymentnot supported by Shopware
redeemDiscountCodeyes
removeDiscountCodeyes
orderyes
getOrderyes
getOrdersyes
startTransactionyes
commityes
getAvailableShippingMethodsyes
getShippingMethodsyes

Product

See the ProductAPI docs for arguments, types, and other information.

ProductAPI methodAvailable?
queryCategoriesyes
getProductTypesnot supported by Shopware
getProductyes

Product search

See the ProductSearchAPI docs for arguments, types, and other information.

ProductSearchAPI methodAvailable?
getSearchableAttributesyes
query (by query string)yes
query (by category)yes
query (by SKU) (deprecated)yes
query (by SKUs)yes
query (by productId) (deprecated)yes
query (by productIds)yes
query (by productType)not implemented
query (by filters)yes
query (facets)yes
query (sortAttributes)yes

Wishlist

The wishlist API isn't supported with Shopware.

Known limitations

Price filters: Shopware only allows filter products by price if the query also includes a search term or a category.
Price facets: Shopware only returns price statistics if the query also includes a search term or a category.