Spryker API

Spryker 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 version 202001.0 of Spryker.

project.yml configuration

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

configuration:
    spryker:
        endpoint: # this is your unique endpoint for Spryker
        projectKey: # this is your unique project key for Spryker
        priceMode: # this is what you've set up in Spryker
        currency: # this is what you've set up in Spryker
        shop: # this is what you've set up in Spryker
    product: # you'll need to duplicate this section for account, cart, search, wishlist
        engine: spryker

Available methods

Account

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

AccountAPI methodAvailable?
getSalutationsstatic
confirmEmailnot implemented
createyes
updateyes
updatePasswordyes
generatePasswordResetTokenyes
resetPasswordyes
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 implemented
getCustomLineItemTypenot implemented
setTaxCategorynot implemented
getTaxCategorynot implemented
addToCartyes
updateLineItemyes
removeLineItemyes
setEmailyes
setShippingMethodyes
setCustomField (deprecated)n/a
setRawApiInputyes
setShippingAddressyes
setBillingAddressyes
addPaymentyes
updatePaymentnot implemented
redeemDiscountCodeyes
removeDiscountCodeyes
orderyes
getOrderyes
getOrdersyes
startTransactionyes
commityes
getAvailableShippingMethodsyes
getShippingMethodsnot supported by Spryker

Product

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

ProductAPI methodAvailable?
queryCategoriesyes
getProductTypesnot supported by Spryker
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)not implemented
query (facets)yes
query (sortAttributes)yes

Wishlist

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

WishlistAPI methodAvailable?
getWishlistyes
getAnonymousnot supported by Spryker
getWishlistsyes
createyes
addToWishlistyes
addMultipleToWishlistnot implemented
updateLineItemnot supported by Spryker
removeLineItemyes

Known limitations

Spryker requires that all information regarding the account, shipping, billing, and payment is sent in a single request to create an order. Therefore, all this data needs to be sent to the frontend when the CartApi::order() is used.

Spryker doesn't provide product filters for SKUs or productIds, so it's not possible to add those filters as part of searchableAttribute.