Personal Library

Kbid	29H737
Last Modified	23-Mar-2021
Added to KB	18-Dec-2020
Public Access	Everyone
Status	Online
Doc Type	References
Product	ICM 7.10

Reference - Batch Processes API 1.0.0

https://support.intershop.com/kb/29H737

Share this document

Product Version	7.10
Product To Version
Status	final

Download Specification

This API specification is available for download as an Open API 3.0 YAML file:

icm-batch-processes-1x0x0.yaml

References

Reference - ICM 7.10 - REST API Version Matrix

API Specification

Introduction

OpenAPI Version: 3.0.1

Processes Version: 1.0.0

This is Intershop ICM REST API documentation.

This reference lists the REST API for storefront development. The REST API covers features of both, the B2C (SMB - Small and Medium-sized businesses) and the B2B storefront development.
This reference is intended for developers who want to make use of an easy-to-use API when developing frontend solutions.
You can find more information at Intershop Communications. Contact our Intershop experts at Support - Intershop Communications

Introduction

This API is documented in OpenAPI format.

Batch Processes (Imports) API

Handles imports of various business artifacts.

/batchprocesses

GET: Returns links denoting batch process and import types

Description

This operation returns links denoting batch processes and imports that match the given type.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.TypedBatchProcessListResource.listTypes(java.lang.String,java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in query	type	string	Allows to filter for batch processes of the specified type. If no type is specified, all batch processes are displayed. \| Example: `import`
in query	subtype	string	Allows to filter for batch processes of the specified subtype. If no subtype is specified, all batch processes are displayed. \| Example: `product`

Response

200 - OK

ResourceCollectionROLinkRO application/json

/batchprocesses/catalogimports

GET: Returns catalog import process information

Description

This operation returns catalog import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in query	state	string	Only return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json

ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.

POST: Creates a catalog import process

Description

This operation creates a new catalog import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

Response

201 - Created

LinkRO application/json

/batchprocesses/catalogimports/{GenericBatchProcessResourceKey}

GET: Returns information about a catalog import process

Description

This operation returns information about a catalog import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

Request Parameters

Location	Name	Format	Description
in path	GenericBatchProcessResourceKey	string	Required \| The process id of the catalog import process \| Example: `ExampleProcessId`

Response

200 - OK

JobRO application/json

404 - Not Found

/batchprocesses/customerimports

GET: Returns customer import process information

Description

This operation returns customer import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in query	state	string	Only return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json

ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.

POST: Creates a customer import process

Description

This operation creates a new customer import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

Response

201 - Created

LinkRO application/json

/batchprocesses/customerimports/{GenericBatchProcessResourceKey}

GET: Returns information about a customer import process

Description

This operation returns information about a customer import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

Request Parameters

Location	Name	Format	Description
in path	GenericBatchProcessResourceKey	string	Required \| The process id of the customer import process \| Example: `ExampleProcessId`

Response

200 - OK

JobRO application/json

404 - Not Found

/batchprocesses/orderimports

GET: Returns order import process information

Description

This operation returns order import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in query	state	string	Only return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json

ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.

POST: Creates an order import process

Description

This operation creates a new order import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

Response

201 - Created

LinkRO application/json

/batchprocesses/orderimports/{GenericBatchProcessResourceKey}

GET: Returns information about an order import process

Description

This operation returns information about an order import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

Request Parameters

Location	Name	Format	Description
in path	GenericBatchProcessResourceKey	string	Required \| The process id of the order import process \| Example: `ExampleProcessId`

Response

200 - OK

JobRO application/json

404 - Not Found

/batchprocesses/pricelistimports

GET: Returns price list import process information

Description

This operation returns price list import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in query	state	string	Only return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json

ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.

POST: Creates a price list import process

Description

This operation creates a new price list import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

Response

201 - Created

LinkRO application/json

/batchprocesses/pricelistimports/{GenericBatchProcessResourceKey}

GET: Returns information about a price list import process

Description

This operation returns information about a price list import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

Request Parameters

Location	Name	Format	Description
in path	GenericBatchProcessResourceKey	string	Required \| The process id of the price list import process \| Example: `ExampleProcessId`

Response

200 - OK

JobRO application/json

404 - Not Found

/batchprocesses/productimports

GET: Returns product import process information

Description

This operation returns product import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in query	state	string	Only return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json

ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.

POST: Creates a product import process

Description

This operation creates a new product import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

Response

201 - Created

LinkRO application/json

/batchprocesses/productimports/{GenericBatchProcessResourceKey}

GET: Returns information about a product import process

Description

This operation returns information about a product import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

Request Parameters

Location	Name	Format	Description
in path	GenericBatchProcessResourceKey	string	Required \| The process id of the product import process \| Example: `ExampleProcessId`

Response

200 - OK

JobRO application/json

404 - Not Found

/batchprocesses/scaledpriceimports

GET: Returns scaled price import process information

Description

This operation returns scaled price import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in query	state	string	Only return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json

ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.

POST: Creates a scaled price import process

Description

This operation creates a new price import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

Response

201 - Created

LinkRO application/json

/batchprocesses/scaledpriceimports/{GenericBatchProcessResourceKey}

GET: Returns information about a scaled price import process

Description

This operation returns information about a scaled price import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

Request Parameters

Location	Name	Format	Description
in path	GenericBatchProcessResourceKey	string	Required \| The process id of the scaled price import process \| Example: `ExampleProcessId`

Response

200 - OK

JobRO application/json

404 - Not Found

/batchprocesses/userimports

GET: Returns user import process information

Description

This operation returns user import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in query	state	string	Only return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json

ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.

POST: Creates a user import process

Description

This operation creates a new user import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

Response

201 - Created

LinkRO application/json

/batchprocesses/userimports/{GenericBatchProcessResourceKey}

GET: Returns information about a user import process

Description

This operation returns information about a user import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

Request Parameters

Location	Name	Format	Description
in path	GenericBatchProcessResourceKey	string	Required \| The process id of the user import process \| Example: `ExampleProcessId`

Response

200 - OK

JobRO application/json

404 - Not Found

/batchprocesses/variationtypeimports

GET: Returns variation type import process information

Description

This operation returns variation type import processes.

Java Method

public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String)

Request Body

Request Parameters

Location	Name	Format	Description
in query	state	string	Only return jobs with this state, show all if empty.

Response

200 - OK

ResourceCollectionROLinkRO application/json

ResourceCollectionROLinkRO -> elements -> [..] -> itemId can be used as {GenericBatchProcessResourceKey} in subsequent requests. Links to item of type JobRO.

POST: Creates a variation type import process

Description

This operation creates a new variation type import process.

Java Method

public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.createProcess(com.intershop.component.rest.capi.resourceobject.ParameterRO)

Request Body

ParameterRO application/json

Request Parameters

Response

201 - Created

LinkRO application/json

/batchprocesses/variationtypeimports/{GenericBatchProcessResourceKey}

GET: Returns information about a variation type import process

Description

This operation returns information about a variation type import process

Java Method

public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo()

Request Body

Request Parameters

Location	Name	Format	Description
in path	GenericBatchProcessResourceKey	string	Required \| The process id of the variation type import process \| Example: `ExampleProcessId`

Response

200 - OK

JobRO application/json

404 - Not Found

Request and Response Object Schemata

JobRO application/json

{

"name":
string
the name of the returned element
"description":
string
"status":
string
"type":
string
Readonly | the type of the returned element
"attributes":
array
An array of ResourceAttribute objects. the list of attributes
[
ResourceAttribute: An attribute
{
- "name":
  string
  The attribute's name
- "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
- "value":
  object
  The attribute's value.
}
]
"domain":
string
"extendedStatus":
integer
Format: int32
"hostName":
string
"installationID":
string
"lastExecutionDuration":
integer
Format: int32
"lastExecutionTime":
string
Format: date-time
"login":
string
"pipelineName":
string
"serverGroup":
string
"serverName":
string
"startNodeName":
string
"process":
object
A ProcessRO object. Describes a process
{
- "name":
  string
  the name of the returned element
- "description":
  string
- "status":
  string
- "type":
  string
  Readonly | the type of the returned element
- "attributes":
  array
  An array of ResourceAttribute objects. the list of attributes
  [
  ResourceAttribute: An attribute
  {
  "name":
  string
  The attribute's name
  "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
  "value":
  object
  The attribute's value.
  }
  ]
- "domain":
  string
- "hostName":
  string
- "server":
  string
- "processType":
  string
- "progressSize":
  integer
  Format: int32
- "progressValue":
  integer
  Format: int32
- "startDate":
  string
  Format: date-time
- "endDate":
  string
  Format: date-time
- "user":
  string
- "duration":
  integer
  Format: int64
- "id":
  string
- "attribute":
  object
  A ResourceAttribute object. An attribute
  {
  - "name":
    string
    The attribute's name
  - "type":
    string
    This is a constant: ResourceAttribute | Example: ResourceAttribute
  - "value":
    object
    The attribute's value.
  }
}
"attribute":
object
A ResourceAttribute object. An attribute
{
- "name":
  string
  The attribute's name
- "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
- "value":
  object
  The attribute's value.
}

}

LinkRO application/json

{

"name":
string
the name of the returned element
"type":
string
Readonly | This is a constant: Link | Example: Link
"attributes":
array
An array of ResourceAttribute objects. the list of attributes
[
ResourceAttribute: An attribute
{
- "name":
  string
  The attribute's name
- "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
- "value":
  object
  The attribute's value.
}
]
"uri":
string
The uri
"relation":
string
The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
"title":
string
The title of the link
"description":
string
The description of the link
"itemId":
string
the Id of the linked item
"attribute":
object
A ResourceAttribute object. An attribute
{
- "name":
  string
  The attribute's name
- "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
- "value":
  object
  The attribute's value.
}

}

ParameterRO application/json

{

"name":
string
The name of the parameter.
"type":
string
Readonly | This is a constant: Parameters | Example: Parameters
"attributes":
array
An array of ResourceAttribute objects. The list of attributes
[
ResourceAttribute: An attribute
{
- "name":
  string
  The attribute's name
- "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
- "value":
  object
  The attribute's value.
}
]
"attribute":
object
A ResourceAttribute object. An attribute
{
- "name":
  string
  The attribute's name
- "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
- "value":
  object
  The attribute's value.
}

}

ResourceCollectionROLinkRO application/json

{

"pageable":
string
the pageable ID
"total":
integer
the pageable amount total | Format: int32
"offset":
integer
the pageable offset | Format: int32
"amount":
integer
the pageable amount | Format: int32
"elements":
array
An array of LinkRO objects. the list of elements
[
LinkRO: A Link pointing to a resource
{
- "name":
  string
  the name of the returned element
- "type":
  string
  Readonly | This is a constant: Link | Example: Link
- "attributes":
  array
  An array of ResourceAttribute objects. the list of attributes
  [
  ResourceAttribute: An attribute
  {
  "name":
  string
  The attribute's name
  "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
  "value":
  object
  The attribute's value.
  }
  ]
- "uri":
  string
  The uri
- "relation":
  string
  The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
- "title":
  string
  The title of the link
- "description":
  string
  The description of the link
- "itemId":
  string
  the Id of the linked item
- "attribute":
  object
  A ResourceAttribute object. An attribute
  {
  "name":
  string
  The attribute's name
  "type":
  string
  This is a constant: ResourceAttribute | Example: ResourceAttribute
  "value":
  object
  The attribute's value.
  }
}
]
"type":
string
This is a constant: ResourceCollection | Example: ResourceCollection
"sortKeys":
array
An array of string literals. the keys to sort for
"name":
string
the name of the returned element

}

Disclaimer

The 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.