HomeDev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunityDoc feedbackLog In

The Optimizely Service API is a service layer that lets system integrators update and retrieve information from Optimizely Commerce, ensuring a seamless integration with external systems, such as product information management, data assessment management, and ERPs.

## Use cases

The Optimizely Service API provides a programming interface for performing operations like:

  • Bulk import of [media](🔗) in Commerce.

  • Bulk import and export of [catalog data](🔗) in Commerce.

  • Bulk asset linking between [media and catalog content](🔗) .

  • Import and export of ["episerverdata" content type](🔗) of files.

  • Import and export of [forms](🔗) data.

  • RESTful CRUD operations for managing data integration with [Catalogs](🔗), [Cart operations](🔗), [Order operations](🔗), [Customer operations](🔗), and [Content operations](🔗).

## Get started

The Optimizely Service API is installed as a NuGet package [EPiServer.ServiceApi](🔗). The Service API is available for Optimizely Commerce version 8.5 and higher. See [Installation and configuration](🔗) how to install and set up the integration.

See also [Service API](🔗) for the REST API service layer.

The Service API integration service uses OWIN-based authentication and ASP.NET Identity, see [Installation and configuration](🔗) and [Overview of bulk importing](🔗).

## Requests and responses

Below is an example illustrating the usage of the REST API for managing CRUD operations.

### GET carts by name and customer ID


  • **Base path** **(base URL/host):** episerverapi

  • **Endpoint:** commerce/carts/

  • **Query string parameter(s):** /{customerId}/{name}

Column Title
Column Title

**Example:** Request GET method using C#/.NET

**JSON response**

Overview of request and response interactions between the application and the REST API.