--- title: Catalog entries slug: commerce-connect-15/service-api/catalog-entries docTags: createdAt: 2026-07-22T14:38:27.000Z --- ## Example models ```csharp [Serializable] public class NameValue { public string Name { get; set; } public string Value { get; set; } } [Serializable] public class ResourceLink { public string Title { get; set; } public string Type { get; set; } public string Href { get; set; } public List<NameValue> Properties { get; set; } } [Serializable] public class SeoInfo { public string Title { get; set; } public string Uri { get; set; } public string UriSegment { get; set; } public string Description { get; set; } public string Keywords { get; set; } public string LanguageCode { get; set; } } [Serializable] public class MetaFieldData { public string Language { get; set; } public string Value { get; set; } } [Serializable] public class MetaFieldProperty { public string Name { get; set; } public string Type { get; set; } public List<MetaFieldData> Data { get; set; } } [Serializable] public class VariationProperties { public decimal MinQuantity { get; set; } public decimal MaxQuantity { get; set; } public double Weight { get; set; } public String TaxCategory { get; set; } } [Serializable] public class DimensionProperties { public double Length { get; set; } public double Heigth { get; set; } public double Width {get; set; } } [Serializable] public class Entry { public Entry() { SeoInformation = new List<SeoInfo>(); Assets = new List<ResourceLink>(); Associations = new List<ResourceLink>(); MetaFields = new List<MetaFieldProperty>(); WarehouseInventories = new List<ResourceLink>(); Prices = new List<ResourceLink>(); ChildCatalogEntries = new List<ResourceLink>(); Nodes = new List<ResourceLink>(); ParentCatalogEntry = new ResourceLink(); Variation = null; } public string Code { get; set; } public Guid? ApplicationId { get; set; } public string Name { get; set; } public ResourceLink ParentCatalogEntry { get; set; } public DateTime StartDate { get; set; } public DateTime EndDate { get; set; } public bool IsActive { get; set; } public string MetaClass { get; set; } public string Catalog { get; set; } public List<MetaFieldProperty> MetaFields { get; set; } public List<SeoInfo> SeoInformation { get; set; } public List<ResourceLink> Prices { get; set; } public string EntryType { get; set; } public List<ResourceLink> ChildCatalogEntries { get; set; } public string InventoryStatus { get; set; } public List<ResourceLink> WarehouseInventories { get; set; } public List<ResourceLink> Associations { get; set; } public List<ResourceLink> Assets { get; set; } public List<ResourceLink> Nodes { get; set; } public VariationProperties Variation { get; set; } public DimensionProperties Dimension {get; set; } } [Serializable] public class Entries { public Entries() { EntryResults = new List<Entry>(); TotalCount = 0; TotalPages = 0; } public List<Entry> EntryResults { get; set; } public int TotalCount { get; set; } public int TotalPages { get; set; } } ``` ## Published catalog entries ### Get all entries | GET | `get/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. | | --- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ### JSON response type ```csharp var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token.AccessToken); var result = client.GetAsync("/episerverapi/commerce/entries/{startPage}/{pageSize}").Result.Content.ReadAsStringAsync().Result ``` ### XML response type ```csharp var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token.AccessToken); client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("text/xml")); var result = client.GetAsync("/episerverapi/commerce/entries/{startPage}/{pageSize}").Result.Content.ReadAsStringAsync().Result ``` Response ```xml Jackets-Peacoats-Hooded b60ed82e-95b4-4f8b-ad43-2ce99f3b9470 Jackets-Peacoats-Hooded 2010-09-01T07:00:00Z 2020-10-01T07:00:00Z true Fashion_Product_Class Departmental Catalog DisplayName ShortString en Jackets-Peacoats-Hooded Facet_Bestseller ShortString en Yes <Uri>Jackets-Peacoats-Hooded.aspx</Uri> <UriSegment>Jackets-Peacoats-Hooded</UriSegment> <Description /> <Keywords /> <LanguageCode>en</LanguageCode> </SeoInfo> </SeoInformation> <Prices/> <EntryType>Product</EntryType> <ChildCatalogEntries> <ResourceLink> <Title>Jackets-Peacoats-Hooded-Tan-Small CatalogEntry /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small Jackets-Peacoats-Hooded-Tan-Medium CatalogEntry /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Medium Disabled CrossSell Association /episerverapi/commerce/entries/Jackets-Peacoats-Hooded/associations/CrossSell Default Association /episerverapi/commerce/entries/Jackets-Peacoats-Hooded/associations/Default UpSell Association /episerverapi/commerce/entries/Jackets-Peacoats-Hooded/associations/UpSell a9cd22ed-a43d-47d0-ba66-bf56a4e59fe9 Asset /episerverapi/commerce/entries/Jackets-Peacoats-Hooded/assets/a9cd22ed-a43d-47d0-ba66-bf56a4e59fe9/episerver.core.icontentimage Jackets-Peacoats CatalogNode /episerverapi/commerce/nodes/Jackets-Peacoats Jackets-Peacoats-Hooded-Tan-Small b60ed82e-95b4-4f8b-ad43-2ce99f3b9470 Jackets-Peacoats-Hooded-Tan-Small 2010-09-01T13:00:00Z 2019-10-02T01:00:00Z true Fashion_Item_Class Departmental Catalog DisplayName ShortString en Jackets-Peacoats-Hooded-Tan-Small Facet_Color LongString en Tan <Uri>Jackets-Peacoats-Hooded-Tan-Small.aspx</Uri> <UriSegment>Jackets-Peacoats-Hooded-Tan-Small</UriSegment> <Description /> <Keywords /> <LanguageCode>en</LanguageCode> </SeoInfo> </SeoInformation> <Prices> <ResourceLink> <Title>$1,000.00 Price /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/prices/246 775,20 € Price /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/prices/247 Variation Enabled default - 10 WarehouseInventory /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/inventories/default HELSINKI - 200 WarehouseInventory /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/inventories/HELSINKI CrossSell Association /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/associations/CrossSell Default Association /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/associations/Default UpSell Association /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/associations/UpSell f23cd583-baa8-4e8f-871e-22fee65b6b73 Asset /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/assets/f23cd583-baa8-4e8f-871e-22fee65b6b73/episerver.core.icontentimage Jackets-Peacoats CatalogNode /episerverapi/commerce/nodes/Jackets-Peacoats 1.0000 50.0000 5 1.0000 50.0000 5.0000 6066 304 ``` ### Get a specific entry | GET | `get/episerverapi/commerce/entries/{entryCode}` | By default this method gets all languages for the entry. If you want only one specific language use the Accept-Language header. | | --- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ### JSON response type ```csharp var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token.AccessToken); var result = client.GetAsync("/episerverapi/commerce/entries/{entry code}").Result.Content.ReadAsStringAsync().Result ``` ### XML response type ```csharp var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token.AccessToken); client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("text/xml")); var result = client.GetAsync("/episerverapi/commerce/entries/{entry code}").Result.Content.ReadAsStringAsync().Result ``` Response ```xml Jackets-Peacoats-Hooded-Tan-Small b60ed82e-95b4-4f8b-ad43-2ce99f3b9470 Jackets-Peacoats-Hooded-Tan-Small 2010-09-01T13:00:00Z 2019-10-02T01:00:00Z true Fashion_Item_Class Departmental Catalog DisplayName ShortString en Jackets-Peacoats-Hooded-Tan-Small Facet_Color LongString en Tan <Uri>Jackets-Peacoats-Hooded-Tan-Small.aspx</Uri> <UriSegment>Jackets-Peacoats-Hooded-Tan-Small</UriSegment> <Description /> <Keywords /> <LanguageCode>en</LanguageCode> </SeoInfo> </SeoInformation> <Prices> <ResourceLink> <Title>$1,000.00 Price /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/prices/246 775,20 € Price /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/prices/247 Variation Enabled default - 10 WarehouseInventory /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/inventories/default HELSINKI - 200 WarehouseInventory /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/inventories/HELSINKI CrossSell Association /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/associations/CrossSell Default Association /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/associations/Default UpSell Association /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/associations/UpSell f23cd583-baa8-4e8f-871e-22fee65b6b73 Asset /episerverapi/commerce/entries/Jackets-Peacoats-Hooded-Tan-Small/assets/f23cd583-baa8-4e8f-871e-22fee65b6b73/episerver.core.icontentimage Jackets-Peacoats CatalogNode /episerverapi/commerce/nodes/Jackets-Peacoats 1.0000 50.0000 5 1.0000 50.0000 5.0000 ``` ### Create entry | POST | `post/episerverapi/commerce/entries` | Create entry. | | ---- | ------------------------------------ | ------------- | ### JSON response type ```csharp var model = new Entry() { Code = "WhoKnewBaby", Catalog = "Departmental Catalog", EndDate = DateTime.UtcNow.AddDays(100), EntryType = "Product", InventoryStatus = "Enabled", IsActive = true, MetaClass = "Fashion_Product_Class", Name = "Test", StartDate = DateTime.UtcNow, MetaFields = new List() { new MetaFieldProperty() { Name = "DisplayName", Type = "ShortString", Data = new List() { new MetaFieldData() { Language="en", Value = "DisplayName" } } } }, SeoInformation = new List() { new SeoInfo() { Description = "description", Keywords="", LanguageCode = "en", Title = "title", Uri = "whoknew", UriSegment = "whoknew" } } }; var json = JsonConvert.SerializeObject(model); var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token.AccessToken); var result = client.PostAsync("/episerverapi/commerce/entries", new StringContent(json, Encoding.UTF8, "application/json")).Result.Content.ReadAsStringAsync().Result ``` ### XML response type ```csharp var model = new Entry() { Code = "WhoKnewBaby", Catalog = "Departmental Catalog", EndDate = DateTime.UtcNow.AddDays(100), EntryType = "Product", InventoryStatus = "Enabled", IsActive = true, MetaClass = "Fashion_Product_Class", Name = "Test", StartDate = DateTime.UtcNow, MetaFields = new List() { new MetaFieldProperty() { Name = "DisplayName", Type = "ShortString", Data = new List() { new MetaFieldData() { Language="en", Value = "DisplayName" } } } }, SeoInformation = new List() { new SeoInfo() { Description = "description", Keywords="", LanguageCode = "en", Title = "title", Uri = "whoknew", UriSegment = "whoknew" } } }; var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token.AccessToken); var serializer = new XmlSerializer(typeof(Entry)); var xml = String.Empty; using (var ms = new MemoryStream()) { serializer.Serialize(ms, model); xml = Encoding.Default.GetString(ms.ToArray()); } var result = client.PostAsync("/episerverapi/commerce/entries", new StringContent(xml, Encoding.UTF8, "text/xml")).Result.Content.ReadAsStringAsync().Result ``` Response ```xml WhoKnewBaby Test 2014-08-26T13:52:07.8312797Z 2014-12-04T13:52:07.8312797Z true Fashion_Product_Class Departmental Catalog DisplayName ShortString en DisplayName title whoknew whoknew description en Product Enabled ``` ### Update entry | PUT | `put/episerverapi/commerce/entries/{entryCode}` | Update entry | | --- | ----------------------------------------------- | ------------ | ### JSON response type ```csharp var model = new Entry() { Code = "Dresses-Cocktail-Silk", Catalog = "Departmental Catalog", EndDate = DateTime.UtcNow.AddDays(100), EntryType = "Product", InventoryStatus = "Enabled", IsActive = true, MetaClass = "Fashion_Product_Class", Name = "Test", StartDate = DateTime.UtcNow, MetaFields = new List() { new MetaFieldProperty() { Name = "DisplayName", Type = "ShortString", Data = new List() { new MetaFieldData() { Language="en", Value = "Dresses-Cocktail-Silk" } } } }, SeoInformation = new List() { new SeoInfo() { Description = "description", Keywords="", LanguageCode = "en", Title = "title", Uri = "Dresses-Cocktail-Silk", UriSegment = "Dresses-Cocktail-Silk" } } }; var json = JsonConvert.SerializeObject(model); var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token.AccessToken); var result = client.PutAsync("/episerverapi/commerce/entries/{entry code}", new StringContent(json, Encoding.UTF8, "application/json")).Result.Content.ReadAsStringAsync().Result ``` ### XML response type ```csharp var model = new Entry() { Code = "Dresses-Cocktail-Silk", Catalog = "Departmental Catalog", EndDate = DateTime.UtcNow.AddDays(100), EntryType = "Product", InventoryStatus = "Enabled", IsActive = true, MetaClass = "Fashion_Product_Class", Name = "Test", StartDate = DateTime.UtcNow, MetaFields = new List() { new MetaFieldProperty() { Name = "DisplayName", Type = "ShortString", Data = new List() { new MetaFieldData() { Language="en", Value = "Dresses-Cocktail-Silk" } } } }, SeoInformation = new List() { new SeoInfo() { Description = "description", Keywords="", LanguageCode = "en", Title = "title", Uri = "Dresses-Cocktail-Silk", UriSegment = "Dresses-Cocktail-Silk" } } }; var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token.AccessToken); var serializer = new XmlSerializer(typeof(Entry)); var xml = String.Empty; using (var ms = new MemoryStream()) { serializer.Serialize(ms, model); xml = Encoding.Default.GetString(ms.ToArray()); } var result = client.PutAsync("/episerverapi/commerce/entries/{entry code}", new StringContent(xml, Encoding.UTF8, "text/xml")).Result.Content.ReadAsStringAsync().Result ``` Response ```text 204 No Content ``` ### Delete entry | DELETE | `delete/episerverapi/commerce/entries/{entryCode}` | Delete entry | | ------ | -------------------------------------------------- | ------------ | ### JSON response type ```csharp var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token.AccessToken); var result = client.DeleteAsync("/episerverapi/commerce/entries/{entry code}").Result.Content.ReadAsStringAsync().Result ``` ### XML response type ```csharp var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token.AccessToken); client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("text/xml")); var result = client.DeleteAsync("/episerverapi/commerce/entries/{entry code}").Result.Content.ReadAsStringAsync().Result ``` Response ```xml WhoKnewBaby Test 2014-08-26T13:52:07.8312797Z 2014-12-04T13:52:07.8312797Z true Fashion_Product_Class Departmental Catalog DisplayName ShortString en DisplayName title whoknew whoknew description en Product Enabled ``` ## Common draft entries nts listed below to get co Use the endpoints listed below to get common draft versions, create new common drafts, and update or delete existing drafts. ### Get common draft entry | GET | `get/episerverapi/commerce/entries/{entryCode}/commondraft/{lang}` | Get common draft entry | | --- | ------------------------------------------------------------------ | ---------------------- | ### JSON response type ```csharp var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthorizationHeaderValue("Bearer", token.AccessToken); var result = client.GetAsync("/episerverapi/commerce/entries/Code_1/commondraft/en").Result.Content.ReadAsStringAsync().Result; ``` ### XML response type ```csharp var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthorizationHeaderValue("Bearer", token.AccessToken); client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("text/xml")); var result = client.GetAsync("/episerverapi/commerce/entries/Code_1/commondraft/en").Result.Content.ReadAsStringAsync().Result; ``` Response ```xml TESTROOTCATALOG Code_1 2020-07-26T07:22:34.793Z Variation Enabled DefaultMetadataClass AnotherMultilanguageString ShortString DecimalType Decimal Testing Description Description LongString Value2 DictionaryMulti EnumMultiValue DictionarySingle DictionarySingleValue Name_1 DisplayName ShortString IntegerMetaFieldName Int AStringDictionaryMetaField StringDictionary _ExcludedCatalogEntryMarkets EnumMultiValue Name_1 /episerverapi/commerce/nodes/TESTCATALOGTNODE Code TESTCATALOGTNODE TEST CATALOG NODE CatalogNode DESCRIPTION <Uri>Uri_1</Uri> <UriSegment>name_1</UriSegment> </SeoInformation> <StartDate>2018-07-26T07:22:34.793Z</StartDate> <Variation> <MaxQuantity>50.0</MaxQuantity> <MinQuantity>5.0</MinQuantity> <TaxCategory /> <Weight>4.0</Weight> </Variation> <WarehouseInventories> <element> <Href>/episerverapi/commerce/entries/Code 1/inventories/default</Href> <Properties null="true" /> <Title>default - 10 WarehouseInventory ``` ### Create common draft entry :::hint{type="info"} **Note** The Optimizely Service API 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”. ::: | POST | `post/episerverapi/commerce/entries/commondraft/{lang}` | Create common draft entry | | ---- | ------------------------------------------------------- | ------------------------- | ### JSON response type ```csharp var _model = new DraftEntry { Code = "Code 3", Catalog = "TESTROOTCATALOG", EndDate = DateTime.UtcNow.AddDays(100), EntryType = "Variation", InventoryStatus = "Enabled", MetaClass = DefaultEntryMetaClassName, Name = "Test", StartDate = DateTime.UtcNow, MetaFields = new List { new DraftMetaFieldProperty { Name = "Description", Type = MetaDataType.LongHtmlString.ToString(), Data = "Description" }, new DraftMetaFieldProperty() { Name = "DisplayName", Type = MetaDataType.ShortString.ToString(), Data = "DisplayName" }, new DraftMetaFieldProperty { Name = "DecimalType", Type = MetaDataType.Decimal.ToString(), Data = $"{13.44.ToString(culture)}" }, new DraftMetaFieldProperty { Name = "AnotherMultilanguageString", Type = MetaDataType.ShortString.ToString(), Data = "Set with lang key EN for en" }, new DraftMetaFieldProperty { Name = "AStringDictionaryMetaField", Type = MetaDataType.StringDictionary.ToString(), Data = "Hello;world" }, new DraftMetaFieldProperty { Name = "StringList", Type = MetaDataType.LongString.ToString(), Data = "[\"Item 1\",\"Item 2\"]" }, new DraftMetaFieldProperty { Name = "IntList", Type = MetaDataType.LongString.ToString(), Data = $"[{10},{11},{12}]" }, new DraftMetaFieldProperty { Name = "DoubleList", Type = MetaDataType.LongString.ToString(), Data = $"[{100.05.ToString(culture)},{100.06.ToString(culture)},{100.07.ToString(culture)},{100.08.ToString(culture)}]" }, new DraftMetaFieldProperty { Name = "DateTimeList", Type = MetaDataType.LongString.ToString(), Data = $"[\"{DateTime.Now.ToString(culture)}\",\"{DateTime.Now.AddDays(1).ToString(culture)}\"]" } }, Variation = new VariationProperties { MaxQuantity = 100, MinQuantity = 0, TaxCategory = "", Weight = 5.1, }, Dimension = new DimensionProperties { Length= 100.34, Height = 0, Width= 5.1 } } var json = JsonConvert.SerializeObject(model); var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthorizationHeaderValue("Bearer", token.AccessToken); var result = client.PostAsync("/episerverapi/commerce/entries/commondraft/en", new StringContent(json, Encoding.UTF8, "application/json")).Result.Content.ReadAsStringAsync().Result; ``` ### XML response type ```csharp var model = new DraftEntry { Code = "Code 3", Catalog = "Departmental Catalog", EndDate = DateTime.UtcNow.AddDays(100), EntryType = "Variation", InventoryStatus = "Enabled", MetaClass = "Fashion_Item_Class", Name = "Test", StartDate = DateTime.UtcNow, MetaFields = new List { new DraftMetaFieldProperty { Name = "Description", Type = MetaDataType.LongHtmlString.ToString(), Data = "Description" }, new DraftMetaFieldProperty() { Name = "DisplayName", Type = MetaDataType.ShortString.ToString(), Data = "DisplayName" }, new DraftMetaFieldProperty { Name = "DecimalType", Type = MetaDataType.Decimal.ToString(), Data = $"{13.44.ToString(culture)}" }, new DraftMetaFieldProperty { Name = "AnotherMultilanguageString", Type = MetaDataType.ShortString.ToString(), Data = "Set with lang key EN for en" }, new DraftMetaFieldProperty { Name = "AStringDictionaryMetaField", Type = MetaDataType.StringDictionary.ToString(), Data = "Hello;world" }, new DraftMetaFieldProperty { Name = "StringList", Type = MetaDataType.LongString.ToString(), Data = "[\"Item 1\",\"Item 2\"]" }, new DraftMetaFieldProperty { Name = "IntList", Type = MetaDataType.LongString.ToString(), Data = $"[{10},{11},{12}]" }, new DraftMetaFieldProperty { Name = "DoubleList", Type = MetaDataType.LongString.ToString(), Data = $"[{100.05.ToString(culture)},{100.06.ToString(culture)},{100.07.ToString(culture)},{100.08.ToString(culture)}]" }, new DraftMetaFieldProperty { Name = "DateTimeList", Type = MetaDataType.LongString.ToString(), Data = $"[\"{DateTime.Now.ToString(culture)}\",\"{DateTime.Now.AddDays(1).ToString(culture)}\"]" } }, Variation = new VariationProperties { MaxQuantity = 100, MinQuantity = 0, TaxCategory = "", Weight = 5.1 }, Dimension = new DimensionProperties { Length= 100.34, Height = 0, Width= 5.1 } }; var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthorizationHeaderValue("Bearer", token.AccessToken);\ var serializer = new XmlSerializer(typeof(DraftEntry)); var xml = string.Empty; using (var ms = new MemoryStream()) { serializer.Serialize(ms, _model); xml = Encoding.Default.GetString(ms.ToArray()); } var result = client.PostAsync("/episerverapi/commerce/entries/commondraft/en", new StringContent(xml, Encoding.UTF8, "text/xml")).Result.Content.ReadAsStringAsync().Result; ``` Response ```xml TESTROOTCATALOG Code 3 2018-11-03T07:26:15.1234866Z Variation Enabled CustomEntryMetadataClass Description Description LongHtmlString DisplayName DisplayName ShortString 13.44 DecimalType Decimal Set with lang key EN for en AnotherMultilanguageString ShortString Hello;world AStringDictionaryMetaField StringDictionary Item 1 Item 2 StringList LongString 10 11 12 IntList LongString 100.05 100.06 100.07 100.08 DoubleList LongString 7/26/2018 2:26:15 PM 7/27/2018 2:26:15 PM DateTimeList LongString Test <Uri null="true" /> <UriSegment null="true" /> </SeoInformation> <StartDate>2018-07-26T07:26:15.1234866Z</StartDate> <Variation> <MaxQuantity>100.0</MaxQuantity> <MinQuantity>0.0</MinQuantity> <TaxCategory /> <Weight>5.1</Weight> </Variation> <WarehouseInventories /> </DraftEntry> ``` ### Update common draft entry :::hint{type="info"} **Note** 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). ::: | PUT | `put/episerverapi/commerce/entries/{entryCode}/commondraft/{lang}` | Update common draft entry | | --- | ------------------------------------------------------------------ | ------------------------- | ### JSON response type ```csharp var entryLink = ReferenceConverter.GetContentLink(“Code_1”, CatalogContentType.CatalogEntry); var entry = ContentLoader.Get<EntryContentBase>(entryLink); if (entry != null) { _model = ServiceLocator.Instance.GetInstance<EntryModelFactory>() .CreateDraftEntryModel(entry, ""); _model.Name = "Put Test"; _model.SeoInformation.Uri = "NewEntryUri"; var json = JsonConvert.SerializeObject(_model); var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthorizationHeaderValue("Bearer", token.AccessToken); var result = client.PutAsync("/episerverapi/commerce/entries/Code_1/commondraft/en", new StringContent(json, Encoding.UTF8, "application/json")).Result.Content.ReadAsStringAsync().Result; } ``` ### XML response type ```csharp var entryLink = ReferenceConverter.GetContentLink(“Code_1”, CatalogContentType.CatalogEntry); var entry = ContentLoader.Get<EntryContentBase>(entryLink); if (entry != null) { _model = ServiceLocator.Instance.GetInstance<EntryModelFactory>() .CreateDraftEntryModel(entry, ""); _model.Name = "Put Test"; _model.SeoInformation.Uri = "NewEntryUri"; var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthorizationHeaderValue("Bearer", token.AccessToken); var serializer = new XmlSerializer(typeof(DraftEntry)); var xml = string.Empty; using (var ms = new MemoryStream()) { serializer.Serialize(ms, _model); xml = Encoding.Default.GetString(ms.ToArray()); } var result = client.PutAsync("/episerverapi/commerce/entries/Code_1/commondraft/en", new StringContent(xml, Encoding.UTF8, "text/xml")).Result.Content.ReadAsStringAsync().Result; } ``` Response ```xml 204 No Content ``` ### Delete common draft entry | DELETE | `delete/episerverapi/commerce/entries/{entryCode}/commondraft/{lang}` | Delete common draft entry | | ------ | --------------------------------------------------------------------- | ------------------------- | ### JSON response type ```csharp var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthorizationHeaderValue("Bearer", token.AccessToken); var result = client.DeleteAsync("/episerverapi/commerce/entries/Code_1/commondraft/en").Result.Content.ReadAsStringAsync().Result; ``` ### XML response type ```csharp var client = new HttpClient() { BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"]) }; client.DefaultRequestHeaders.Authorization = new AuthorizationHeaderValue("Bearer", token.AccessToken); client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("text/xml")); var result = client.DeleteAsync("/episerverapi/commerce/entries/Code_1/commondraft/en").Result.Content.ReadAsStringAsync().Result; ``` Response ```xml 200 OK ``` ## Special strings and characters ### Special strings Theses properties require special values to function properly. InventoryStatus - Enabled - Disabled - Ignored EntryType - Product - Variation - Package - Bundle - DynamicPackage ### Special characters in entry code As of version 5.4.2, the Service API supports special characters (such as `/, `%`or`+\`) in the entry code for all actions (get all, get a specific, post, put, or delete) for these objects: - Catalog entry - Catalog entry association - Catalog entry relation - Catalog item asset - Catalog entry price The special characters must be double-encoded, then sent to the Service API. For example, the slash character (/) is double-encoded as **%252F**. :::hint{type="info"} **Note** Because double escaping in URLs involves security risks, it is preferable to avoid this approach. ::: To enable double-encoding support, edit the site's web.config file as shown below: ```xml <system.webServer> <security> <requestFiltering allowDoubleEscaping="true"/> </security> </system.webServer> <httpRuntime requestPathInvalidCharacters="<,>,*,&,:,\,?" /> ``` :::hint{type="info"} **Note** The characters listed after requestPathInvalidCharacters are only an example of special characters for which you can enable double-encoding support. You can modify the list as needed. :::