Announcement: You can find the guides for Commerce 7.5 and later on the new Elastic Path Documentation site. This Developer Center contains the guides for Commerce 6.13.0 through 7.4.1.Visit new site

This version of Elastic Path Commerce is no longer supported or maintained. To upgrade to the latest version, contact your Elastic Path representative.

Touchpoint Developer Home

The Touchpoint Development site teaches Cortex API Client developers how to code Cortex client applications. Here you can learn the fundamentals of Cortex request objects, response headers, request methods, and much more. We recommend using the site's embedded Cortex Studio along with the Resource Reference Guide to play with an out-of-the-box Cortex installation and see firsthand what the API is capable of.

Elastic Path Developers Portal

Getting Started

Introduction

Introduces Cortex, a hypermedia REST API for e-commerce.

Learning To Use Cortex

Basic steps to make your first Cortex API request.

Learning To Use Cortex Studio

Overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

Learning To Use Cortex Java SDK

Overview of Cortex Java SDK, how to set it up with your OSGi project, and sample code for constructing URIs and marshalling Cortex responses.

API Basics

Resources

An overview of Cortex resources, their purpose and formats.

Request Methods

Lists HTTP request methods supported by Cortex.

Request Entry Points

Lists and defines Cortex entry points.

JSON Format

A breakdown of Plain JSON and HAL representation

URI Standards

A breakdown of a Cortex URI, as well as descriptions of scope and default.

Links

A breakdown of a Cortex hypermedia links JSON array.

Zoom

An overview of Zoom, a Cortex technology that allows you retrieve multiple resource representations with a single request.

Hypermedia Controls

Introduction

An overview of Cortex hypermedia controls, which are ways to manipulate Cortex add items to cart, checkout, update customer profiles, and so on.

Lists

An overview of the lists hypermedia control, which is an ordered list of links to other resources.

Forms

An overview of the forms hypermedia control, which creates new resources in Cortex.

Selectors

An overview of the selector hypermedia control, which can change a resource's state.

NeedInfo

Describes the needinfo hypermedia control, which prevents a resource from changing its state until a set of conditions are satisfied.

Structured Messages

Describes the structured messages hypermedia control, a feature which passes useful information to your users.

API Reference

Headers

Lists the standard HTTP request headers that Cortex supports.

Query Parameters

Lists the custom query parameters that Cortex supports.

Response Status Codes

Lists some standard response status codes returned by Cortex.

FollowLocation

An overview of FollowLocation and some examples.

Proxy Configuration

How to set up a proxy server to handle reqeusts between Cortex and a client application. This gets around a Web Browsers' Same Origin Policy.

Parsing Responses

How to use JSONPath to extract data from Cortex JSON responses.

NeedInfo Messages

Lists structured messages of type NeedInfo returned by Cortex.

Field Validation Errors

Lists structured messages generated by field validation errors returned by Cortex.

Business State Errors

Lists structured messages generated by business state errors returned by Cortex.

Security Roles

Describes the Cortex security roles that are provided out of the box.

Personalization

An overview of Cortex personalization, which offers different pricing, promotions, or content based on a shopper's attributes.

Pricing and Promotion

An overview of the pricing and promotions resources and how they affect related resources.

Advisors

Lists advisors provided by Elastic Path and their purpose.

Tutorials

Authenticate a Customer

How to validate a registered user's credentials to receive an access token.

Generate a Public OAuth Token

How to request a public access token for an anonymous shopper.

Search for Items

How to search for items in a store.

Add an Item to a Cart

How to add an item to a customer's cart.

Remove Cart Item

How to remove an item from a customer's cart.

Select Item Options

How to select an item option for an item.

Purchasing: From Start to Finish

Overview of the base calls required to log a customer in, add an item to a cart, and then complete the cart's purchase.

Merging Public Carts

How to merge a public cart with a registered user's cart.

Viewing Consent of a Customer for a Data Policy

How to view customer consent for a data policy.

Changing Customer Consent for a Data Policy

How to change customer consent for a data policy.

Articles

Developer Tips

Tips, tricks, and tools a Cortex application developer should use when developing a client application.

Items Explained

Detailed explanation of items, item definitions, and item components.

Reference

Resource Reference Guide

Describes the Cortex resources, their workflows and response fields.

Resource Relationship Map

Provides the resource relationship map, which is a visual map of Cortex resources and their relationships.

Getting Started

Introduction

Introduces Cortex, a hypermedia REST API for e-commerce.

Learning To Use Cortex

Basic steps to make your first Cortex API request.

Learning To Use Cortex Studio

Overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

Learning To Use Cortex Java SDK

Overview of Cortex Java SDK, how to set it up with your OSGi project, and sample code for constructing URIs and marshalling Cortex responses.

API Basics

Resources

An overview of Cortex resources, their purpose and formats.

Request Methods

Lists HTTP request methods supported by Cortex.

Request Entry Points

Lists and defines Cortex entry points.

JSON Format

A breakdown of Plain JSON and HAL representation

URI Standards

A breakdown of a Cortex URI, as well as descriptions of scope and default.

Links

A breakdown of a Cortex hypermedia links JSON array.

Zoom

An overview of Zoom, a Cortex technology that allows you retrieve multiple resource representations with a single request.

Hypermedia Controls

Introduction

An overview of Cortex hypermedia controls, which are ways to manipulate Cortex add items to cart, checkout, update customer profiles, and so on.

Lists

An overview of the lists hypermedia control, which is an ordered list of links to other resources.

Forms

An overview of the forms hypermedia control, which creates new resources in Cortex.

Selectors

An overview of the selector hypermedia control, which can change a resource's state.

NeedInfo

Describes the needinfo hypermedia control, which prevents a resource from changing its state until a set of conditions are satisfied.

Structured Messages

Describes the structured messages hypermedia control, a feature which passes useful information to your users.

API Reference

Headers

Lists the standard HTTP request headers that Cortex supports.

Query Parameters

Lists the custom query parameters that Cortex supports.

Response Status Codes

Lists some standard response status codes returned by Cortex.

FollowLocation

An overview of FollowLocation and some examples.

Proxy Configuration

How to set up a proxy server to handle reqeusts between Cortex and a client application. This gets around a Web Browsers' Same Origin Policy.

Parsing Responses

How to use JSONPath to extract data from Cortex JSON responses.

NeedInfo Messages

Lists structured messages of type NeedInfo returned by Cortex.

Field Validation Errors

Lists structured messages generated by field validation errors returned by Cortex.

Business State Errors

Lists structured messages generated by business state errors returned by Cortex.

Security Roles

Describes the Cortex security roles that are provided out of the box.

Personalization

An overview of Cortex personalization, which offers different pricing, promotions, or content based on a shopper's attributes.

Pricing and Promotion

An overview of the pricing and promotions resources and how they affect related resources.

Advisors

Lists advisors provided by Elastic Path and their purpose.

Tutorials

Authenticate a Customer

How to validate a registered user's credentials to receive an access token.

Generate a Public OAuth Token

How to request a public access token for an anonymous shopper.

Search for Items

How to search for items in a store.

Add an Item to a Cart

How to add an item to a customer's cart.

Remove Cart Item

How to remove an item from a customer's cart.

Select Item Options

How to select an item option for an item.

Purchasing: From Start to Finish

Overview of the base calls required to log a customer in, add an item to a cart, and then complete the cart's purchase.

Merging Public Carts

How to merge a public cart with a registered user's cart.

Viewing Consent of a Customer for a Data Policy

How to view customer consent for a data policy.

Changing Customer Consent for a Data Policy

How to change customer consent for a data policy.

Articles

Developer Tips

Tips, tricks, and tools a Cortex application developer should use when developing a client application.

Items Explained

Detailed explanation of items, item definitions, and item components.

Reference

Resource Reference Guide

Describes the Cortex resources, their workflows and response fields.

Resource Relationship Map

Provides the resource relationship map, which is a visual map of Cortex resources and their relationships.

Getting Started

Introduction

Introduces Cortex, a hypermedia REST API for e-commerce.

Learning To Use Cortex

Basic steps to make your first Cortex API request.

Learning To Use Cortex Studio

Overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

Learning To Use Cortex Java SDK

Overview of Cortex Java SDK, how to set it up with your OSGi project, and sample code for constructing URIs and marshalling Cortex responses.

API Basics

Resources

An overview of Cortex resources, their purpose and formats.

Request Methods

Lists HTTP request methods supported by Cortex.

Request Entry Points

Lists and defines Cortex entry points.

JSON Format

A breakdown of Plain JSON and HAL representation

URI Standards

A breakdown of a Cortex URI, as well as descriptions of scope and default.

Links

A breakdown of a Cortex hypermedia links JSON array.

Zoom

An overview of Zoom, a Cortex technology that allows you retrieve multiple resource representations with a single request.

Hypermedia Controls

Introduction

An overview of Cortex hypermedia controls, which are ways to manipulate Cortex add items to cart, checkout, update customer profiles, and so on.

Lists

An overview of the lists hypermedia control, which is an ordered list of links to other resources.

Forms

An overview of the forms hypermedia control, which creates new resources in Cortex.

Selectors

An overview of the selector hypermedia control, which can change a resource's state.

NeedInfo

Describes the needinfo hypermedia control, which prevents a resource from changing its state until a set of conditions are satisfied.

Structured Messages

Describes the structured messages hypermedia control, a feature which passes useful information to your users.

API Reference

Headers

Lists the standard HTTP request headers that Cortex supports.

Query Parameters

Lists the custom query parameters that Cortex supports.

Response Status Codes

Lists some standard response status codes returned by Cortex.

FollowLocation

An overview of FollowLocation and some examples.

Proxy Configuration

How to set up a proxy server to handle reqeusts between Cortex and a client application. This gets around a Web Browsers' Same Origin Policy.

Parsing Responses

How to use JSONPath to extract data from Cortex JSON responses.

NeedInfo Messages

Lists structured messages of type NeedInfo returned by Cortex.

Field Validation Errors

Lists structured messages generated by field validation errors returned by Cortex.

Business State Errors

Lists structured messages generated by business state errors returned by Cortex.

Security Roles

Describes the Cortex security roles that are provided out of the box.

Personalization

An overview of Cortex personalization, which offers different pricing, promotions, or content based on a shopper's attributes.

Pricing and Promotion

An overview of the pricing and promotions resources and how they affect related resources.

Advisors

Lists advisors provided by Elastic Path and their purpose.

Tutorials

Authenticate a Customer

How to validate a registered user's credentials to receive an access token.

Generate a Public OAuth Token

How to request a public access token for an anonymous shopper.

Search for Items

How to search for items in a store.

Add an Item to a Cart

How to add an item to a customer's cart.

Remove Cart Item

How to remove an item from a customer's cart.

Select Item Options

How to select an item option for an item.

Purchasing: From Start to Finish

Overview of the base calls required to log a customer in, add an item to a cart, and then complete the cart's purchase.

Merging Public Carts

How to merge a public cart with a registered user's cart.

Viewing Consent of a Customer for a Data Policy

How to view customer consent for a data policy.

Changing Customer Consent for a Data Policy

How to change customer consent for a data policy.

Articles

Developer Tips

Tips, tricks, and tools a Cortex application developer should use when developing a client application.

Items Explained

Detailed explanation of items, item definitions, and item components.

Reference

Resource Reference Guide

Describes the Cortex resources, their workflows and response fields.

Resource Relationship Map

Provides the resource relationship map, which is a visual map of Cortex resources and their relationships.

Getting Started

Introduction

Introduces Cortex, a hypermedia REST API for e-commerce.

Learning To Use Cortex

Basic steps to make your first Cortex API request.

Learning To Use Cortex Studio

Overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

Learning To Use Cortex Java SDK

Overview of Cortex Java SDK, how to set it up with your OSGi project, and sample code for constructing URIs and marshalling Cortex responses.

API Basics

Resources

An overview of Cortex resources, their purpose and formats.

Request Methods

Lists HTTP request methods supported by Cortex.

Request Entry Points

Lists and defines Cortex entry points.

JSON Format

A breakdown of a standard Cortex JSON representation.

URI Standards

A breakdown of a Cortex URI, as well as descriptions of scope and default.

Links

A breakdown of a Cortex hypermedia links JSON array.

Zoom

An overview of Zoom, a Cortex technology that allows you retrieve multiple resource representations with a single request.

Hypermedia Controls

Introduction

An overview of Cortex hypermedia controls, which are ways to manipulate Cortex add items to cart, checkout, update customer profiles, and so on.

Lists

An overview of the lists hypermedia control, which is an ordered list of links to other resources.

Forms

An overview of the forms hypermedia control, which creates new resources in Cortex.

Selectors

An overview of the selector hypermedia control, which can change a resource's state.

NeedInfo

Describes the needinfo hypermedia control, which prevents a resource from changing its state until a set of conditions are satisfied.

Structured Messages

Describes the structured messages hypermedia control, a feature which passes useful information to your users.

API Reference

Headers

Lists the standard HTTP request headers that Cortex supports.

Query Parameters

Lists the custom query parameters that Cortex supports.

Response Status Codes

Lists some standard response status codes returned by Cortex.

FollowLocation

An overview of FollowLocation and some examples.

Proxy Configuration

How to set up a proxy server to handle reqeusts between Cortex and a client application. This gets around a Web Browsers' Same Origin Policy.

Parsing Responses

How to use JSONPath to extract data from Cortex JSON responses.

NeedInfo Messages

Lists structured messages of type NeedInfo returned by Cortex.

Field Validation Errors

Lists structured messages generated by field validation errors returned by Cortex.

Business State Errors

Lists structured messages generated by business state errors returned by Cortex.

Security Roles

Describes the Cortex security roles that are provided out of the box.

Personalization

An overview of Cortex personalization, which offers different pricing, promotions, or content based on a shopper's attributes.

Pricing and Promotion

An overview of the pricing and promotions resources and how they affect related resources.

Advisors

Lists advisors provided by Elastic Path and their purpose.

Tutorials

Authenticate a Customer

How to validate a registered user's credentials to receive an access token.

Generate a Public OAuth Token

How to request a public access token for an anonymous shopper.

Search for Items

How to search for items in a store.

Add an Item to a Cart

How to add an item to a customer's cart.

Remove Cart Item

How to remove an item from a customer's cart.

Select Item Options

How to select an item option for an item.

Purchasing: From Start to Finish

Overview of the base calls required to log a customer in, add an item to a cart, and then complete the cart's purchase.

Merging Public Carts

How to merge a public cart with a registered user's cart.

Viewing Consent of a Customer for a Data Policy

How to view customer consent for a data policy.

Changing Customer Consent for a Data Policy

How to change customer consent for a data policy.

Articles

Developer Tips

Tips, tricks, and tools a Cortex application developer should use when developing a client application.

Items Explained

Detailed explanation of items, item definitions, and item components.

Reference

Resource Reference Guide

Describes the Cortex resources, their workflows and response fields.

Resource Relationship Map

Provides the resource relationship map, which is a visual map of Cortex resources and their relationships.

Getting Started

Introduction

Introduces Cortex, a hypermedia REST API for e-commerce.

Learning To Use Cortex

Basic steps to make your first Cortex API request.

Learning To Use Cortex Studio

Overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

Learning To Use Cortex Java SDK

Overview of Cortex Java SDK, how to set it up with your OSGi project, and sample code for constructing URIs and marshalling Cortex responses.

API Basics

Resources

An overview of Cortex resources, their purpose and formats.

Request Methods

Lists HTTP request methods supported by Cortex.

Request Entry Points

Lists and defines Cortex entry points.

JSON Format

A breakdown of a standard Cortex JSON representation.

URI Standards

A breakdown of a Cortex URI, as well as descriptions of scope and default.

Links

A breakdown of a Cortex hypermedia links JSON array.

Zoom

An overview of Zoom, a Cortex technology that allows you retrieve multiple resource representations with a single request.

Hypermedia Controls

Introduction

An overview of Cortex hypermedia controls, which are ways to manipulate Cortex add items to cart, checkout, update customer profiles, and so on.

Lists

An overview of the lists hypermedia control, which is an ordered list of links to other resources.

Forms

An overview of the forms hypermedia control, which creates new resources in Cortex.

Selectors

An overview of the selector hypermedia control, which can change a resource's state.

NeedInfo

Describes the needinfo hypermedia control, which prevents a resource from changing its state until a set of conditions are satisfied.

Structured Messages

Describes the structured messages hypermedia control, a feature which passes useful information to your users.

API Reference

Headers

Lists the standard HTTP request headers that Cortex supports.

Query Parameters

Lists the custom query parameters that Cortex supports.

Response Status Codes

Lists some standard response status codes returned by Cortex.

FollowLocation

An overview of FollowLocation and some examples.

Proxy Configuration

How to set up a proxy server to handle reqeusts between Cortex and a client application. This gets around a Web Browsers' Same Origin Policy.

Parsing Responses

How to use JSONPath to extract data from Cortex JSON responses.

NeedInfo Messages

Lists structured messages of type NeedInfo returned by Cortex.

Field Validation Errors

Lists structured messages generated by field validation errors returned by Cortex.

Business State Errors

Lists structured messages generated by business state errors returned by Cortex.

Security Roles

Describes the Cortex security roles that are provided out of the box.

Personalization

An overview of Cortex personalization, which offers different pricing, promotions, or content based on a shopper's attributes.

Pricing and Promotion

An overview of the pricing and promotions resources and how they affect related resources.

Tutorials

Authenticate a Customer

How to validate a registered user's credentials to receive an access token.

Generate a Public OAuth Token

How to request a public access token for an anonymous shopper.

Search for Items

How to search for items in a store.

Add an Item to a Cart

How to add an item to a customer's cart.

Remove Cart Item

How to remove an item from a customer's cart.

Select Item Options

How to select an item option for an item.

Purchasing: From Start to Finish

Overview of the base calls required to log a customer in, add an item to a cart, and then complete the cart's purchase.

Merging Public Carts

How to merge a public cart with a registered user's cart.

Articles

Developer Tips

Tips, tricks, and tools a Cortex application developer should use when developing a client application.

Items Explained

Detailed explanation of items, item definitions, and item components.

Reference

Resource Reference Guide

Describes the Cortex resources, their workflows and response fields.

Resource Relationship Map

Provides the resource relationship map, which is a visual map of Cortex resources and their relationships.

Getting Started

Introduction

Introduces Cortex, a hypermedia REST API for e-commerce.

Learning To Use Cortex

Basic steps to make your first Cortex API request.

Learning To Use Cortex Studio

Overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

Learning To Use Cortex Java SDK

Overview of Cortex Java SDK, how to set it up with your OSGi project, and sample code for constructing URIs and marshalling Cortex responses.

API Basics

Resources

An overview of Cortex resources, their purpose and formats.

Request Methods

Lists HTTP request methods supported by Cortex.

Request Entry Points

Lists and defines Cortex entry points.

JSON Format

A breakdown of a standard Cortex JSON representation.

URI Standards

A breakdown of a Cortex URI, as well as descriptions of scope and default.

Links

A breakdown of a Cortex hypermedia links JSON array.

Zoom

An overview of Zoom, a Cortex technology that allows you retrieve multiple resource representations with a single request.

Hypermedia Controls

Introduction

An overview of Cortex hypermedia controls, which are ways to manipulate Cortex add items to cart, checkout, update customer profiles, and so on.

Lists

An overview of the lists hypermedia control, which is an ordered list of links to other resources.

Forms

An overview of the forms hypermedia control, which creates new resources in Cortex.

Selectors

An overview of the selector hypermedia control, which can change a resource's state.

NeedInfo

Describes the needinfo hypermedia control, which prevents a resource from changing its state until a set of conditions are satisfied.

Structured Messages

Describes the structured messages hypermedia control, a feature which passes useful information to your users.

API Reference

Headers

Lists the standard HTTP request headers that Cortex supports.

Query Parameters

Lists the custom query parameters that Cortex supports.

Response Status Codes

Lists some standard response status codes returned by Cortex.

FollowLocation

An overview of FollowLocation and some examples.

Proxy Configuration

How to set up a proxy server to handle reqeusts between Cortex and a client application. This gets around a Web Browsers' Same Origin Policy.

Parsing Responses

How to use JSONPath to extract data from Cortex JSON responses.

Security Roles

Describes the Cortex security roles that are provided out of the box.

Personalization

An overview of Cortex personalization, which offers different pricing, promotions, or content based on a shopper's attributes.

Pricing and Promotion

An overview of the pricing and promotions resources and how they affect related resources.

Tutorials

Authenticate a Customer

How to validate a registered user's credentials to receive an access token.

Generate a Public OAuth Token

How to request a public access token for an anonymous shopper.

Search for Items

How to search for items in a store.

Add an Item to a Cart

How to add an item to a customer's cart.

Remove Cart Item

How to remove an item from a customer's cart.

Select Item Options

How to select an item option for an item.

Purchasing: From Start to Finish

Overview of the base calls required to log a customer in, add an item to a cart, and then complete the cart's purchase.

Merging Public Carts

How to merge a public cart with a registered user's cart.

Articles

Developer Tips

Tips, tricks, and tools a Cortex application developer should use when developing a client application.

Items Explained

Detailed explanation of items, item definitions, and item components.

Reference

Resource Reference Guide

Describes the Cortex resources, their workflows and response fields.

Resource Relationship Map

Provides the resource relationship map, which is a visual map of Cortex resources and their relationships.

Getting Started

Introduction

Introduces Cortex, a hypermedia REST API for e-commerce.

Learning To Use Cortex

Basic steps to make your first Cortex API request.

Learning To Use Cortex Studio

Overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

Learning To Use Cortex Java SDK

Overview of Cortex Java SDK, how to set it up with your OSGi project, and sample code for constructing URIs and marshalling Cortex responses.

API Basics

Resources

An overview of Cortex resources, their purpose and formats.

Request Methods

Lists HTTP request methods supported by Cortex.

Request Entry Points

Lists and defines Cortex entry points.

JSON Format

A breakdown of a standard Cortex JSON representation.

URI Standards

A breakdown of a Cortex URI, as well as descriptions of scope and default.

Links

A breakdown of a Cortex hypermedia links JSON array.

Zoom

An overview of Zoom, a Cortex technology that allows you retrieve multiple resource representations with a single request.

Hypermedia Controls

Introduction

An overview of Cortex hypermedia controls, which are ways to manipulate Cortex add items to cart, checkout, update customer profiles, and so on.

Lists

An overview of the lists hypermedia control, which is an ordered list of links to other resources.

Forms

An overview of the forms hypermedia control, which creates new resources in Cortex.

Selectors

An overview of the selector hypermedia control, which can change a resource's state.

NeedInfo

Describes the needinfo hypermedia control, which prevents a resource from changing its state until a set of conditions are satisfied.

Structured Messages

Describes the structured messages hypermedia control, a feature which passes useful information to your users.

API Reference

Headers

Lists the standard HTTP request headers that Cortex supports.

Query Parameters

Lists the custom query parameters that Cortex supports.

Response Status Codes

Lists some standard response status codes returned by Cortex.

FollowLocation

An overview of FollowLocation and some examples.

Proxy Configuration

How to set up a proxy server to handle reqeusts between Cortex and a client application. This gets around a Web Browsers' Same Origin Policy.

Parsing Responses

How to use JSONPath to extract data from Cortex JSON responses.

Security Roles

Describes the Cortex security roles that are provided out of the box.

Personalization

An overview of Cortex personalization, which offers different pricing, promotions, or content based on a shopper's attributes.

Pricing and Promotion

An overview of the pricing and promotions resources and how they affect related resources.

Tutorials

Authenticate a Customer

How to validate a registered user's credentials to receive an access token.

Generate a Public OAuth Token

How to request a public access token for an anonymous shopper.

Search for Items

How to search for items in a store.

Add an Item to a Cart

How to add an item to a customer's cart.

Remove Cart Item

How to remove an item from a customer's cart.

Select Item Options

How to select an item option for an item.

Purchasing: From Start to Finish

Overview of the base calls required to log a customer in, add an item to a cart, and then complete the cart's purchase.

Merging Public Carts

How to merge a public cart with a registered user's cart.

Articles

Developer Tips

Tips, tricks, and tools a Cortex application developer should use when developing a client application.

Items Explained

Detailed explanation of items, item definitions, and item components.

Reference

Resource Reference Guide

Describes the Cortex resources, their workflows and response fields.

Resource Relationship Map

Provides the resource relationship map, which is a visual map of Cortex resources and their relationships.

Getting Started

Introduction

Introduces Cortex, a hypermedia REST API for e-commerce.

Learning To Use Cortex

Basic steps to make your first Cortex API request.

Learning To Use Cortex Studio

Overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

Learning To Use Cortex Java SDK

Overview of Cortex Java SDK, how to set it up with your OSGi project, and sample code for constructing URIs and marshalling Cortex responses.

API Basics

Resources

An overview of Cortex resources, their purpose and formats.

Request Methods

Lists HTTP request methods supported by Cortex.

Request Entry Points

Lists and defines Cortex entry points.

JSON Format

A breakdown of a standard Cortex JSON representation.

URI Standards

A breakdown of a Cortex URI, as well as descriptions of scope and default.

Links

A breakdown of a Cortex hypermedia links JSON array.

Zoom

An overview of Zoom, a Cortex technology that allows you retrieve multiple resource representations with a single request.

Hypermedia Controls

Introduction

An overview of Cortex hypermedia controls, which are ways to manipulate Cortex add items to cart, checkout, update customer profiles, and so on.

Lists

An overview of the lists hypermedia control, which is an ordered list of links to other resources.

Forms

An overview of the forms hypermedia control, which creates new resources in Cortex.

Selectors

An overview of the selector hypermedia control, which can change a resource's state.

NeedInfo

Describes the needinfo hypermedia control, which prevents a resource from changing its state until a set of conditions are satisfied.

API Reference

Headers

Lists the standard HTTP request headers that Cortex supports.

Query Parameters

Lists the custom query parameters that Cortex supports.

Response Status Codes

Lists some standard response status codes returned by Cortex.

FollowLocation

An overview of FollowLocation and some examples.

Proxy Configuration

How to set up a proxy server to handle reqeusts between Cortex and a client application. This gets around a Web Browsers' Same Origin Policy.

Parsing Responses

How to use JSONPath to extract data from Cortex JSON responses.

Security Roles

Describes the Cortex security roles that are provided out of the box.

Personalization

An overview of Cortex personalization, which offers different pricing, promotions, or content based on a shopper's attributes.

Pricing and Promotion

An overview of the pricing and promotions resources and how they affect related resources.

Tutorials

Authenticate a Customer

How to validate a registered user's credentials to receive an access token.

Generate a Public OAuth Token

How to request a public access token for an anonymous shopper.

Search for Items

How to search for items in a store.

Add an Item to a Cart

How to add an item to a customer's cart.

Remove Cart Item

How to remove an item from a customer's cart.

Select Item Options

How to select an item option for an item.

Purchasing: From Start to Finish

Overview of the base calls required to log a customer in, add an item to a cart, and then complete the cart's purchase.

Merging Public Carts

How to merge a public cart with a registered user's cart.

Articles

Developer Tips

Tips, tricks, and tools a Cortex application developer should use when developing a client application.

Items Explained

Detailed explanation of items, item definitions, and item components.

Getting Started

Introduction

Introduces Cortex, a hypermedia REST API for e-commerce.

Learning To Use Cortex

Basic steps to make your first Cortex API request.

Learning To Use Cortex Studio

Overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

Learning To Use Cortex Java SDK

Overview of Cortex Java SDK, how to set it up with your OSGi project, and sample code for constructing URIs and marshalling Cortex responses.

API Basics

Resources

An overview of Cortex resources, their purpose and formats.

Request Methods

Lists HTTP request methods supported by Cortex.

Request Entry Points

Lists and defines Cortex entry points.

JSON Format

A breakdown of a standard Cortex JSON representation.

URI Standards

A breakdown of a Cortex URI, as well as descriptions of scope and default.

Links

A breakdown of a Cortex hypermedia links JSON array.

Zoom

An overview of Zoom, a Cortex technology that allows you retrieve multiple resource representations with a single request.

Hypermedia Controls

Introduction

An overview of Cortex hypermedia controls, which are ways to manipulate Cortex add items to cart, checkout, update customer profiles, and so on.

Lists

An overview of the lists hypermedia control, which is an ordered list of links to other resources.

Forms

An overview of the forms hypermedia control, which creates new resources in Cortex.

Selectors

An overview of the selector hypermedia control, which can change a resource's state.

NeedInfo

Describes the needinfo hypermedia control, which prevents a resource from changing its state until a set of conditions are satisfied.

API Reference

Headers

Lists the standard HTTP request headers that Cortex supports.

Query Parameters

Lists the custom query parameters that Cortex supports.

Response Status Codes

Lists some standard response status codes returned by Cortex.

FollowLocation

An overview of FollowLocation and some examples.

Proxy Configuration

How to set up a proxy server to handle reqeusts between Cortex and a client application. This gets around a Web Browsers' Same Origin Policy.

Parsing Responses

How to use JSONPath to extract data from Cortex JSON responses.

Security Roles

Describes the Cortex security roles that are provided out of the box.

Personalization

An overview of Cortex personalization, which offers different pricing, promotions, or content based on a shopper's attributes.

Pricing and Promotion

An overview of the pricing and promotions resources and how they affect related resources.

Tutorials

Authenticate a Customer

How to validate a registered user's credentials to receive an access token.

Generate a Public OAuth Token

How to request a public access token for an anonymous shopper.

Search for Items

How to search for items in a store.

Add an Item to a Cart

How to add an item to a customer's cart.

Remove Cart Item

How to remove an item from a customer's cart.

Select Item Options

How to select an item option for an item.

Purchasing: From Start to Finish

Overview of the base calls required to log a customer in, add an item to a cart, and then complete the cart's purchase.

Merging Public Carts

How to merge a public cart with a registered user's cart.

Articles

Developer Tips

Tips, tricks, and tools a Cortex application developer should use when developing a client application.

Items Explained

Detailed explanation of items, item definitions, and item components.

Getting Started

Introduction

Introduces Cortex, a hypermedia REST API for e-commerce.

Learning To Use Cortex

Basic steps to make your first Cortex API request.

Learning To Use Cortex Studio

Overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

Learning To Use Cortex Java SDK

Overview of Cortex Java SDK, how to set it up with your OSGi project, and sample code for constructing URIs and marshalling Cortex responses.

API Basics

Resources

An overview of Cortex resources, their purpose and formats.

Request Methods

Lists HTTP request methods supported by Cortex.

Request Entry Points

Lists and defines Cortex entry points.

JSON Format

A breakdown of a standard Cortex JSON representation.

URI Standards

A breakdown of a Cortex URI, as well as descriptions of scope and default.

Links

A breakdown of a Cortex hypermedia links JSON array.

Zoom

An overview of Zoom, a Cortex technology that allows you retrieve multiple resource representations with a single request.

Hypermedia Controls

Introduction

An overview of Cortex hypermedia controls, which are ways to manipulate Cortex add items to cart, checkout, update customer profiles, and so on.

Lists

An overview of the lists hypermedia control, which is an ordered list of links to other resources.

Forms

An overview of the forms hypermedia control, which creates new resources in Cortex.

Selectors

An overview of the selector hypermedia control, which can change a resource's state.

NeedInfo

Describes the needinfo hypermedia control, which prevents a resource from changing its state until a set of conditions are satisfied.

API Reference

Headers

Lists the standard HTTP request headers that Cortex supports.

Query Parameters

Lists the custom query parameters that Cortex supports.

Response Status Codes

Lists some standard response status codes returned by Cortex.

FollowLocation

An overview of FollowLocation and some examples.

Proxy Configuration

How to set up a proxy server to handle reqeusts between Cortex and a client application. This gets around a Web Browsers' Same Origin Policy.

Parsing Responses

How to use JSONPath to extract data from Cortex JSON responses.

Security Roles

Describes the Cortex security roles that are provided out of the box.

Personalization

An overview of Cortex personalization, which offers different pricing, promotions, or content based on a shopper's attributes.

Pricing and Promotion

An overview of the pricing and promotions resources and how they affect related resources.

Tutorials

Authenticate a Customer

How to validate a registered user's credentials to receive an access token.

Generate a Public OAuth Token

How to request a public access token for an anonymous shopper.

Search for Items

How to search for items in a store.

Add an Item to a Cart

How to add an item to a customer's cart.

Remove Cart Item

How to remove an item from a customer's cart.

Select Item Options

How to select an item option for an item.

Purchasing: From Start to Finish

Overview of the base calls required to log a customer in, add an item to a cart, and then complete the cart's purchase.

Merging Public Carts

How to merge a public cart with a registered user's cart.

Articles

Developer Tips

Tips, tricks, and tools a Cortex application developer should use when developing a client application.

Items Explained

Detailed explanation of items, item definitions, and item components.

Getting Started

Introduction

Introduces Cortex, a hypermedia REST API for e-commerce.

Learning To Use Cortex

Basic steps to make your first Cortex API request.

Learning To Use Cortex Studio

Overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

Learning To Use Cortex Java SDK

Overview of Cortex Java SDK, how to set it up with your OSGi project, and sample code for constructing URIs and marshalling Cortex responses.

API Basics

Resources

An overview of Cortex resources, their purpose and formats.

Request Methods

Lists HTTP request methods supported by Cortex.

Request Entry Points

Lists and defines Cortex entry points.

JSON Format

A breakdown of a standard Cortex JSON representation.

URI Standards

A breakdown of a Cortex URI, as well as descriptions of scope and default.

Links

A breakdown of a Cortex hypermedia links JSON array.

Zoom

An overview of Zoom, a Cortex technology that allows you retrieve multiple resource representations with a single request.

Hypermedia Controls

Introduction

An overview of Cortex hypermedia controls, which are ways to manipulate Cortex add items to cart, checkout, update customer profiles, and so on.

Lists

An overview of the lists hypermedia control, which is an ordered list of links to other resources.

Forms

An overview of the forms hypermedia control, which creates new resources in Cortex.

Selectors

An overview of the selector hypermedia control, which can change a resource's state.

NeedInfo

Describes the needinfo hypermedia control, which prevents a resource from changing its state until a set of conditions are satisfied.

API Reference

Headers

Lists the standard HTTP request headers that Cortex supports.

Query Parameters

Lists the custom query parameters that Cortex supports.

Response Status Codes

Lists some standard response status codes returned by Cortex.

FollowLocation

An overview of FollowLocation and some examples.

Proxy Configuration

How to set up a proxy server to handle reqeusts between Cortex and a client application. This gets around a Web Browsers' Same Origin Policy.

Parsing Responses

How to use JSONPath to extract data from Cortex JSON responses.

Security Roles

Describes the Cortex security roles that are provided out of the box.

Personalization

An overview of Cortex personalization, which offers different pricing, promotions, or content based on a shopper's attributes.

Pricing and Promotion

An overview of the pricing and promotions resources and how they affect related resources.

Tutorials

Authenticate a Customer

How to validate a registered user's credentials to receive an access token.

Generate a Public OAuth Token

How to request a public access token for an anonymous shopper.

Search for Items

How to search for items in a store.

Add an Item to a Cart

How to add an item to a customer's cart.

Remove Cart Item

How to remove an item from a customer's cart.

Select Item Options

How to select an item option for an item.

Purchasing: From Start to Finish

Overview of the base calls required to log a customer in, add an item to a cart, and then complete the cart's purchase.

Merging Public Carts

How to merge a public cart with a registered user's cart.

Articles

Developer Tips

Tips, tricks, and tools a Cortex application developer should use when developing a client application.

Items Explained

Detailed explanation of items, item definitions, and item components.

Getting Started

Introduction

Introduces Cortex, a hypermedia REST API for e-commerce.

Learning To Use Cortex

Basic steps to make your first Cortex API request.

Learning To Use Cortex Studio

Overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

Learning To Use Cortex Java SDK

Overview of Cortex Java SDK, how to set it up with your OSGi project, and sample code for constructing URIs and marshalling Cortex responses.

API Basics

Resources

An overview of Cortex resources, their purpose and formats.

Request Methods

Lists HTTP request methods supported by Cortex.

Request Entry Points

Lists and defines Cortex entry points.

JSON Format

A breakdown of a standard Cortex JSON representation.

URI Standards

A breakdown of a Cortex URI, as well as descriptions of scope and default.

Links

A breakdown of a Cortex hypermedia links JSON array.

Zoom

An overview of Zoom, a Cortex technology that allows you retrieve multiple resource representations with a single request.

Hypermedia Controls

Introduction

An overview of Cortex hypermedia controls, which are ways to manipulate Cortex add items to cart, checkout, update customer profiles, and so on.

Lists

An overview of the lists hypermedia control, which is an ordered list of links to other resources.

Forms

An overview of the forms hypermedia control, which creates new resources in Cortex.

Selectors

An overview of the selector hypermedia control, which can change a resource's state.

NeedInfo

Describes the needinfo hypermedia control, which prevents a resource from changing its state until a set of conditions are satisfied.

API Reference

Headers

Lists the standard HTTP request headers that Cortex supports.

Query Parameters

Lists the custom query parameters that Cortex supports.

Response Status Codes

Lists some standard response status codes returned by Cortex.

FollowLocation

An overview of FollowLocation and some examples.

Proxy Configuration

How to set up a proxy server to handle reqeusts between Cortex and a client application. This gets around a Web Browsers' Same Origin Policy.

Parsing Responses

How to use JSONPath to extract data from Cortex JSON responses.

Security Roles

Describes the Cortex security roles that are provided out of the box.

Personalization

An overview of Cortex personalization, which offers different pricing, promotions, or content based on a shopper's attributes.

Pricing and Promotion

An overview of the pricing and promotions resources and how they affect related resources.

Tutorials

Authenticate a Customer

How to validate a registered user's credentials to receive an access token.

Generate a Public OAuth Token

How to request a public access token for an anonymous shopper.

Add an Item to a Cart

How to add an item to a customer's cart.

Remove Cart Item

How to remove an item from a customer's cart.

Purchasing: From Start to Finish

Overview of the base calls required to log a customer in, add an item to a cart, and then complete the cart's purchase.

Merging Public Carts

How to merge a public cart with a registered user's cart.

Articles

Developer Tips

Tips, tricks, and tools a Cortex application developer should use when developing a client application.

Items Explained

Detailed explanation of items, item definitions, and item components.

Getting Started

Introduction

Introduces Cortex, a hypermedia REST API for e-commerce.

Learning To Use Cortex

Basic steps to make your first Cortex API request.

Learning To Use Cortex Studio

Overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

API Basics

Resources

An overview of Cortex resources, their purpose and formats.

Request Methods

Lists HTTP request methods supported by Cortex.

Request Entry Points

Lists and defines Cortex entry points.

JSON Format

A breakdown of a standard Cortex JSON representation.

URI Standards

A breakdown of a Cortex URI, as well as descriptions of scope and default.

Links

A breakdown of a Cortex hypermedia links JSON array.

Zoom

An overview of Zoom, a Cortex technology that allows you retrieve multiple resource representations with a single request.

Hypermedia Controls

Introduction

An overview of Cortex hypermedia controls, which are ways to manipulate Cortex add items to cart, checkout, update customer profiles, and so on.

Lists

An overview of the lists hypermedia control, which is an ordered list of links to other resources.

Forms

An overview of the forms hypermedia control, which creates new resources in Cortex.

Selectors

An overview of the selector hypermedia control, which can change a resource's state.

NeedInfo

Describes the needinfo hypermedia control, which prevents a resource from changing its state until a set of conditions are satisfied.

API Reference

Headers

Lists the standard HTTP request headers that Cortex supports.

Query Parameters

Lists the custom query parameters that Cortex supports.

Response Status Codes

Lists some standard response status codes returned by Cortex.

FollowLocation

An overview of FollowLocation and some examples.

Proxy Configuration

How to set up a proxy server to handle reqeusts between Cortex and a client application. This gets around a Web Browsers' Same Origin Policy.

Parsing Responses

How to use JSONPath to extract data from Cortex JSON responses.

Security Roles

Describes the Cortex security roles that are provided out of the box.

Personalization

An overview of Cortex personalization, which offers different pricing, promotions, or content based on a shopper's attributes.

Pricing and Promotion

An overview of the pricing and promotions resources and how they affect related resources.

Tutorials

Authenticate a Customer

How to validate a registered user's credentials to receive an access token.

Generate a Public OAuth Token

How to request a public access token for an anonymous shopper.

Add an Item to a Cart

How to add an item to a customer's cart.

Remove Cart Item

How to remove an item from a customer's cart.

Purchasing: From Start to Finish

Overview of the base calls required to log a customer in, add an item to a cart, and then complete the cart's purchase.

Merging Public Carts

How to merge a public cart with a registered user's cart.

Articles

Developer Tips

Tips, tricks, and tools a Cortex application developer should use when developing a client application.

Items Explained

Detailed explanation of items, item definitions, and item components.

Reference

Resource Reference Guide

Describes the Cortex resources, their workflows and response fields.

Getting Started

Introduction

Introduces Cortex, a hypermedia REST API for e-commerce.

Learning To Use Cortex

Basic steps to make your first Cortex API request.

Learning To Use Cortex Studio

Overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

API Basics

Resources

An overview of Cortex resources, their purpose and formats.

Request Methods

Lists HTTP request methods supported by Cortex.

Request Entry Points

Lists and defines Cortex entry points.

JSON Format

A breakdown of a standard Cortex JSON representation.

Links

A breakdown of a Cortex hypermedia links JSON array.

Zoom

An overview of Zoom, a Cortex technology that allows you retrieve multiple resource representations with a single request.

Hypermedia Controls

Introduction

An overview of Cortex hypermedia controls, which are ways to manipulate Cortex add items to cart, checkout, update customer profiles, and so on.

Lists

An overview of the lists hypermedia control, which is an ordered list of links to other resources.

Forms

An overview of the forms hypermedia control, which creates new resources in Cortex.

Selectors

An overview of the selector hypermedia control, which can change a resource's state.

NeedInfo

Describes the needinfo hypermedia control, which prevents a resource from changing its state until a set of conditions are satisfied.

API Reference

Headers

Lists the standard HTTP request headers that Cortex supports.

Query Parameters

Lists the custom query parameters that Cortex supports.

Response Status Codes

Lists some standard response status codes returned by Cortex.

FollowLocation

An overview of FollowLocation and some examples.

URI Standards

A breakdown of a Cortex URI, as well as descriptions of scope and default.

Proxy Configuration

How to set up a proxy server to handle reqeusts between Cortex and a client application. This gets around a Web Browsers' Same Origin Policy.

Parsing Responses

How to use JSONPath to extract data from Cortex JSON responses.

Security Roles

Describes the Cortex security roles that are provided out of the box.

Personalization

An overview of Cortex personalization, which offers different pricing, promotions, or content based on a shopper's attributes.

Pricing and Promotion

An overview of the pricing and promotions resources and how they affect related resources.

Tutorials

Authenticate a Customer

How to validate a registered user's credentials to receive an access token.

Generate a Public OAuth Token

How to request a public access token for an anonymous shopper.

Search for Items

How to search for items in a store.

Add an Item to a Cart

How to add an item to a customer's cart.

Remove Cart Item

How to remove an item from a customer's cart.

Select Item Options

How to select an item option for an item.

Purchasing: From Start to Finish

Overview of the base calls required to log a customer in, add an item to a cart, and then complete the cart's purchase.

Merging Public Carts

How to merge a public cart with a registered user's cart.

Articles

Developer Tips

Tips, tricks, and tools a Cortex application developer should use when developing a client application.

Items Explained

Detailed explanation of items, item definitions, and item components.

Getting Started

What is Cortex API?

Introduces Cortex, a hypermedia REST API for e-commerce.

Learning To Use Cortex

Basic steps to make your first Cortex API request.

Learning To Use Cortex Studio

Overview of Cortex Studio, a customized REST client Web Application for testing Cortex features.

API Fundamentals

API Entry Points

Lists and defines Cortex entry points.

JSON Objects

A breakdown of a standard Cortex JSON representation.

URI Standards

A breakdown of a Cortex URI, as well as descriptions of scope and default.

Forms

An overview of the forms hypermedia control, which creates new resources in Cortex.

Selectors

An overview of the selector hypermedia control, which can change a resource's state.

NeedInfo

Describes the needinfo hypermedia control, which prevents a resource from changing its state until a set of conditions are satisfied.

FollowLocation

An overview of FollowLocation and some examples.

Zoom

An overview of Zoom, a Cortex technology that allows you retrieve multiple resource representations with a single request.

Security Roles

Describes the Cortex security roles that are provided out of the box.

Items Explained

Detailed explanation of items, item definitions, and item components.

Tutorials

Authenticate a Customer

How to validate a registered user's credentials to receive an access token.

Generate a Public OAuth Token

How to request a public access token for an anonymous shopper.

Search for Items

How to search for items in a store.

Add an Item to a Cart

How to add an item to a customer's cart.

Remove Cart Item

How to remove an item from a customer's cart.

Select Item Options

How to select an item option for an item.

Purchasing: From Start to Finish

Overview of the base calls required to log a customer in, add an item to a cart, and then complete the cart's purchase.

Merging Public Carts

How to merge a public cart with a registered user's cart.

Status Codes and Responses

Cortex API Responses

Lists some of the standard responses returned by Cortex.

Cortex API Status Codes

Lists some of the standard response codes returned by Cortex.

Articles

Developer Tips

Tips, tricks, and tools a Cortex application developer should use when developing a client application.