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
project.yml
configurationTo 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 method | Available? |
---|---|
getSalutations | static |
confirmEmail | not implemented |
create | yes |
update | yes |
updatePassword | yes |
generatePasswordResetToken | yes |
resetPassword | yes |
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 implemented |
getCustomLineItemType | not implemented |
setTaxCategory | not implemented |
getTaxCategory | not implemented |
addToCart | yes |
updateLineItem | yes |
removeLineItem | yes |
setEmail | yes |
setShippingMethod | yes |
setCustomField (deprecated) | n/a |
setRawApiInput | yes |
setShippingAddress | yes |
setBillingAddress | yes |
addPayment | yes |
updatePayment | not implemented |
redeemDiscountCode | yes |
removeDiscountCode | yes |
order | yes |
getOrder | yes |
getOrders | yes |
startTransaction | yes |
commit | yes |
getAvailableShippingMethods | yes |
getShippingMethods | not supported by Spryker |
Product
See the ProductAPI docs for arguments, types, and other information.
ProductAPI method | Available? |
---|---|
queryCategories | yes |
getProductTypes | not supported by Spryker |
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) | not implemented |
query (facets) | yes |
query (sortAttributes) | yes |
Wishlist
See the WishlistAPI docs for arguments, types, and other information.
WishlistAPI method | Available? |
---|---|
getWishlist | yes |
getAnonymous | not supported by Spryker |
getWishlists | yes |
create | yes |
addToWishlist | yes |
addMultipleToWishlist | not implemented |
updateLineItem | not supported by Spryker |
removeLineItem | yes |
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
.
Updated over 2 years ago