Service API

Association
Authorization
Cart
Catalog
CatalogDraft
CatalogImportExport
Customer
Entry
EntryDraft
EntryRelation
ImportExport
ItemAsset
MappedIdentity
- Gets the mapped identities by provider.get
Node
NodeDraft
NodeEntryRelation
NodeRelation
Order
PaymentPlan
Price
Task
- Returns the current processing status of a(n import) task.get
- Returns the aggregate status log of a(n import) task at the time of the request.get
Upload
Version
- Returns the current version number of the Integration Service.get
Warehouse
WarehouseInventory

Association
Cart
Catalog
CatalogDraft
CatalogImportExport
Customer
Entry
EntryDraft
EntryRelation
ImportExport
ItemAsset
MappedIdentity
- Gets the mapped identities by provider.get
Node
NodeDraft
NodeEntryRelation
NodeRelation
Order
PaymentPlan
Price
Task
- Returns the current processing status of a(n import) task.get
- Returns the aggregate status log of a(n import) task at the time of the request.get
Upload
Version
- Returns the current version number of the Integration Service.get
Warehouse
WarehouseInventory

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 http://localhost:64424/episerverapi/commerce/import/cms/site/{siteName}/{hostname}/{uploadId}/{culture}

Depends on receiving the OAuth security token to validate the session.

URL Expired

The URL for this request expired after 30 days.

Path Params

siteName

string

required

The name of the site to upload to.

hostname

string

required

The host name of the site to upload to.

uploadId

uuid

required

The upload identifier from the chunked upload commit.

culture

string

required

The culture for the specified host name. If none is set, no culture will be defined for hostname.

Responses

Response body

uuid

401

If user does not have enough permission for this request.

404

If file does not exist.

415

If the media type is not supported.

500

If error when uploading file.

Updated over 3 years ago

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

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

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url http://localhost:64424/episerverapi/commerce/import/cms/site/siteName/hostname/uploadId/culture \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 3 years ago

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

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

Service API
Service API

EPiServer.ServiceApi.Commerce 6.0.1
Association
Deletes the catalog entry association.delete
Puts the catalog entry association.put
Gets the catalog entry association.get
Posts the catalog entry association.post
Gets all the catalog entry associations.get
Authorization
/api/episerver/connect/tokenpost
/api/episerver/connect/userinfopost
/api/episerver/connect/userinfoget
/api/episerver/connect/logoutpost
/api/episerver/connect/logoutget
/api/episerver/connect/authorizepost
/api/episerver/connect/authorizeget
Cart
Creates a new cart.post
Partially updates an existing cart.patch
Updates an existing cart.put
Searches for carts with paging.get
Deletes the cart.delete
Gets a customer's cart in a specific market.get
Gets a customer's cart in a specific market.get
Catalog
Deletes the catalog.delete
Puts the catalog.put
Gets the catalog.get
Creates the catalog.post
Gets all the catalogs.get
CatalogDraft
Creates the catalog common draft.post
Deletes the catalog common draft.delete
Puts the catalog common draft.put
Gets the catalog common draft.get
CatalogImportExport
Returns the export of the specified catalog as a zip file.get
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.post
Receives a linking file for catalog items and media assets and generates the included associations.post
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
Receives a backwards-compatible catalog import file and imports the contents into Commerce.post
Customer
Creates the contact.post
Creates the organization.post
Gets all the organizations.get
Deletes the organization.delete
Updates the organization.put
Gets the organization.get
Gets the contacts, by paging.get
Gets all the contacts.get
Deletes the contact.delete
Updates the contact.put
Gets the contact.get
Entry
Creates the catalog entry.post
Deletes the catalog entry.delete
Updates the catalog entry.put
Gets the catalog entry.get
Gets all the catalog entries.get
EntryDraft
Creates the common draft catalog entry.post
Deletes the common draft catalog entry.delete
Updates the common draft catalog entry.put
Gets the common draft catalog entry.get
EntryRelation
Deletes the entry relation.delete
Puts the entry relation.put
Gets the entry relation.get
Posts the entry relation.post
Gets all the entry relations.get
ImportExport
Returns the export of the current site as a episerverdata file.get
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.post
Receives a media asset import file and imports the assets into the CMS.post
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
Receives a backwards-compatible EPISERVERDATA import file and imports the contents into the CMS asset global root as destination.post
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
Receives a backwards-compatible EPISERVERDATA import file and imports the contents into the CMS.post
ItemAsset
Deletes the catalog node item asset.delete
Puts the catalog node item asset.put
Gets the catalog node item asset.get
Posts the catalog node item asset.post
Gets the catalog node item assets.get
Deletes the catalog entry item asset.delete
Puts the catalog entry item asset.put
Gets the catalog entry item asset.get
Posts the catalog entry item asset.post
Gets all the catalog entry item assets.get
MappedIdentity
Gets the mapped identities by provider.get
Node
Creates the catalog node.post
Deletes the catalog node.delete
Puts the catalog node.put
Gets the catalog node.get
Gets all the catalog nodes.get
NodeDraft
Creates the common draft catalog node.post
Deletes the common draft catalog node.delete
Puts the common draft catalog node.put
Gets the common draft catalog node.get
NodeEntryRelation
Deletes the node entry relation.delete
Puts the node entry relation.put
Gets the node entry relation.get
Posts the node entry relation.post
Gets all the node entry relations.get
NodeRelation
Deletes the catalog node relation.delete
Puts the catalog node relation.put
Gets the catalog node relation.get
Posts the catalog node relation.post
Gets all relations where the specified catalog node is the child or the parent.get
Order
Creates an order.post
Gets purchase orders with paging.get
Searches for purchase orders with paging.get
Gets all orders of a customer.get
Deletes a specific order.delete
Partially updates a specific purchase order.patch
Updates a specific purchase order.put
Gets a specific order.get
PaymentPlan
Creates a new payment plan.post
Gets the payment plans with paging.get
Searches payment plans.get
Gets all the customer's payment plans.get
Deletes a specific payment plan.delete
Partially updates a payment plan.patch
Updates a payment plan.put
Gets a specific payment plan.get
Price
Posts the catalog entry prices.post
Deletes the catalog entry price.delete
Puts the catalog entry price.put
Gets the catalog entry price.get
Puts the catalog entry prices.put
Posts the catalog entry price.post
Gets all the catalog entry prices.get
Task
Returns the aggregate status log of a(n import) task at the time of the request.get
Returns the current processing status of a(n import) task.get
Upload
Deletes uploaded files with guid id.delete
Creates the file from the sum of the parts that were uploaded for the upload identifier. Returns the upload identifier if successful.post
Creates the file from the sum of the parts that were uploaded for the upload identifier. Returns the upload identifier if successful.get
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
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
Version
Returns the current version number of the Integration Service.get
Warehouse
Deletes the warehouse.delete
Puts the catalog entry warehouse inventory.put
Gets the specific warehouse.get
Posts the warehouse.post
Gets all the warehouses.get
WarehouseInventory
Deletes the catalog entry warehouse inventory.delete
Puts the catalog entry warehouse inventory.put
Gets the catalog entry inventory of specific warehouse.get
Posts the catalog entry warehouse inventory.post
Gets all the catalog entry warehouse inventories.get

EPiServer.ServiceApi.Commerce 5.5.0
Association
Deletes the catalog entry association.delete
Puts the catalog entry association.put
Gets the catalog entry association.get
Posts the catalog entry association.post
Gets all the catalog entry associations.get
Cart
Creates a new cart.post
Partially updates an existing cart.patch
Updates an existing cart.put
Searches for carts with paging.get
Deletes the cart.delete
Gets a customer's cart in a specific market.get
Gets a customer's cart in a specific market.get
Catalog
Deletes the catalog.delete
Puts the catalog.put
Gets the catalog.get
Creates the catalog.post
Gets all the catalogs.get
CatalogDraft
Creates the catalog common draft.post
Deletes the catalog common draft.delete
Puts the catalog common draft.put
Gets the catalog common draft.get
CatalogImportExport
Returns the export of the specified catalog as a zip file.get
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.post
Receives a linking file for catalog items and media assets and generates the included associations.post
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
Receives a backwards-compatible catalog import file and imports the contents into Commerce.post
Customer
Creates the contact.post
Creates the organization.post
Gets all the organizations.get
Deletes the organization.delete
Updates the organization.put
Gets the organization.get
Gets the contacts, by paging.get
Gets all the contacts.get
Deletes the contact.delete
Updates the contact.put
Gets the contact.get
Entry
Creates the catalog entry.post
Deletes the catalog entry.delete
Updates the catalog entry.put
Gets the catalog entry.get
Gets all the catalog entries.get
EntryDraft
Creates the common draft catalog entry.post
Deletes the common draft catalog entry.delete
Updates the common draft catalog entry.put
Gets the common draft catalog entry.get
EntryRelation
Deletes the entry relation.delete
Puts the entry relation.put
Gets the entry relation.get
Posts the entry relation.post
Gets all the entry relations.get
ImportExport
Returns the export of the current site as a episerverdata file.get
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.post
Receives a media asset import file and imports the assets into the CMS.post
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
Receives a backwards-compatible EPISERVERDATA import file and imports the contents into the CMS asset global root as destination.post
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
Receives a backwards-compatible EPISERVERDATA import file and imports the contents into the CMS.post
ItemAsset
Deletes the catalog node item asset.delete
Puts the catalog node item asset.put
Gets the catalog node item asset.get
Posts the catalog node item asset.post
Gets the catalog node item assets.get
Deletes the catalog entry item asset.delete
Puts the catalog entry item asset.put
Gets the catalog entry item asset.get
Posts the catalog entry item asset.post
Gets all the catalog entry item assets.get
MappedIdentity
Gets the mapped identities by provider.get
Node
Creates the catalog node.post
Deletes the catalog node.delete
Puts the catalog node.put
Gets the catalog node.get
Gets all the catalog nodes.get
NodeDraft
Creates the common draft catalog node.post
Deletes the common draft catalog node.delete
Puts the common draft catalog node.put
Gets the common draft catalog node.get
NodeEntryRelation
Deletes the node entry relation.delete
Puts the node entry relation.put
Gets the node entry relation.get
Posts the node entry relation.post
Gets all the node entry relations.get
NodeRelation
Deletes the catalog node relation.delete
Puts the catalog node relation.put
Gets the catalog node relation.get
Posts the catalog node relation.post
Gets all relations where the specified catalog node is the child or the parent.get
Order
Creates an order.post
Searches for purchase orders with paging.get
Gets purchase orders with paging.get
Gets all orders of a customer.get
Partially updates a specific purchase order.patch
Deletes a specific order.delete
Updates a specific purchase order.put
Gets a specific order.get
PaymentPlan
Creates a new payment plan.post
Gets the payment plans with paging.get
Searches payment plans.get
Gets all the customer's payment plans.get
Partially updates a payment plan.patch
Deletes a specific payment plan.delete
Updates a payment plan.put
Gets a specific payment plan.get
Price
Posts the catalog entry prices.post
Deletes the catalog entry price.delete
Puts the catalog entry price.put
Gets the catalog entry price.get
Posts the catalog entry price.post
Puts the catalog entry prices.put
Gets all the catalog entry prices.get
Task
Returns the aggregate status log of a(n import) task at the time of the request.get
Returns the current processing status of a(n import) task.get
Upload
Deletes uploaded files with guid id.delete
Creates the file from the sum of the parts that were uploaded for the upload identifier. Returns the upload identifier if successful.post
Creates the file from the sum of the parts that were uploaded for the upload identifier. Returns the upload identifier if successful.get
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
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
Version
Returns the current version number of the Integration Service.get
Warehouse
Deletes the warehouse.delete
Puts the catalog entry warehouse inventory.put
Gets the specific warehouse.get
Posts the warehouse.post
Gets all the warehouses.get
WarehouseInventory
Deletes the catalog entry warehouse inventory.delete
Puts the catalog entry warehouse inventory.put
Gets the catalog entry inventory of specific warehouse.get
Posts the catalog entry warehouse inventory.post
Gets all the catalog entry warehouse inventories.get

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

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.

200The Internal ID for the import task to be used with status update requests.