Loading...

Last updated: Jul 30 2018

Area: Episerver Service API Applies to versions: 1.0 and higher

Catalog

This topic describes how to work with catalog in the Episerver service API: published version (from version 1.0 and higher] and common draft version (from version 5.1.0 and higher)

In this topic

Example models

Published version

Common draft version

Example models

Published version

From version 1 and higher.

Get all catalogs

/episerverapi/commerce/catalogs

Get a specific catalog

/episerverapi/commerce/catalogs/{name}

Create catalog

/episerverapi/commerce/catalogs

Update catalog

/episerverapi/commerce/catalogs/{name}

Delete catalog

/episerverapi/commerce/catalogs/{name}

Common draft version

Previously, the Service API supported published versions only. From version 5.1.0, the Service API introduced APIs that work with a common draft catalog. By adding new endpoints (listed below), you can get common draft catalog versions, create new common drafts, and update or delete existing common draft catalogs. 

Get common draft catalog

/episerverapi/commerce/catalogs/{name}/commondraft/{lang}

Post common draft catalog

/episerverapi/commerce/catalogs/commondraft/{lang}

Note: Episerver does not support creating common drafts for non-existing content. You can create a first draft version by using an endpoint for published content (without “commondraft”) and setting IsActive to “false”.

Put common draft catalog

/episerverapi/commerce/catalogs/{name}/commondraft/{lang}

Note: If common draft content is in a “Published” state, then a new common draft version is created (same behavior as Post common draft). If a common draft content is in DelayedPublsih/AwaitingApproval/CheckedIn state, then it skips updating content and returns a Conflict status code (409).

Delete common draft catalog

/episerverapi/commerce/catalogs/{name}/commondraft/{lang}


Do you have feedback on this documentation? Send an email to documentation@episerver.com. For development-related questions and discussions, refer to our Forums on https://world.episerver.com/forum/