Added new APIs and integrations to support displaying and applying promotions and coupon defined in Commerce Engine:

• Promotions:
  • Retrieve promotions applied to items.
  • Retrieve promotions applied to cart line items.
  • Retrieve promotions applied to cart totals.
  • Retrieve promotions applied to shipping options.
  • Retrieve promotions applied by coupons.
  • Retrieve promotions applied purchases.
• Discounts:
• • Retrieve discount generated by cart subtotal promotions.
  • Retrieve discount generated by cart promotions for a purchase.
• Coupons:
• • Apply coupons to order.
  • Remove coupons from order.
  • Retrieve coupons applied to order.
  • Retrieve coupons applied to purchase.

Added Cortex framework support for personalization of prices, promotions and slots in clients:

• Added new http header: x-ep-user-traits to transport of user traits from client application for personalization purposes.
• User traits are automatically inferred from Commerce Engine data available about the shopper.
• Added extension points for defining custom inferred traits.
• Out of the box, Prices, Promotions and Slots resources can be personalized with user traits.

Added new API integrations to support displaying recommendations sourced from Commerce Engine:

• Retrieve item cross-sell recommendations.
• Retrieve item up-sell recommendations.
• Retrieve item accessory recommendations.
• Retrieve item warranty recommendations.
• Retrieve item replacement recommendations.
• Retrieve item topseller recommendations.

Added new API integration to support storing payment tokens with an order or a shopper's account:

• Add payment token to profile for repeated use
• Remove token from profile.
• Add payment token to order for one time use.
• Remove token from order.

Added new APIs and integrations to support displaying shipping information about a purchase:

• Retrieve shipments for a purchase

• APIs can now be defined in XML and used to generate source code.
• Simpler Programming Model
  • Read From Other is now an annotation
  • Linking handled in Cortex framework
  • Max-age creation in Cortex framework
  • Self object creation handled in Framework
  • Type field auto-generated type generated from entity-type in definitions

We changed the link types away from the application/vnd.elasticpath.* style because it looked too much like an internet media type, which was not what we were trying to convey. The "type" field on a link explains the expected format or entity that you may expect to see at the other end of the link, not the internet media type.

When upgrading, search for the strings listed under the "Old Link Type" column, and convert them to the value in the "New Link Type" column. In particular, pay attention to the Spring configuration where the link type strings are used. Consider the following change in the file applicationContext-availabilities-resource.xml:

<bean name="readAvailabilitiesStrategies" class="java.util.HashMap">
     <constructor-arg>
       <map key-type="java.lang.String" value-type="com.elasticpath.rest.command.read.ReadFromOtherCommandStrategy">
-        <entry key="application/vnd.elasticpath.item" value-ref="readItemStrategy"/commerce-legacy/>
-        <entry key="application/vnd.elasticpath.cart.lineitem" value-ref="readCartLineItemStrategy"/commerce-legacy/>
+        <entry key="elasticpath.items.item" value-ref="readItemStrategy"/commerce-legacy/>
+        <entry key="elasticpath.carts.line-item" value-ref="readCartLineItemStrategy"/commerce-legacy/>
       </map>
     </constructor-arg>
</bean>

Similar changes were made to use the "New Link Type" values in many of the blueprint xml files. For example:

• ep-resource-availabilities.jar:/OSGI-INF/blueprint/applicationContext-availabilities-resource.xml

• ep-resource-paymentmethods.jar:/OSGI-INF/blueprint/applicationContext-paymentmethods-resource.xml

• ep-resource-prices.jar:/OSGI-INF/blueprint/applicationContext-prices-resource.xml

Cortex now requires a page size to set the pagination for recommendations. Since a large number of recommended items may be available, the page size will limit the number of items retrieved per request.

To set the recommendations page size:

1. In your C:/etc/ep/cortex/system/config directory, create a file named recommendationsPageSize.config.
2. In recommendationsPageSize.config, add the following field and define your page size value:

rest.recommendations.page.size.VALUE=I"<positive integer>"

Example with 5 items per page:

rest.recommendations.page.size.VALUE=I"5"

TypeBuilderFactory is no longer recommended for use with entities. It will be removed in the future. Use the entity builders instead.

Before:

ItemEntity encodedItemEntity = TypeBuilderFactory.builder(ItemEntity.Builder.class)
											 .withItemId(encodedItemId)
											 .build();

After:

ItemEntity encodedItemEntity = ItemEntity.Builder.builder()
											 .withItemId(encodedItemId)
											 .build();

The LookupStrategy interface has been split into 3. There is now a dedicated interface each for both item promotions and navigation promotions

The OnFailure result builder interface has changed slightly. This is not an API breaking change, but we have simplified creating error messages a little bit.

The builder methods now accept formatting args as a parameter so that you can write String.format() style messages inline.

Old: public static FailedResultBuilder returnBadURI(final String message) New: public static FailedResultBuilder returnBadURI(final String message, final Object... formatArgs)

eg. You should prefer the new style to the old, although both will work.

Old style: OnFailure.returnBadURI(String.format("My happy message with type %s and name %s", type, name)); New style: OnFailure.returnBadURI("My happy message with type %s and name %s", type, name));

Why: Due to recent changes in our maven pom structure (introduction of the webapp parent pom in particular), we were limiting extension cases without making this change, so it's happening now.

What: These parameters describe the maven coordinates of the ce wrapper in much the same way that we locate resource configuration, which arguably should always have been there.

Now when you generate the cortex webapp, you will be asked for 3 sets of information:

1. Cortex Webapp coordiates:

   Define value for property 'groupId': : com.mycompany
   Define value for property 'artifactId': : cortex-webapp
   Define value for property 'version':  1.0-SNAPSHOT: : 
   Define value for property 'package':  com.mycompany: :

2. Cortex CE Wrapper coordinates (**new**)

   Define value for property 'ep-commerce-engine-wrapper-artifact-id': : ext-ce-wrapper
   Define value for property 'ep-commerce-engine-wrapper-group-id': : com.mycompany
   Define value for property 'ep-commerce-engine-wrapper-version': : 1.0-SNAPSHOT

3. Cortex WebApp Resource Configuration

   Define value for property 'resource-configuration-artifact-id': : ext-resource-configuration
   Define value for property 'resource-configuration-group-id': : com.mycompany
   Define value for property 'resource-configuration-version': : 1.0-SNAPSHOT

The happy little characters in the middle there are the new ones for the ce wrapper.

• @ResourceUri has been renamed to @AnyResourceUri
• @SingleResourceUri has been created as a more targeted alternative

To upgrade, it is safe to rename every usage of @ResourceUri to @AnyResourceUri

This name change is to better signify what the annotation actually matches. @AnyResourceUri is a greedy annotation that will match any resource URI. The new annotation @SingleResourceUri has been created to target only a single resource URI.

@SingleResourceUri should be used in all cases where a single resource uri is to be matched. This annotation is useful for matching the child resource uri in below cases:

• /parent/child/childId/parentId

  @Path({@ResourceName.PATH_PART, @SingleResourceUri .PATH_PART, @ResourceId.PATH_PART})

• /parent/child/childId

  @Path({@ResourceName.PATH_PART, @SingleResourceUri .PATH_PART})

@AnyResourceUri is useful for matching both the child and grandchild resource uris in below case:

• /parent/parentId/child/childId/grandchild/grandchildId

  @Path({@ResourceName.PATH_PART, @ResourceId.PATH_PART, @AnyResourceUri .PATH_PART})

As part of this release, several entities have been replaced by versions generated from the definitions schema. These may have changed name, or been relocated to a different package or bundle.

The factory used to construct these new Entities is also different to the old Entity format. For example:

PriceEntity priceEntity = ResourceTypeFactory.createResourceEntity(PriceEntity.class)
                                             .setPurchasePrice(Collections.singletonList(purchaseCostEntity));

ItemPriceEntity result = TypeBuilderFactory.builder(ItemPriceEntity.Builder.class)
                                           .addingPurchasePrice(purchaseCostEntity)
                                           .build();

The redirect response code has changed from 303 SEE OTHER to 307 TEMPORARY REDIRECT. This change was made to better align the response code with the intended use in the HTTP specification. In Browser based applications, the browser will treat this response code the same as 303 SEE OTHER.

This affects the following calls:

• GET /carts/{scope}/default
• GET /profiles/{scope}/default

Calling POST to select billing info of a user for a non-existent order returns an error code.

/orders/<scope>/<invalid_order_id>/billingaddressinfo/selector/<default_billing_addr_uri>

Before: 403

After: 404

Due to the wild-carding changes above, the rest-resources dependencies no longer need to be specified in addition to the epcommerce dependency. Only the ep-commerce dependency is required.

An example using carts, both dependencies were previously required:

<dependency>
	<groupId>com.elasticpath.rest.resource</groupId>
	<artifactId>ep-resource-carts</artifactId>
	<scope>provided</scope>
</dependency>
<dependency>
	<groupId>com.elasticpath.rest.integration.epcommerce</groupId>
	<artifactId>ep-resource-carts-epcommerce</artifactId>
	<scope>provided</scope>
</dependency>

Now only the epcommerce dependency for carts:

<dependency>
	<groupId>com.elasticpath.rest.integration.epcommerce</groupId>
	<artifactId>ep-resource-carts-epcommerce</artifactId>
	<scope>provided</scope>
</dependency>

This may impact your customisations if you have overridden any of the dependency plugin execution groups to customise your Cortex webapp.

<ep-commerce-engine-wrapper-group-id>com.elasticpath.rest.integration.epcommerce</ep-commerce-engine-wrapper-group-id>
<ep-commerce-engine-wrapper-artifact-id>ep-commerce-engine-wrapper</ep-commerce-engine-wrapper-artifact-id>
<ep-commerce-engine-wrapper-version>1.10.100.20140827092242</ep-commerce-engine-wrapper-version>

New in this release, Cortex makes use of JMS messaging to communicate some business events to other EP applications as well as to other subscribed integration systems.

To facilitate this messaging there are some changes to the Cortex WebApp infrastructure as described here: Updated Deployment Guide

Pay particular attention to the changes to Tomcat context.xml (note the addition of a JMSConnectionFactory configuration) and the new Tomcat container library dependencies (for connection pooling) that we use in the Tomcat Maven Plugin and Cargo Maven Plugin.

The following artifacts:

<artifactItem>
	<groupId>com.elasticpath.rest.relos</groupId>
	<artifactId>ep-relos-resource-management</artifactId>
	</artifactItem>
<artifactItem>
	<groupId>com.elasticpath.rest.relos</groupId>
	<artifactId>ep-relos-resource-management-index-by-name-strategy</artifactId>
</artifactItem>
...
...

Are now replaced with wildcards:

<includeGroupIds>
	com.elasticpath.rest,
	com.sun.jersey,
	com.fasterxml.jackson
</includeGroupIds>

Execution groups before:

copy-relos-OSGi-bundles
copy-event-OSGi-bundles
copy-integration-commons-OSGi-bundles
copy-resource-server-commons-OSGi-bundles
copy-carts-resource-and-integration-OSGi-bundles
copy-item-resource-and-integration-OSGi-bundles
copy-prices-resource-and-integration-OSGi-bundles
copy-navigations-resource-and-integration-OSGi-bundles
copy-registrations-resource-and-integration-OSGi-bundles
copy-slots-resource-and-integration-OSGi-bundles
copy-assets-resource-and-integration-OSGi-bundles
copy-availabilities-resource-and-integration-OSGi-bundles
copy-orders-resource-and-integration-OSGi-bundles
copy-paymentmethods-resource-and-integration-OSGi-bundles
copy-paymenttokens-resource-and-integration-OSGi-bundles
copy-profiles-resource-and-integration-OSGi-bundles
copy-purchases-resource-and-integration-OSGi-bundles
copy-shipmentdetails-resource-and-integration-OSGi-bundles
copy-taxes-resource-and-integration-OSGi-bundles
copy-totals-resource-and-integration-OSGi-bundles
copy-searches-resource-and-integration-OSGi-bundles
copy-creditcards-resource-and-integration-OSGi-bundles
copy-emails-resource-and-integration-OSGi-bundles
copy-geographies-resource-and-integration-OSGi-bundles
copy-commerce-engine-OSGi-bundles
copy-shared-libs-OSGi-bundles
copy-logging-OSGi-bundles
copy-transitive-resource-dependencies-OSGi-bundles
copy-spring-OSGi-bundles
copy-gemini-blueprint-OSGi-bundles
copy-jersey-OSGi-bundles
copy-apache-http-OSGi-bundles
copy-apache-camel-bundles
copy-jackson-OSGi-bundles
copy-felix-OSGi-bundles
copy-osgi-webconsole-OSGi-bundles

Execution groups after:

copy-cortex-OSGi-bundles
copy-resource-configuration-OSGi-bundles
copy-commerce-engine-OSGi-bundles
copy-dependant-OSGi-bundles
copy-logging-OSGi-bundles
copy-blueprint-osgi-bundles
copy-osgi-base-OSGi-bundles
copy-osgi-webconsole-OSGi-bundles

We have added some new parameters to the cortex ce webapp archetype.

Why: Due to recent changes in our maven pom structure (introduction of the webapp parent pom in particular), we were limiting extension cases without making this change, so it's happening now.

What: These parameters describe the maven coordinates of the ce wrapper in much the same way that we locate resource configuration, which arguably should always have been there.

Now when you generate the cortex webapp, you will be asked for 3 sets of information:

1. Cortex Webapp coordiates:

   Define value for property 'groupId': : com.mycompany
   Define value for property 'artifactId': : cortex-webapp
   Define value for property 'version':  1.0-SNAPSHOT: : 
   Define value for property 'package':  com.mycompany: :

2. Cortex CE Wrapper coordinates (**new**)

   Define value for property 'ep-commerce-engine-wrapper-artifact-id': : ext-ce-wrapper
   Define value for property 'ep-commerce-engine-wrapper-group-id': : com.mycompany
   Define value for property 'ep-commerce-engine-wrapper-version': : 1.0-SNAPSHOT

3. Cortex WebApp Resource Configuration

   Define value for property 'resource-configuration-artifact-id': : ext-resource-configuration
   Define value for property 'resource-configuration-group-id': : com.mycompany
   Define value for property 'resource-configuration-version': : 1.0-SNAPSHOT

The happy little characters in the middle there are the new ones for the ce wrapper.