This API specification is available for download as an Open API 3.0 YAML file:
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
Handles imports of various business artifacts.
/batchprocesses
This operation returns links denoting batch processes and imports that match the given type.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.TypedBatchProcessListResource.listTypes(java.lang.String,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in query | type | string | import | Allows to filter for batch processes of the specified type. If no type is specified, all batch processes are displayed. | |
in query | subtype | string | product | Allows to filter for batch processes of the specified subtype. If no subtype is specified, all batch processes are displayed. |
200 - OK
/batchprocesses/catalogimports
This operation returns catalog import processes.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in query | state | string | Only return jobs with this state, show all if empty. |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {GenericBatchProcessResourceKey}
in subsequent requests. Links to item of type JobRO.This operation creates a new catalog import process.
public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)
201 - Created
/batchprocesses/catalogimports/{GenericBatchProcessResourceKey}
This operation returns information about a catalog import process
public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | GenericBatchProcessResourceKey | string | ExampleProcessId | Required | The process id of the catalog import process |
200 - OK
404 - Not Found
/batchprocesses/customerimports
This operation returns customer import processes.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in query | state | string | Only return jobs with this state, show all if empty. |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {GenericBatchProcessResourceKey}
in subsequent requests. Links to item of type JobRO.This operation creates a new customer import process.
public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)
201 - Created
/batchprocesses/customerimports/{GenericBatchProcessResourceKey}
This operation returns information about a customer import process
public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | GenericBatchProcessResourceKey | string | ExampleProcessId | Required | The process id of the customer import process |
200 - OK
404 - Not Found
/batchprocesses/orderimports
This operation returns order import processes.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in query | state | string | Only return jobs with this state, show all if empty. |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {GenericBatchProcessResourceKey}
in subsequent requests. Links to item of type JobRO.This operation creates a new order import process.
public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)
201 - Created
/batchprocesses/orderimports/{GenericBatchProcessResourceKey}
This operation returns information about an order import process
public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | GenericBatchProcessResourceKey | string | ExampleProcessId | Required | The process id of the order import process |
200 - OK
404 - Not Found
/batchprocesses/pricelistimports
This operation returns price list import processes.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in query | state | string | Only return jobs with this state, show all if empty. |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {GenericBatchProcessResourceKey}
in subsequent requests. Links to item of type JobRO.This operation creates a new price list import process.
public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)
201 - Created
/batchprocesses/pricelistimports/{GenericBatchProcessResourceKey}
This operation returns information about a price list import process
public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | GenericBatchProcessResourceKey | string | ExampleProcessId | Required | The process id of the price list import process |
200 - OK
404 - Not Found
/batchprocesses/productimports
This operation returns product import processes.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in query | state | string | Only return jobs with this state, show all if empty. |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {GenericBatchProcessResourceKey}
in subsequent requests. Links to item of type JobRO.This operation creates a new product import process.
public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)
201 - Created
/batchprocesses/productimports/{GenericBatchProcessResourceKey}
This operation returns information about a product import process
public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | GenericBatchProcessResourceKey | string | ExampleProcessId | Required | The process id of the product import process |
200 - OK
404 - Not Found
/batchprocesses/scaledpriceimports
This operation returns scaled price import processes.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in query | state | string | Only return jobs with this state, show all if empty. |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {GenericBatchProcessResourceKey}
in subsequent requests. Links to item of type JobRO.This operation creates a new price import process.
public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)
201 - Created
/batchprocesses/scaledpriceimports/{GenericBatchProcessResourceKey}
This operation returns information about a scaled price import process
public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | GenericBatchProcessResourceKey | string | ExampleProcessId | Required | The process id of the scaled price import process |
200 - OK
404 - Not Found
/batchprocesses/userimports
This operation returns user import processes.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in query | state | string | Only return jobs with this state, show all if empty. |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {GenericBatchProcessResourceKey}
in subsequent requests. Links to item of type JobRO.This operation creates a new user import process.
public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)
201 - Created
/batchprocesses/userimports/{GenericBatchProcessResourceKey}
This operation returns information about a user import process
public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | GenericBatchProcessResourceKey | string | ExampleProcessId | Required | The process id of the user import process |
200 - OK
404 - Not Found
/batchprocesses/variationtypeimports
This operation returns variation type import processes.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in query | state | string | Only return jobs with this state, show all if empty. |
200 - OK
ResourceCollectionROLinkRO -> elements -> [..] -> itemId
can be used as {GenericBatchProcessResourceKey}
in subsequent requests. Links to item of type JobRO.This operation creates a new variation type import process.
public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)
201 - Created
/batchprocesses/variationtypeimports/{GenericBatchProcessResourceKey}
This operation returns information about a variation type import process
public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | GenericBatchProcessResourceKey | string | ExampleProcessId | Required | The process id of the variation type import process |
200 - OK
404 - Not Found
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
int32
int32
date-time
ProcessRO
object. Describes a processResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
int32
int32
date-time
date-time
int64
ResourceAttribute
object. An attributeResourceAttribute
ResourceAttribute
object. An attributeResourceAttribute
Link
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
Parameters
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
ResourceAttribute
object. An attributeResourceAttribute
int32
int32
int32
LinkRO
objects. The list of elementsLinkRO
: A Link pointing to a resourceLink
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
ResourceCollection
string
literals. The keys to sort for