This API specification is available for download as an Open API 3.0 YAML file:
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 | Description |
---|---|---|---|
in query | type | string | |
in query | subtype | string |
default - Unknown
/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 | Description |
---|---|---|---|
in query | state | string |
default - Unknown
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)
default - Unknown
/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 | Description |
---|---|---|---|
in path | GenericBatchProcessResourceKey | string | Required | The process id | Example: ExampleProcessId |
default - Unknown
/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 | Description |
---|---|---|---|
in query | state | string |
default - Unknown
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)
default - Unknown
/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 | Description |
---|---|---|---|
in path | GenericBatchProcessResourceKey | string | Required | The process id | Example: ExampleProcessId |
default - Unknown
/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 | Description |
---|---|---|---|
in query | state | string |
default - Unknown
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)
default - Unknown
/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 | Description |
---|---|---|---|
in path | GenericBatchProcessResourceKey | string | Required | The process id | Example: ExampleProcessId |
default - Unknown
/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 | Description |
---|---|---|---|
in query | state | string |
default - Unknown
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)
default - Unknown
/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 | Description |
---|---|---|---|
in path | GenericBatchProcessResourceKey | string | Required | The process id | Example: ExampleProcessId |
default - Unknown
/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 | Description |
---|---|---|---|
in query | state | string |
default - Unknown
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)
default - Unknown
/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 | Description |
---|---|---|---|
in path | GenericBatchProcessResourceKey | string | Required | The process id | Example: ExampleProcessId |
default - Unknown
/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 | Description |
---|---|---|---|
in query | state | string |
default - Unknown
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)
default - Unknown
/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 | Description |
---|---|---|---|
in path | GenericBatchProcessResourceKey | string | Required | The process id | Example: ExampleProcessId |
default - Unknown
/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 | Description |
---|---|---|---|
in query | state | string |
default - Unknown
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)
default - Unknown
/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 | Description |
---|---|---|---|
in path | GenericBatchProcessResourceKey | string | Required | The process id | Example: ExampleProcessId |
default - Unknown
/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 | Description |
---|---|---|---|
in query | state | string |
default - Unknown
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)
default - Unknown
/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 | Description |
---|---|---|---|
in path | GenericBatchProcessResourceKey | string | Required | The process id | Example: ExampleProcessId |
default - Unknown
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 forThe information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.