This change log covers significant updates and changes to the ePages REST API. In order to keep track of these changes we recommend you to follow @epagesdevs on Twitter or subscribe to our RSS feed for the API Change Log.

2017-05-30: We have achieved the desired functional range of the REST API. Feature-free releases won’t be reported anymore. Of course, we will continue to inform you if there are any breaking changes to the API.

2024-03-21

Changes with software release 7.93.0

Update

• The attribute path /orderUnitsInfo can now be updated via PATCH/{shopId}/products/{productId}.

• Added attributes priceQuantity, orderUnit, minOrder and intervalOrder to data types product and productSearch.
• Added attributes orderUnit, orderUnitShort, minOrder, priceQuantity, quantityPrice and intervalOrder to data type productLineItem.

2023-09-28

Changes with software release 7.88.0

New

For ePages Now only!

• Added data type bulkPriceInfo.

Update

• The attribute path /bulkPriceInfo can now be updated via PATCH/{shopId}/products/{productId}.

2023-08-31

Changes with software release 7.87.0

Update

• The following attribute paths can now be updated via PATCH/{shopId}/products/{productId}:
  - /isNew
  - /newnessDate
  - /video
  - /isVATInfoVisible
  - /isManufacturerPriceRRP
  - /referencePriceInfo
  - /isShippingLinkVisible
  - /customisationInfo
  - /title
  - /productDataSheet
  - /shippingMethodsRestrictedTo
  - /productCode
  

• Added attribute lowestRefPriceFormatted to data type priceInfo.
• Added attributes newnessDate, refAmount, refUnit, refContentAmount and productCode to data types product and productSearch.

2023-08-03

Changes with software release 7.86.0

Update

• Added attributes isInEU and countryCode2 to data type shopInfo.

2023-07-06

Changes with software release 7.85.0

New

For ePages Now only!

• PATCH/{shopId}/producttypes/{productTypeId}

Update

• Added replace operation for product types of PATCH/{shopId}/products/{productId}.

2023-06-08

Changes with software release 7.84.0

New

For ePages Now only!

• PATCH/{shopId}/products/{productId}/custom-attributes

2023-05-11

Changes with software release 7.83.0

New

For ePages Now only!

• POST/{shopId}/products/{productId}/variations

• Added data types variation (create request),variationAttribute (create request) and variationValue (create request).

2023-04-13

Changes with software release 7.82.0

New

For ePages Now only!

• POST/{shopId}/products/find
• GET/{shopId}/producttypes
• POST/{shopId}/producttypes

• GET/{shopId}/producttypes/{productTypeId}

• Added data type customerSpecificPriceInfo.
• Added data types attributeProductType, productType and productType (create request).

Update

• Added attribute isNew to data types product and productSearch.
• Added attribute customerSpecificPriceInfo to data type product.
• Added attribute productDataSheetSourceFile to data type productLineItem.

2023-03-16

Changes with software release 7.81.0

New

For ePages Now only!

• PUT/{shopId}/products/{productId}/crossselling
• PATCH/{shopId}/products/{productId}/crossselling

Update

• Added attributes isManufacturerPriceRRP and isShippingLinkVisible to data types product and productSearch.
• Added attribute visibleInNavigation to data types category and category (update request).
• Added replace functionality for stocklevel of PATCH/products/{productId}.

2023-02-16

Changes with software release 7.80.0

Update

• Added attributes isCustomizable, customizableTextLength and customizableHeadlineText to data types product and productSearch.

Deprecate

• The product attributes listPrice and manufacturerPrice for the events product:view, product:click, category:view, searchResults:view, and cart:add are deprecated and will be removed on May 11th, 2023. Please use the attributes strikePrice and isStrikePriceRRP instead.

2023-01-19

Changes with software release 7.79.0

Remove

• The deprecated events pageview, product, category, search, and cart were removed. Please use the respective alternatives page:view, product:view, category:view, searchResults:view, and cart:view instead.

2022-12-06

Changes with software release 7.77.0

New

• Added the events shippingMethod:select and paymentMethod:select to the Events section.

2022-08-11

Changes with software release 7.74.0

Update

• Added attribute isProductNumberVisible to data types product and productSearch.

2022-05-10

Changes with software release 7.70.0

Update

• Added attributes facetedSearchShowFacetsOnCategory and facetedSearchCategoryStartDepth to data type category.

2021-12-07

Changes with software release 7.66.0

Deprecate

• The events pageview, product, category, search, and cart of the Events section are deprecated and will be removed on 7th March 2022. Please use the respective alternatives page:view, product:view, category:view, searchResults:view, and cart:view instead.

2021-10-28

Changes with software release 7.65.0

New

• GET/{shopId}/countries

Update

• Added attributes deliveryThresholdIsActive and countryCode2 to data type taxModel.

2021-09-02

Changes with software release 7.63.0

New

• Added data type additionalInformation.
• Added data type priceSavings.
• Added the events product:click, wishlist:add, and search to the Events section.

Update

• Added attribute additionalInformation to data type productLineItem.
• Added attribute priceSavings to data type bulkPriceInfo.

2021-06-10

Changes with software release 7.60.0

New

• PUT/carts/{cartId}/payment-data
• Added data type cartValidation.

Update

• Added attribute cartValidation to data type cart.
• Renamed PUT/carts/{cartId}/shipping-data/shipping-method to PUT/carts/{cartId}/shipping-data.
• Added request attribute priceAmount to PUT/carts/{cartId}/shipping-data.

2021-05-14

Changes with software release 7.59.0

New

• PUT/carts/{cartId}/shipping-data/shipping-method
• Added data type potentialBasketDiscounts.

Update

• Added attribute potentialBasketDiscounts to data type cart.
• Added attribute basePrice to data type bulkPriceInfo.
• Added attribute price to data type shippingMethod.
• The attribute path /payment can now also be updated via PATCHorders/{orderId}.

2021-03-23

Changes with software release 7.56.0

New

• Added cart and cart:setQuantity events to the Events section.

Update

• Updated the product event in the Events section. It now also informs about the current state of the cart.
• Updated the cart:add event in the Events section. It now indicates the grand total of the cart and informs about the product that was added to the cart.

2020-04-17

Changes with software release 7.46.0

New

• Added data type additionalData.

Update

• Added attribute additionalData to data type paymentMethodInfo.

2020-01-23

Changes with software release 7.43.0

New

• PUTlegal/cookie-policy
• GETlegal/cookie-policy

Update

• Added attribute status to data type cart.
• Added attribute forceCreate to data type cart (create request).

2019-12-17

Changes with software release 7.42.0

New

• POST/carts/{cartId}/multi-line-items

Update

• Added attribute deliveryWeight to data type product (create request).

2019-11-06

Changes with software release 7.41.0

New

• PUTcarts/{cartId}/line-items/{lineItemId}/product-price

2019-10-04

Changes with software release 7.40.0

New

• Added data type bulkPriceInfo. For ePages Now only!

2019-07-31

Changes with software release 7.37.0

Update

• Added order:completed event to Events section.

• Added attribute highestPrice to data type priceInfo.

• Added attributes height, width, and fileSize to data type image.

• Updated the attribute scriptUrl of data type scriptTag by adding the possibility to register a ServiceWorker.

2019-05-27

Changes with software release 7.36.0

New

• POSTsearch/products

2019-04-25

Changes with software release 7.35.0

Update

• Added attribute isZoomEnabled to data type image.

• Added attributes productVariationMasterId and productVariationMasterName to data type product.

2019-02-21

Changes with software release 7.34.0

Update

• Added attribute displayName to data type variationIdentifier.

• Added attribute displayValue to data type variationIdentifier.

2019-02-06

Changes with software release 7.33.0

Update

• Added query parameter hasAddressData to GETcarts.

2019-01-15

Changes with software release 7.32.0

New

• GETcarts

Update

• Added attribute creationDate to data type cart.

• Added attribute documentPdf to data type orderDocument.

• Added query parameter includePdf to GETorders/{orderId}/documents.

• Added attribute issueDate to data type orderDocument.

2018-12-13

Changes with software release 7.30.0

New

• Added Events section. This section explains how applications can receive information about customer actions in ePages online shops.

Update

• Added attribute lowestPrice to data type priceInfo.
• Updated description of query parameter updatedFrom in GET orders.

2018-10-18

Changes with software release 7.29.0

New

• Added carts:add event.

2018-08-22

Changes with software release 7.28.0

Update

• Added attribute registerSessionUrl to data type cart.

2018-08-02

Changes with software release 7.27.0

Update

• Added attribute providerName to data type paymentMethodInfo.
• Added attribute transactionId to data type paymentData.

2018-07-25

Changes with software release 7.26.0

New

• Added pageview, product, and category events.

2018-04-27

Changes with software release 7.24.0

Update

• Added attribute videos to data type product.

2018-04-10

Changes with software release 7.23.0

Update

• Added attribute noTaxesMessage to data type taxModel.

2018-03-29

Changes with software release 7.22.0

New

• GETproducts/{productId}/crossselling

2018-02-07

Changes with software release 7.21.0

Update

• Added attribute energyLabelsMaxEfficiencyString to data type product.
• Added attributes energyLabelsString, energyLabelsMaxEfficiencyString and energyLabelSourceFile to productLineItem.

2017-12-11

Changes with software release 7.17.0

New

• GETorders/{orderId}/documents
• Added data type orderDocument.

2017-07-25

Changes with software release 7.12.0

Update

• Added attribute lineItemCouponDiscount to data type productLineItem.

2017-06-29

Changes with software release 7.11.0

Update

• Added attributes couponCampaignId and validationErrors to data type couponLineItem.
• Added attribute title to data type product.

2017-05-11

Changes with software release 7.8.0

• None.

2017-05-04

Changes with software release 7.7.0

• None.

2017-03-29

Changes with software release 7.6.0

New

• POST webhooks
• GET webhooks/{webhookId}
• POST webhooks/{webhookId}
• DELETE webhooks/{webhookId}

Update

• Added query parameter signature as a message authentification code for the app authorization process.

2017-03-10

Changes with software release 7.5.0

New

• GET script-tags
• POST script-tags
• DELETE script-tags/{scriptTagId}

Update

• Added attribute email to data type shopInfo.

2017-02-09

Changes with software release 7.4.0

Update

• Until version 7.3.0 the merchant could create a page type “Category” with an ID such as “Shipping” or “Payment”. This page was mapped with the GET legal/shipping-information and PUT legal/shipping-information requests. With version 7.4.0, a new page type “Payment & Shipping” has been introduced in the administration area of the ePages shop system that these legal calls have been mapped to. If the merchant did not create a new shipping information page via the new page type, the response to these calls will be empty.

• Introduced cart token X-epages-Cart-Token for all cart resources, see Response headers. The app scopes carts_readand carts_write have been deprecated at the same time.

2017-01-30

Changes with software release 7.3.0

New

• GET tax-model
• Added App Scopes to the Getting Started section.
• Added Custom apps section. This section explains how to create a custom app for a specific shop.

Update

• Developer apps have been renamed to Private apps. The chapter Create an app in the section Developing an app has been refactored and updated.

2016-12-21

Changes with software release 7.2.0

Update

• Added further attributes to data type address.
• Added attribute taxes to data types paymentData and shippingData.
• Added includeInvisible query parameter to GET categories and GET categories/{categoryId}.

2016-11-16

Changes with software release 7.1.0

Update

• Added visible attribute to data types category and category (create request).
• Added attributes deposits, ecoParticipations, shippingOptions and basketDiscount to data type lineItemContainer.

2016-10-25

Changes with software release 7.0.0

Update

• Added status attribute to data type paymentData.

2016-10-13

Changes with software release 6.17.53

• None.

2016-09-13

Changes with software release 6.17.52

Update

• Added response code 410 Gone.
• Required to set user agent in request header.
• Specified attributes stocklevel, depositPrice, and manufacturerPrice for POST products.
• Added attributes manufacturerProductNumber, minStocklevel, productLength, productHeight, productWidth productVariationType, and productVariationSelection to data type product.
• Added data type variationIdentifier.
• Removed products_write authorisation from stocklevel attribute.
• Added query parameter includeInvisible to GET products.
• Localized attribute name in productLineItems in GET orders/{orderId}.

Remove

• Removed attributes energyLabelsString and ecoParticipationPrice from POST products and PATCH products/{productId}.

2016-08-25

Changes with software release 6.17.51

New

• Implemented menu selection for software release version.

Update

• Added data type deliveryWeightQuantity.
• Updated data type quantity.
• Updated description of query parameter updatedFrom in GET orders.
• Updated description of PATCH orders/{orderId}.
• Added response code 409 Conflict.
• Updated description of customerNumber attribute of data type customer (create request).

Remove

• Removed slideshow link from GET products.
• Removed shippingMethodsRestrictedTo attribute from GET products.

2016-07-26

Changes with software release 6.17.50

• None.

2016-07-13

Changes with software release 6.17.49

New

• POST carts/{cartId}/coupon
• DELETE carts/{cartId}/coupon/{couponLineItemId}
• POST product-category-assignments
• DELETE product-category-assignments
• GET tax-classes
• GET tax-classes/{taxClassId}

Update

• Changed minCart attribute to minimumCart.
• Added taxClassId attribute to cart responses, where missing.
• Added deliveryWeight attribute to data type productLineItem.
• Added couponLineItem attribute to data type lineItemContainer.
• Renamed data type taxClass to taxClassInfo.
• Added data type taxClass.

2016-06-21

Changes with software release 6.17.48

New

• GET categories/{categoryId}/sequence
• PUT categories/{categoryId}/sequence
• POST categories/{categoryId}
• DELETE categories/{categoryId}

Update

• Changed minCartValue attribute to minCart and expanded its attributes.
• Added taxClassId attribute to data type taxClass.
• Added attributes partiallyDispatchedOn, partiallyPaidOn and partiallyInvoicedOn to data type order.

Remove

• GET products/{productId}/categories: This endpoint will no longer be supported. Please use GET categories by applying the query parameter productId.

2016-06-03

Changes with software release 6.17.47

Update

• Added stocklevel attribute to all product calls with data type product.
• Added shippingMethod link to all carts calls that include the shippingData attribute.
• Added taxClass attribute to data type product.
• Added visible attribute to data type product.

2016-05-23

Changes with software release 6.17.46

New

• POST categories/{categoryId}

Update

• Added deliveryPeriod attribute to GET products, GET products/{productId}, GET products/updated/{productProperty}, PATCH products/{productId} and POST products.

2016-04-27

Changes with software release 6.17.45

Update

• Added createdAfter and createdBefore attributes to GET sales.

2016-04-20

Changes with software release 6.17.44

New

• GET newsletter-campaigns
• GET newsletter-campaigns/{campaignId}subscribers

2016-04-11

Changes with software release 6.17.43

New

• POST products
• GET watched-products
• GET customers
• POST carts/{cartId}/order

Update

• Added taxClass attribute to GET products/{productId}.
• Added stocklevel attribute to GET products/{productId} and PATCH products/{productId} for requests with products_write scope.

Remove

• PUT orders/{orderId}: This endpoint will no longer be supported. Please use PATCH orders/{orderId}.
• GET products/{productId}/stock-level: This endpoint will no longer be supported. Please use GET products/{productId}.
• PUT products/{productId}/stock-level: This endpoint will no longer be supported. Please use PATCH products/{productId}.

2016-03-07

Changes with software release 6.17.42

New

• POST customers
• GET customers/{customerId}
• PATCH customers/{customerId}
• PATCH orders/{orderId}

Update

• Added main-category link to GET products/{productId}.

2016-02-25

Changes with software release 6.17.41

New

• GET products/updated/{productProperty}

Update

• Renamed attribute cancelledOn to rejectedOn as well as attribute shippedOn to deliveredOn within orders calls.
• Added attribute customerNumber to GET orders and GET orders/{orderId}.

2016-02-18

Changes with software release 6.17.40

• None.

2016-02-09

Changes with software release 6.17.39

New

• GET {shopId}
• PATCH products/{productId}
• POST products/{productId}/slideshow
• GET products/{productId}/slideshow/sequence
• DELETE products/{productId}/slideshow/{imageName}
• PUT products/{productId}/slideshow/sequence

Update

• Added productImage attribute.
• Added new attributes shippingData and paymentData to orders.
• Replaced attribute comment with customerComment and internalNote.

2016-01-21

Changes with software release 6.17.38

New

• GET sales

2016-01-19

Changes with software release 6.17.37

Update

• Added date range filters createdBefore and createdAfter to query parameters of GET orders.