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 method

Available?

getSalutations

static

confirmEmail

not supported by Shopware

create

yes

update

yes

updatePassword

yes

generatePasswordResetToken

not supported by Shopware

resetPassword

not supported by Shopware

login

yes

refreshAccount

yes

getAddresses

yes

addAddress

yes

updateAddress

yes

removeAddress

yes

setDefaultBillingAddress

yes

setDefaultShippingAddress

yes

Cart

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

CartAPI methods

Available?

getForUser

yes

getAnonymous

yes

getById

yes

setCustomLineItemType

not supported by Shopware

getCustomLineItemType

not supported by Shopware

setTaxCategory

not supported by Shopware

getTaxCategory

not supported by Shopware

addToCart

yes

updateLineItem

yes

removeLineItem

yes

setEmail

not supported by Shopware

setShippingMethod

not supported by Shopware

setCustomField (deprecated)

n/a

setRawApiInput

not supported by Shopware

setShippingAddress

not supported by Shopware

setBillingAddress

not supported by Shopware

addPayment

not supported by Shopware

updatePayment

not supported by Shopware

redeemDiscountCode

yes

removeDiscountCode

yes

order

yes

getOrder

yes

getOrders

yes

startTransaction

yes

commit

yes

getAvailableShippingMethods

yes

getShippingMethods

yes

Product

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

ProductAPI method

Available?

queryCategories

yes

getProductTypes

not supported by Shopware

getProduct

yes

Product search

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

ProductSearchAPI method

Available?

getSearchableAttributes

yes

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.


Did this page help you?