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-07-11
Changes with software release 7.96.0
Update
- Added attribute
isInWishlist
to data typesproduct
,productLineItem
andproductSearch
.
2024-03-21
Changes with software release 7.93.0
Update
-
The attribute path
/orderUnitsInfo
can now be updated viaPATCH
/{shopId}/products/{productId}. - Added attributes
priceQuantity
,orderUnit
,minOrder
andintervalOrder
to data typesproduct
andproductSearch
. - Added attributes
orderUnit
,orderUnitShort
,minOrder
,priceQuantity
,quantityPrice
andintervalOrder
to data typeproductLineItem
.
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 viaPATCH
/{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 typepriceInfo
. - Added attributes
newnessDate
,refAmount
,refUnit
,refContentAmount
andproductCode
to data typesproduct
andproductSearch
.
2023-08-03
Changes with software release 7.86.0
Update
- Added attributes
isInEU
andcountryCode2
to data typeshopInfo
.
2023-07-06
Changes with software release 7.85.0
New
For ePages Now only!
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!
2023-05-11
Changes with software release 7.83.0
New
For ePages Now only!
-
Added data types
variation (create request)
,variationAttribute (create request)
andvariationValue (create request)
.
2023-04-13
Changes with software release 7.82.0
New
For ePages Now only!
POST
/{shopId}/products/findGET
/{shopId}/producttypesPOST
/{shopId}/producttypes- Added data type
customerSpecificPriceInfo
. - Added data types
attributeProductType
,productType
andproductType (create request)
.
Update
- Added attribute
isNew
to data typesproduct
andproductSearch
. - Added attribute
customerSpecificPriceInfo
to data typeproduct
. - Added attribute
productDataSheetSourceFile
to data typeproductLineItem
.
2023-03-16
Changes with software release 7.81.0
New
For ePages Now only!
Update
- Added attributes
isManufacturerPriceRRP
andisShippingLinkVisible
to data typesproduct
andproductSearch
. - Added attribute
visibleInNavigation
to data typescategory
andcategory (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
andcustomizableHeadlineText
to data typesproduct
andproductSearch
.
Deprecate
- The product attributes
listPrice
andmanufacturerPrice
for the eventsproduct:view
,product:click
,category:view
,searchResults:view
, andcart:add
are deprecated and will be removed on May 11th, 2023. Please use the attributesstrikePrice
andisStrikePriceRRP
instead.
2023-01-19
Changes with software release 7.79.0
Remove
- The deprecated events
pageview
,product
,category
,search
, andcart
were removed. Please use the respective alternativespage:view
,product:view
,category:view
,searchResults:view
, andcart:view
instead.
2022-12-06
Changes with software release 7.77.0
New
- Added the events
shippingMethod:select
andpaymentMethod:select
to the Events section.
2022-08-11
Changes with software release 7.74.0
Update
- Added attribute
isProductNumberVisible
to data typesproduct
andproductSearch
.
2022-05-10
Changes with software release 7.70.0
Update
- Added attributes
facetedSearchShowFacetsOnCategory
andfacetedSearchCategoryStartDepth
to data typecategory
.
2021-12-07
Changes with software release 7.66.0
Deprecate
- The events
pageview
,product
,category
,search
, andcart
of the Events section are deprecated and will be removed on 7th March 2022. Please use the respective alternativespage:view
,product:view
,category:view
,searchResults:view
, andcart:view
instead.
2021-10-28
Changes with software release 7.65.0
New
Update
- Added attributes
deliveryThresholdIsActive
andcountryCode2
to data typetaxModel
.
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
, andsearch
to the Events section.
Update
- Added attribute
additionalInformation
to data typeproductLineItem
. - Added attribute
priceSavings
to data typebulkPriceInfo
.
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 typecart
. - Renamed
PUT
/carts/{cartId}/shipping-data/shipping-method toPUT
/carts/{cartId}/shipping-data. - Added request attribute
priceAmount
toPUT
/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 typecart
. - Added attribute
basePrice
to data typebulkPriceInfo
. - Added attribute
price
to data typeshippingMethod
. - The attribute path
/payment
can now also be updated viaPATCH
orders/{orderId}.
2021-03-23
Changes with software release 7.56.0
New
- Added
cart
andcart: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 typepaymentMethodInfo
.
2020-01-23
Changes with software release 7.43.0
New
Update
- Added attribute
status
to data typecart
. - Added attribute
forceCreate
to data typecart (create request)
.
2019-12-17
Changes with software release 7.42.0
New
Update
- Added attribute
deliveryWeight
to data typeproduct (create request)
.
2019-11-06
Changes with software release 7.41.0
New
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 typepriceInfo
. -
Added attributes
height
,width
, andfileSize
to data typeimage
. -
Updated the attribute
scriptUrl
of data typescriptTag
by adding the possibility to register aServiceWorker
.
2019-05-27
Changes with software release 7.36.0
New
2019-04-25
Changes with software release 7.35.0
Update
-
Added attribute
isZoomEnabled
to data typeimage
. -
Added attributes
productVariationMasterId
andproductVariationMasterName
to data typeproduct
.
2019-02-21
Changes with software release 7.34.0
Update
-
Added attribute
displayName
to data typevariationIdentifier
. -
Added attribute
displayValue
to data typevariationIdentifier
.
2019-02-06
Changes with software release 7.33.0
Update
- Added query parameter
hasAddressData
toGET
carts.
2019-01-15
Changes with software release 7.32.0
New
Update
-
Added attribute
creationDate
to data typecart
. -
Added attribute
documentPdf
to data typeorderDocument
. -
Added query parameter
includePdf
toGET
orders/{orderId}/documents. -
Added attribute
issueDate
to data typeorderDocument
.
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 typepriceInfo
. - Updated description of query parameter
updatedFrom
inGET
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 typecart
.
2018-08-02
Changes with software release 7.27.0
Update
- Added attribute
providerName
to data typepaymentMethodInfo
. - Added attribute
transactionId
to data typepaymentData
.
2018-07-25
Changes with software release 7.26.0
New
- Added
pageview
,product
, andcategory
events.
2018-04-27
Changes with software release 7.24.0
Update
- Added attribute
videos
to data typeproduct
.
2018-04-10
Changes with software release 7.23.0
Update
- Added attribute
noTaxesMessage
to data typetaxModel
.
2018-03-29
Changes with software release 7.22.0
New
2018-02-07
Changes with software release 7.21.0
Update
- Added attribute
energyLabelsMaxEfficiencyString
to data typeproduct
. - Added attributes
energyLabelsString
,energyLabelsMaxEfficiencyString
andenergyLabelSourceFile
toproductLineItem
.
2017-12-11
Changes with software release 7.17.0
New
GET
orders/{orderId}/documents- Added data type
orderDocument
.
2017-07-25
Changes with software release 7.12.0
Update
- Added attribute
lineItemCouponDiscount
to data typeproductLineItem
.
2017-06-29
Changes with software release 7.11.0
Update
- Added attributes
couponCampaignId
andvalidationErrors
to data typecouponLineItem
. - Added attribute
title
to data typeproduct
.
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
Update
- Added attribute
email
to data typeshopInfo
.
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 andPUT
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 scopescarts_read
andcarts_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 typespaymentData
andshippingData
. - Added
includeInvisible
query parameter toGET
categories andGET
categories/{categoryId}.
2016-11-16
Changes with software release 7.1.0
Update
- Added
visible
attribute to data typescategory
andcategory (create request)
. - Added attributes
deposits
,ecoParticipations
,shippingOptions
andbasketDiscount
to data typelineItemContainer
.
2016-10-25
Changes with software release 7.0.0
Update
- Added
status
attribute to data typepaymentData
.
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
, andmanufacturerPrice
forPOST
products. - Added attributes
manufacturerProductNumber
,minStocklevel
,productLength
,productHeight
,productWidth
productVariationType
, andproductVariationSelection
to data typeproduct
. - Added data type
variationIdentifier
. - Removed
products_write
authorisation fromstocklevel
attribute. - Added query parameter
includeInvisible
toGET
products. - Localized attribute
name
inproductLineItems
inGET
orders/{orderId}.
Remove
- Removed attributes
energyLabelsString
andecoParticipationPrice
fromPOST
products andPATCH
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
inGET
orders. - Updated description of
PATCH
orders/{orderId}. - Added response code 409 Conflict.
- Updated description of
customerNumber
attribute of data typecustomer (create request)
.
Remove
- Removed slideshow link from
GET
products. - Removed
shippingMethodsRestrictedTo
attribute fromGET
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}/couponDELETE
carts/{cartId}/coupon/{couponLineItemId}POST
product-category-assignmentsDELETE
product-category-assignmentsGET
tax-classesGET
tax-classes/{taxClassId}
Update
- Changed
minCart
attribute tominimumCart
. - Added
taxClassId
attribute to cart responses, where missing. - Added
deliveryWeight
attribute to data typeproductLineItem
. - Added
couponLineItem
attribute to data typelineItemContainer
. - Renamed data type
taxClass
totaxClassInfo
. - Added data type
taxClass
.
2016-06-21
Changes with software release 6.17.48
New
GET
categories/{categoryId}/sequencePUT
categories/{categoryId}/sequencePOST
categories/{categoryId}DELETE
categories/{categoryId}
Update
- Changed
minCartValue
attribute tominCart
and expanded its attributes. - Added
taxClassId
attribute to data typetaxClass
. - Added attributes
partiallyDispatchedOn
,partiallyPaidOn
andpartiallyInvoicedOn
to data typeorder
.
Remove
-
GET
products/{productId}/categories: This endpoint will no longer be supported. Please useGET
categories by applying the query parameterproductId
.
2016-06-03
Changes with software release 6.17.47
Update
- Added
stocklevel
attribute to all product calls with data typeproduct
. - Added
shippingMethod
link to all carts calls that include theshippingData
attribute. - Added
taxClass
attribute to data typeproduct
. - Added
visible
attribute to data typeproduct
.
2016-05-23
Changes with software release 6.17.46
New
Update
- Added
deliveryPeriod
attribute toGET
products,GET
products/{productId},GET
products/updated/{productProperty},PATCH
products/{productId} andPOST
products.
2016-04-27
Changes with software release 6.17.45
Update
- Added
createdAfter
andcreatedBefore
attributes toGET
sales.
2016-04-20
Changes with software release 6.17.44
New
2016-04-11
Changes with software release 6.17.43
New
Update
- Added
taxClass
attribute toGET
products/{productId}. - Added
stocklevel
attribute toGET
products/{productId} andPATCH
products/{productId} for requests with products_write scope.
Remove
-
PUT
orders/{orderId}: This endpoint will no longer be supported. Please usePATCH
orders/{orderId}. -
GET
products/{productId}/stock-level: This endpoint will no longer be supported. Please useGET
products/{productId}. -
PUT
products/{productId}/stock-level: This endpoint will no longer be supported. Please usePATCH
products/{productId}.
2016-03-07
Changes with software release 6.17.42
New
Update
- Added
main-category
link toGET
products/{productId}.
2016-02-25
Changes with software release 6.17.41
New
Update
- Renamed attribute
cancelledOn
torejectedOn
as well as attributeshippedOn
todeliveredOn
within orders calls. - Added attribute
customerNumber
toGET
orders andGET
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}/slideshowGET
products/{productId}/slideshow/sequenceDELETE
products/{productId}/slideshow/{imageName}PUT
products/{productId}/slideshow/sequence
Update
- Added
productImage
attribute. - Added new attributes
shippingData
andpaymentData
to orders. - Replaced attribute
comment
withcustomerComment
andinternalNote
.
2016-01-21
Changes with software release 6.17.38
New
2016-01-19
Changes with software release 6.17.37
Update
- Added date range filters
createdBefore
andcreatedAfter
to query parameters ofGET
orders.