Loading...

Last updated: Oct 20 2016

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

Catalog entries

This topic describes how to work with catalog entries in the Episerver service API, when defining catalog integration services for Episerver Commerce. See Catalog service for information about using the service integration for catalogs.

In this topic

Special strings

Theses properties require special values to function properly.

InventoryStatus

  • Enabled
  • Disabled
  • Ignored

EntryType

  • Product
  • Variant
  • Package
  • Bundle
  • DynamicPackage

Example models

Get All Entries
/episerverapi/commerce/entries/{startPage}/{pageSize}

By default this method gets all languages for the entries. If you want only one specific language, use the Accept-Language header. 

Client Code Media Type Json

Client Code Media Type XML

Get Entry
/episerverapi/commerce/entries/{entry code}

By default this method gets all languages for the entry. If you want only one specific language use the Accept-Language header.

Client Code Media Type Json

Client Code Media Type XML

Post Entry
/episerverapi/commerce/entries

Client Code Media Type Json

Client Code Media Type XML

Put Entry
/episerverapi/commerce/entries/{entry code}

Client Code Media Type Json

Client Code Media Type XML

Delete Entry
/episerverapi/commerce/entries/{entry code}

Client Code Media Type Json

Client Code Media Type XML

Common draft entries [New in Service API 5.1.0]

Previously, the Service API supported published versions only. Use the new endpoints (listed below) to get common draft versions, create new common drafts, and update or delete existing drafts.

Get common draft entry [New in Service API 5.1.0]

Post common draft entry [New in Service API 5.1.0]

Note: We don’t 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 entry [New in Service API 5.1.0]]

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

Delete common draft entry [New in Service API 5.1.0]


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/