Service API 5.5

Five New Optimizely Certifications are Here! Validate your expertise and advance your career with our latest certification exams. Click here to find out more

AI OnAI Off

Home / Documentation / Class libraries / REST APIs / Service API /

Navigation [hide] [expand]

Optimizely Campaign REST API 1

Tracking

Episerver Tracking API 1.0

Track

Profile Store

Episerver Profile Store Rest API 2.0

Episerver Profile Store Rest API 1.0

Content Delivery API

Content Management API

Content Definitions API

Content Definitions API 3.0.0

Service API

Service API 5.5

EPiServer.ServiceApi.Commerce

Association

GET/episerverapi/commerce/entries/{entryCode}/associations

Gets all the catalog entry associations.

POST/episerverapi/commerce/entries/{entryCode}/associations

Posts the catalog entry association.

GET/episerverapi/commerce/entries/{entryCode}/associations/{name}

Gets the catalog entry association.

PUT/episerverapi/commerce/entries/{entryCode}/associations/{name}

Puts the catalog entry association.

DELETE/episerverapi/commerce/entries/{entryCode}/associations/{name}

Deletes the catalog entry association.

Cart

GET/episerverapi/commerce/carts/{customerId}/{cartName}/{marketId}

Gets a customer's cart in a specific market.

GET/episerverapi/commerce/carts/{customerId}/{cartName}

Gets a customer's cart in a specific market.

DELETE/episerverapi/commerce/carts/{customerId}/{cartName}

Deletes the cart.

GET/episerverapi/commerce/carts/search/{start}/{maxCount}

Searches for carts with paging.

PUT/episerverapi/commerce/carts/{cartId}

Updates an existing cart.

PATCH/episerverapi/commerce/carts/{cartId}

Partially updates an existing cart.

POST/episerverapi/commerce/carts

Creates a new cart.

Catalog

GET/episerverapi/commerce/catalogs

Gets all the catalogs.

POST/episerverapi/commerce/catalogs

Creates the catalog.

GET/episerverapi/commerce/catalogs/{catalogName}

Gets the catalog.

PUT/episerverapi/commerce/catalogs/{catalogName}

Puts the catalog.

DELETE/episerverapi/commerce/catalogs/{catalogName}

Deletes the catalog.

CatalogDraft

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

Gets the catalog common draft.

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

Puts the catalog common draft.

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

Deletes the catalog common draft.

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

Creates the catalog common draft.

CatalogImportExport

POST/episerverapi/commerce/import/catalog

Receives a backwards-compatible catalog import file and imports the contents into Commerce.

POST/episerverapi/commerce/import/catalog/{uploadId}

Receives a backwards-compatible catalog import file and imports the contents into Commerce. The file to be used is based of the upload identifier of a file previously updated using /episerverapi/commerce/import/upload/chunk and /episerverapi/commerce/import/upload/commit.

POST/episerverapi/commerce/import/links

Receives a linking file for catalog items and media assets and generates the included associations.

POST/episerverapi/commerce/import/links/{uploadId}

Receives a linking file for catalog items and media assets and generates the included associations. The file to be used is based of the upload identifier of a file previously updated using /episerverapi/commerce/import/upload/chunk and /episerverapi/commerce/import/upload/commit.

GET/episerverapi/commerce/export/catalog/{catalogName}

Returns the export of the specified catalog as a zip file.

Customer

GET/episerverapi/commerce/customers/contact/{contactId}

Gets the contact.

PUT/episerverapi/commerce/customers/contact/{contactId}

Updates the contact.

DELETE/episerverapi/commerce/customers/contact/{contactId}

Deletes the contact.

GET/episerverapi/commerce/customers/contact

Gets all the contacts.

GET/episerverapi/commerce/customers/contact/{startIndex}/{recordsToRetrieve}

Gets the contacts, by paging.

GET/episerverapi/commerce/customers/organization/{orgId}

Gets the organization.

PUT/episerverapi/commerce/customers/organization/{orgId}

Updates the organization.

DELETE/episerverapi/commerce/customers/organization/{orgId}

Deletes the organization.

GET/episerverapi/commerce/customers/organization

Gets all the organizations.

POST/episerverapi/commerce/customers/organization

Creates the organization.

POST/episerverapi/commerce/customers/contact/{userId}

Creates the contact.

Entry

GET/episerverapi/commerce/entries/{startPage}/{pageSize}

Gets all the catalog entries.

GET/episerverapi/commerce/entries/{entryCode}

Gets the catalog entry.

PUT/episerverapi/commerce/entries/{entryCode}

Updates the catalog entry.

DELETE/episerverapi/commerce/entries/{entryCode}

Deletes the catalog entry.

POST/episerverapi/commerce/entries

Creates the catalog entry.

EntryDraft

GET/episerverapi/commerce/entries/{entryCode}/commondraft/{lang}

Gets the common draft catalog entry.

PUT/episerverapi/commerce/entries/{entryCode}/commondraft/{lang}

Updates the common draft catalog entry.

DELETE/episerverapi/commerce/entries/{entryCode}/commondraft/{lang}

Deletes the common draft catalog entry.

POST/episerverapi/commerce/entries/commondraft/{lang}

Creates the common draft catalog entry.

EntryRelation

GET/episerverapi/commerce/entries/{entryCode}/entryrelations

Gets all the entry relations.

POST/episerverapi/commerce/entries/{entryCode}/entryrelations

Posts the entry relation.

GET/episerverapi/commerce/entries/{entryCode}/entryrelations/{childCode}/{relationType}

Gets the entry relation.

PUT/episerverapi/commerce/entries/{entryCode}/entryrelations/{childCode}/{relationType}

Puts the entry relation.

DELETE/episerverapi/commerce/entries/{entryCode}/entryrelations/{childCode}/{relationType}

Deletes the entry relation.

ImportExport

POST/episerverapi/commerce/import/cms/site/{siteName}/{hostname}/{culture}

Receives a backwards-compatible EPISERVERDATA import file and imports the contents into the CMS.

POST/episerverapi/commerce/import/cms/site/{siteName}/{hostname}/{uploadId}/{culture}

Receives a backwards-compatible EPISERVERDATA import file and imports the contents into the CMS. The file to be used is based of the upload identifier of a file previously updated using /episerverapi/commerce/import/upload/chunk and /episerverapi/import/upload/commit.

POST/episerverapi/commerce/import/cms/assetglobalroot

Receives a backwards-compatible EPISERVERDATA import file and imports the contents into the CMS asset global root as destination.

POST/episerverapi/commerce/import/cms/assetglobalroot/{uploadId}

Receives a backwards-compatible EPISERVERDATA import file and imports the contents into the CMS asset global root as destination. The file to be used is based of the upload identifier of a file previously updated using /episerverapi/commerce/import/upload/chunk and /episerverapi/commerce/import/upload/commit.

POST/episerverapi/commerce/import/assets

Receives a media asset import file and imports the assets into the CMS.

POST/episerverapi/commerce/import/assets/{uploadId}

Receives a media asset import file and imports the assets into the CMS The file to be used is based of the upload identifier of a file previously updated using /episerverapi/commerce/import/upload/chunk and /episerverapi/commerce/import/upload/commit.

GET/episerverapi/commerce/export/site/{siteName}

Returns the export of the current site as a episerverdata file.

ItemAsset

GET/episerverapi/commerce/entries/{entryCode}/assets

Gets all the catalog entry item assets.

POST/episerverapi/commerce/entries/{entryCode}/assets

Posts the catalog entry item asset.

GET/episerverapi/commerce/entries/{entryCode}/assets/{assetKey}/{assetType}

Gets the catalog entry item asset.

PUT/episerverapi/commerce/entries/{entryCode}/assets/{assetKey}/{assetType}

Puts the catalog entry item asset.

DELETE/episerverapi/commerce/entries/{entryCode}/assets/{assetKey}/{assetType}

Deletes the catalog entry item asset.

GET/episerverapi/commerce/nodes/{nodeCode}/assets

Gets the catalog node item assets.

POST/episerverapi/commerce/nodes/{nodeCode}/assets

Posts the catalog node item asset.

GET/episerverapi/commerce/nodes/{nodeCode}/assets/{assetKey}/{assetType}

Gets the catalog node item asset.

PUT/episerverapi/commerce/nodes/{nodeCode}/assets/{assetKey}/{assetType}

Puts the catalog node item asset.

DELETE/episerverapi/commerce/nodes/{nodeCode}/assets/{assetKey}/{assetType}

Deletes the catalog node item asset.

MappedIdentity

GET/episerverapi/commerce/identities/{providerName}

Gets the mapped identities by provider.

Node

GET/episerverapi/commerce/catalog/{catalogName}/nodes

Gets all the catalog nodes.

GET/episerverapi/commerce/nodes/{nodeCode}

Gets the catalog node.

PUT/episerverapi/commerce/nodes/{nodeCode}

Puts the catalog node.

DELETE/episerverapi/commerce/nodes/{nodeCode}

Deletes the catalog node.

POST/episerverapi/commerce/nodes

Creates the catalog node.

NodeDraft

GET/episerverapi/commerce/nodes/{nodeCode}/commondraft/{lang}

Gets the common draft catalog node.

PUT/episerverapi/commerce/nodes/{nodeCode}/commondraft/{lang}

Puts the common draft catalog node.

DELETE/episerverapi/commerce/nodes/{nodeCode}/commondraft/{lang}

Deletes the common draft catalog node.

POST/episerverapi/commerce/nodes/commondraft/{lang}

Creates the common draft catalog node.

NodeEntryRelation

GET/episerverapi/commerce/entries/{entryCode}/nodeentryrelations

Gets all the node entry relations.

POST/episerverapi/commerce/entries/{entryCode}/nodeentryrelations

Posts the node entry relation.

GET/episerverapi/commerce/entries/{entryCode}/nodeentryrelations/{nodeCode}

Gets the node entry relation.

PUT/episerverapi/commerce/entries/{entryCode}/nodeentryrelations/{nodeCode}

Puts the node entry relation.

DELETE/episerverapi/commerce/entries/{entryCode}/nodeentryrelations/{nodeCode}

Deletes the node entry relation.

NodeRelation

GET/episerverapi/commerce/nodes/{nodeCode}/noderelations

Gets all relations where the specified catalog node is the child or the parent.

POST/episerverapi/commerce/nodes/{nodeCode}/noderelations

Posts the catalog node relation.

GET/episerverapi/commerce/nodes/{nodeCode}/noderelations/{childCode}

Gets the catalog node relation.

PUT/episerverapi/commerce/nodes/{nodeCode}/noderelations/{childCode}

Puts the catalog node relation.

DELETE/episerverapi/commerce/nodes/{nodeCode}/noderelations/{childCode}

Deletes the catalog node relation.

Order

GET/episerverapi/commerce/orders/{orderGroupId}

Gets a specific order.

PUT/episerverapi/commerce/orders/{orderGroupId}

Updates a specific purchase order.

DELETE/episerverapi/commerce/orders/{orderGroupId}

Deletes a specific order.

PATCH/episerverapi/commerce/orders/{orderGroupId}

Partially updates a specific purchase order.

GET/episerverapi/commerce/orders/{customerId}/all

Gets all orders of a customer.

GET/episerverapi/commerce/orders/{start}/{maxCount}/all

Gets purchase orders with paging.

GET/episerverapi/commerce/orders/search/{start}/{maxCount}

Searches for purchase orders with paging.

POST/episerverapi/commerce/orders

Creates an order.

PaymentPlan

GET/episerverapi/commerce/paymentplans/{orderGroupId}

Gets a specific payment plan.

PUT/episerverapi/commerce/paymentplans/{orderGroupId}

Updates a payment plan.

DELETE/episerverapi/commerce/paymentplans/{orderGroupId}

Deletes a specific payment plan.

PATCH/episerverapi/commerce/paymentplans/{orderGroupId}

Partially updates a payment plan.

GET/episerverapi/commerce/paymentplans/{customerId}/all

Gets all the customer's payment plans.

GET/episerverapi/commerce/paymentplans/search/{start}/{maxCount}

Searches payment plans.

GET/episerverapi/commerce/paymentplans/{start}/{maxCount}/all

Gets the payment plans with paging.

POST/episerverapi/commerce/paymentplans

Creates a new payment plan.

Price

GET/episerverapi/commerce/entries/{entryCode}/prices

Gets all the catalog entry prices.

PUT/episerverapi/commerce/entries/{entryCode}/prices

Puts the catalog entry prices.

POST/episerverapi/commerce/entries/{entryCode}/prices

Posts the catalog entry price.

GET/episerverapi/commerce/entries/{entryCode}/prices/{priceValueId}

Gets the catalog entry price.

PUT/episerverapi/commerce/entries/{entryCode}/prices/{priceValueId}

Puts the catalog entry price.

DELETE/episerverapi/commerce/entries/{entryCode}/prices/{priceValueId}

Deletes the catalog entry price.

POST/episerverapi/commerce/entries/{entryCode}/prices/multiple

Posts the catalog entry prices.

Task

GET/episerverapi/commerce/task/{taskId}/status

Returns the current processing status of a(n import) task.

GET/episerverapi/commerce/task/{taskId}/log

Returns the aggregate status log of a(n import) task at the time of the request.

Upload

GET/episerverapi/commerce/import/upload/chunk/{uploadId}/{offset}

Sends part of file for the given upload identifier. If no upload identifier is given then it will create a new upload id. Use the offset to tell where the part of the total file starts.

PUT/episerverapi/commerce/import/upload/chunk/{uploadId}/{offset}

Sends part of file for the given upload identifier. If no upload identifier is given then it will create a new upload id. Use the offset to tell where the part of the total file starts.

GET/episerverapi/commerce/import/upload/commit/{uploadId}/{overwrite}

Creates the file from the sum of the parts that were uploaded for the upload identifier. Returns the upload identifier if successful.

POST/episerverapi/commerce/import/upload/commit/{uploadId}/{overwrite}

Creates the file from the sum of the parts that were uploaded for the upload identifier. Returns the upload identifier if successful.

DELETE/episerverapi/commerce/import/upload/{uploadId}

Deletes uploaded files with guid id.

Version

GET/episerverapi/version

Returns the current version number of the Integration Service.

Warehouse

GET/episerverapi/commerce/warehouses

Gets all the warehouses.

POST/episerverapi/commerce/warehouses

Posts the warehouse.

GET/episerverapi/commerce/warehouses/{warehouseCode}

Gets the specific warehouse.

PUT/episerverapi/commerce/warehouses/{warehouseCode}

Puts the catalog entry warehouse inventory.

DELETE/episerverapi/commerce/warehouses/{warehouseCode}

Deletes the warehouse.

WarehouseInventory

GET/episerverapi/commerce/entries/{entryCode}/inventories

Gets all the catalog entry warehouse inventories.

POST/episerverapi/commerce/entries/{entryCode}/inventories

Posts the catalog entry warehouse inventory.

GET/episerverapi/commerce/entries/{entryCode}/inventories/{warehouseCode}

Gets the catalog entry inventory of specific warehouse.

PUT/episerverapi/commerce/entries/{entryCode}/inventories/{warehouseCode}

Puts the catalog entry warehouse inventory.

DELETE/episerverapi/commerce/entries/{entryCode}/inventories/{warehouseCode}

Deletes the catalog entry warehouse inventory.

Models

EPiServer.ServiceApi.Commerce.Models.Catalog.Association

EPiServer.ServiceApi.Commerce.Models.Catalog.EntryAssociation

EPiServer.ServiceApi.Models.ResourceLink

EPiServer.ServiceApi.Models.NameValue

EPiServer.ServiceApi.Commerce.Models.Order.CartModel

EPiServer.ServiceApi.Commerce.Models.Order.OrderAddressModel

EPiServer.ServiceApi.Commerce.Models.Order.OrderFormModel

EPiServer.ServiceApi.Commerce.Models.Order.OrderNoteModel

EPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel

EPiServer.ServiceApi.Commerce.Models.Order.ShipmentModel

EPiServer.ServiceApi.Commerce.Models.Order.LineItemModel

EPiServer.ServiceApi.Commerce.Models.Order.PaymentModel

EPiServer.ServiceApi.Commerce.Models.Order.DiscountModel

EPiServer.ServiceApi.Commerce.Models.Catalog.Catalog

EPiServer.ServiceApi.Commerce.Models.Catalog.CatalogLanguage

EPiServer.ServiceApi.Commerce.Models.Catalog.DraftCatalog

EPiServer.ServiceApi.Commerce.Models.Order.ContactModel

EPiServer.ServiceApi.Commerce.Models.Order.AddressModel

EPiServer.ServiceApi.Commerce.Models.Order.OrganizationModel

EPiServer.ServiceApi.Commerce.Models.Catalog.Entries

EPiServer.ServiceApi.Commerce.Models.Catalog.Entry

EPiServer.ServiceApi.Commerce.Models.Catalog.MetaFieldProperty

EPiServer.ServiceApi.Commerce.Models.Catalog.SeoInfo

EPiServer.ServiceApi.Commerce.Models.Catalog.PublishStatus

EPiServer.ServiceApi.Commerce.Models.Catalog.VariationProperties

EPiServer.ServiceApi.Commerce.Models.Catalog.DimensionProperties

EPiServer.ServiceApi.Commerce.Models.Catalog.MetaFieldData

EPiServer.ServiceApi.Commerce.Models.Catalog.DraftEntry

EPiServer.ServiceApi.Commerce.Models.Catalog.DraftMetaFieldProperty

EPiServer.ServiceApi.Commerce.Models.Catalog.DraftSeoInfo

EPiServer.ServiceApi.Commerce.Models.Catalog.EntryRelation

EPiServer.ServiceApi.Commerce.Models.Catalog.ItemAsset

EPiServer.ServiceApi.Models.IdentityMapping

EPiServer.ServiceApi.Commerce.Models.Catalog.Node

EPiServer.ServiceApi.Commerce.Models.Catalog.DraftNode

EPiServer.ServiceApi.Commerce.Models.Catalog.NodeEntryRelation

EPiServer.ServiceApi.Commerce.Models.Catalog.NodeRelation

EPiServer.ServiceApi.Commerce.Models.Order.PurchaseOrderModel

EPiServer.ServiceApi.Commerce.Models.Order.SearchOrdersRequest

EPiServer.ServiceApi.Commerce.Models.Order.PaymentPlanModel

EPiServer.ServiceApi.Commerce.Models.Catalog.Price

EPiServer.ServiceApi.Models.JobMessage

EPiServer.ServiceApi.Models.UploadFile

EPiServer.ServiceApi.Models.ApiVersion

EPiServer.ServiceApi.Commerce.Models.Catalog.Warehouse

EPiServer.ServiceApi.Commerce.Models.Catalog.WarehouseInventory