openapi: 3.0.1 info: title: Processes description: "This is Intershop ICM REST API documentation. \n\nThis 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.\ \ \nThis reference is intended for developers who want to make use of an easy-to-use\ \ API when developing frontend solutions.\nYou can find more information at [Intershop\ \ Communications](https://www.intershop.com). Contact our Intershop experts at\ \ [Support - Intershop Communications](https://www.intershop.com/en/support) \ \ \n\n# Introduction\nThis API is documented in **OpenAPI format**.\n\n" version: 2.0.0 servers: - url: "/INTERSHOP/rest/{serverGroup}/{siteName}/{appUrl}" description: Intershop ICM Server variables: serverGroup: description: The server group default: WFS siteName: description: The site name default: inSPIRED-Site appUrl: description: The application URL identifier default: inTRONICS-rest enum: - inTRONICS - inTRONICS-b2c-responsive - inTRONICS-smb-responsive - inTRONICS-rest - inTRONICS_Business - inTRONICS_Business-smb-responsive - inTRONICS_Business-rest - ShoppingLive - ShoppingLive-b2c-responsive - inTRONICS-example - rest - rest-rest tags: - name: BatchProcesses description: BatchProcesses x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource - name: File Uploads description: Import file upload x-origin-class: com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileItemResource paths: /batchprocesses: get: tags: - BatchProcesses summary: Returns links denoting batch process and import types description: This operation returns links denoting batch processes and imports that match the given type. operationId: listTypes parameters: - name: type in: query description: "Allows to filter for batch processes of the specified type.\ \ If no type is specified, all batch processes are displayed." schema: type: string description: The type example: import example: import - name: subtype in: query description: "Allows to filter for batch processes of the specified subtype.\ \ If no subtype is specified, all batch processes are displayed. " schema: type: string description: "Allows to filter for batch processes of the specified subtype.\ \ If no subtype is specified, all batch processes are displayed. " example: product example: product responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO\ \ com.intershop.application.backoffice.rest.batch.internal.TypedBatchProcessListResource.listTypes(java.lang.String,java.lang.String)" x-origin-class: com.intershop.application.backoffice.rest.batch.internal.TypedBatchProcessListResource /batchprocesses/catalogimports: get: tags: - Batch Processes (Imports) summary: Returns catalog import process information description: This operation returns catalog import processes. operationId: listProcesses_7 parameters: - name: state in: query description: "Only return jobs with this state, show all if empty." schema: type: string enum: - disabled - pending - ready - running responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getJobInfo_7 parameters: GenericBatchProcessResourceKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type JobRO security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource post: tags: - Batch Processes (Imports) summary: Creates a catalog import process description: 'This operation creates a new catalog import process. ' operationId: createProcess_7 requestBody: description: "The parameters of the job, given as a map of the following values:\n\ \n- **filename**: Either an URI to an external file or the name of a file\ \ that has been created in the course of an file upload via HTTP multipart\ \ REST request in ICM unit's import/export directory before \n- **mode**:\ \ The import mode\n- **unitname**: The name of the repository to run the\ \ import\n- **targetdomainname**: The name of the repository to import the\ \ products into, if not set unitname is used\n- **locale**: The locale for\ \ the job\n- **loglevel**: The log level for the job\n- **skipValidation**:\ \ If true, skip the validation step\n- **description**: A description for\ \ the job\n\n#### Example\n```\n{\n \"filename\": \"customer_2022118T101900576_39503369.xml\"\ ,\n \"mode\": \"REPLACE\",\n \"unitname\": \"inSPIRED\",\n \"targetdomainname\"\ : \"inSPIRED-Home-Entertainment\",\n \"locale\": \"en_US\",\n \"loglevel\"\ : \"WARN\",\n \"skipValidation\": false,\n \"description\": \"Import uploaded\ \ customer import file\"\n}\n```" content: application/json: schema: $ref: '#/components/schemas/ParameterRO' text/xml: schema: $ref: '#/components/schemas/ParameterRO' responses: "201": description: Created content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource /batchprocesses/catalogimports/{GenericBatchProcessResourceKey}: get: tags: - BatchProcesses summary: Returns information about a catalog import process description: This operation returns information about a catalog import process operationId: getJobInfo_7 parameters: - name: GenericBatchProcessResourceKey in: path description: The process id of the catalog import process required: true schema: type: string description: The process id of the catalog import process example: ExampleProcessId example: ExampleProcessId x-item-key: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/JobRO' text/xml: schema: $ref: '#/components/schemas/JobRO' "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo() x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource /batchprocesses/customerimports: get: tags: - Batch Processes (Imports) summary: Returns customer import process information description: This operation returns customer import processes. operationId: listProcesses_1 parameters: - name: state in: query description: "Only return jobs with this state, show all if empty." schema: type: string enum: - disabled - pending - ready - running responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getJobInfo_1 parameters: GenericBatchProcessResourceKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type JobRO security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource post: tags: - Batch Processes (Imports) summary: Creates a customer import process description: This operation creates a new customer import process. operationId: createProcess_1 requestBody: description: "The parameters of the job, given as a map of the following values:\n\ \n- **filename**: Either an URI to an external file or the name of a file\ \ that has been created in the course of an file upload via HTTP multipart\ \ REST request in ICM unit's import/export directory before \n- **mode**:\ \ The import mode\n- **unitname**: The name of the repository to run the\ \ import\n- **targetdomainname**: The name of the repository to import the\ \ products into, if not set unitname is used\n- **locale**: The locale for\ \ the job\n- **loglevel**: The log level for the job\n- **skipValidation**:\ \ If true, skip the validation step\n- **description**: A description for\ \ the job\n\n#### Example\n```\n{\n \"filename\": \"customer_2022118T101900576_39503369.xml\"\ ,\n \"mode\": \"REPLACE\",\n \"unitname\": \"inSPIRED\",\n \"targetdomainname\"\ : \"inSPIRED-Home-Entertainment\",\n \"locale\": \"en_US\",\n \"loglevel\"\ : \"WARN\",\n \"skipValidation\": false,\n \"description\": \"Import uploaded\ \ customer import file\"\n}\n```" content: application/json: schema: $ref: '#/components/schemas/ParameterRO' text/xml: schema: $ref: '#/components/schemas/ParameterRO' responses: "201": description: Created content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource /batchprocesses/customerimports/{GenericBatchProcessResourceKey}: get: tags: - BatchProcesses summary: Returns information about a customer import process description: This operation returns information about a customer import process operationId: getJobInfo_1 parameters: - name: GenericBatchProcessResourceKey in: path description: The process id of the customer import process required: true schema: type: string description: The process id of the customer import process example: ExampleProcessId example: ExampleProcessId x-item-key: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/JobRO' text/xml: schema: $ref: '#/components/schemas/JobRO' "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo() x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource /batchprocesses/orderimports: get: tags: - Batch Processes (Imports) summary: Returns order import process information description: This operation returns order import processes. operationId: listProcesses parameters: - name: state in: query description: "Only return jobs with this state, show all if empty." schema: type: string enum: - disabled - pending - ready - running responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getJobInfo parameters: GenericBatchProcessResourceKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type JobRO security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource post: tags: - Batch Processes (Imports) summary: Creates an order import process description: This operation creates a new order import process. operationId: createProcess requestBody: description: "The parameters of the job, given as a map of the following values:\n\ \n- **filename**: Either an URI to an external file or the name of a file\ \ that has been created in the course of an file upload via HTTP multipart\ \ REST request in ICM unit's import/export directory before \n- **mode**:\ \ The import mode\n- **unitname**: The name of the repository to run the\ \ import\n- **targetdomainname**: The name of the repository to import the\ \ products into, if not set unitname is used\n- **locale**: The locale for\ \ the job\n- **loglevel**: The log level for the job\n- **skipValidation**:\ \ If true, skip the validation step\n- **description**: A description for\ \ the job\n\n#### Example\n```\n{\n \"filename\": \"customer_2022118T101900576_39503369.xml\"\ ,\n \"mode\": \"REPLACE\",\n \"unitname\": \"inSPIRED\",\n \"targetdomainname\"\ : \"inSPIRED-Home-Entertainment\",\n \"locale\": \"en_US\",\n \"loglevel\"\ : \"WARN\",\n \"skipValidation\": false,\n \"description\": \"Import uploaded\ \ customer import file\"\n}\n```" content: application/json: schema: $ref: '#/components/schemas/ParameterRO' text/xml: schema: $ref: '#/components/schemas/ParameterRO' responses: "201": description: Created content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource /batchprocesses/orderimports/{GenericBatchProcessResourceKey}: get: tags: - BatchProcesses summary: Returns information about an order import process description: This operation returns information about an order import process operationId: getJobInfo parameters: - name: GenericBatchProcessResourceKey in: path description: The process id of the order import process required: true schema: type: string description: The process id of the order import process example: ExampleProcessId example: ExampleProcessId x-item-key: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/JobRO' text/xml: schema: $ref: '#/components/schemas/JobRO' "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo() x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource /batchprocesses/pricelistimports: get: tags: - Batch Processes (Imports) summary: Returns price list import process information description: This operation returns price list import processes. operationId: listProcesses_6 parameters: - name: state in: query description: "Only return jobs with this state, show all if empty." schema: type: string enum: - disabled - pending - ready - running responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getJobInfo_6 parameters: GenericBatchProcessResourceKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type JobRO security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource post: tags: - Batch Processes (Imports) summary: Creates a price list import process description: This operation creates a new price list import process. operationId: createProcess_6 requestBody: description: "The parameters of the job, given as a map of the following values:\n\ \n- **filename**: Either an URI to an external file or the name of a file\ \ that has been created in the course of an file upload via HTTP multipart\ \ REST request in ICM unit's import/export directory before \n- **mode**:\ \ The import mode\n- **unitname**: The name of the repository to run the\ \ import\n- **targetdomainname**: The name of the repository to import the\ \ products into, if not set unitname is used\n- **locale**: The locale for\ \ the job\n- **loglevel**: The log level for the job\n- **skipValidation**:\ \ If true, skip the validation step\n- **description**: A description for\ \ the job\n\n#### Example\n```\n{\n \"filename\": \"customer_2022118T101900576_39503369.xml\"\ ,\n \"mode\": \"REPLACE\",\n \"unitname\": \"inSPIRED\",\n \"targetdomainname\"\ : \"inSPIRED-Home-Entertainment\",\n \"locale\": \"en_US\",\n \"loglevel\"\ : \"WARN\",\n \"skipValidation\": false,\n \"description\": \"Import uploaded\ \ customer import file\"\n}\n```" content: application/json: schema: $ref: '#/components/schemas/ParameterRO' text/xml: schema: $ref: '#/components/schemas/ParameterRO' responses: "201": description: Created content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource /batchprocesses/pricelistimports/{GenericBatchProcessResourceKey}: get: tags: - BatchProcesses summary: Returns information about a price list import process description: This operation returns information about a price list import process operationId: getJobInfo_6 parameters: - name: GenericBatchProcessResourceKey in: path description: The process id of the price list import process required: true schema: type: string description: The process id of the price list import process example: ExampleProcessId example: ExampleProcessId x-item-key: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/JobRO' text/xml: schema: $ref: '#/components/schemas/JobRO' "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo() x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource /batchprocesses/productimports: get: tags: - Batch Processes (Imports) summary: Returns product import process information description: This operation returns product import processes. operationId: listProcesses_2 parameters: - name: state in: query description: "Only return jobs with this state, show all if empty." schema: type: string enum: - disabled - pending - ready - running responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getJobInfo_2 parameters: GenericBatchProcessResourceKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type JobRO security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource post: tags: - Batch Processes (Imports) summary: Creates a product import process description: This operation creates a new product import process. operationId: createProcess_2 requestBody: description: "The parameters of the job, given as a map of the following values:\n\ \n- **filename**: Either an URI to an external file or the name of a file\ \ that has been created in the course of an file upload via HTTP multipart\ \ REST request in ICM unit's import/export directory before \n- **mode**:\ \ The import mode\n- **unitname**: The name of the repository to run the\ \ import\n- **targetdomainname**: The name of the repository to import the\ \ products into, if not set unitname is used\n- **locale**: The locale for\ \ the job\n- **loglevel**: The log level for the job\n- **skipValidation**:\ \ If true, skip the validation step\n- **description**: A description for\ \ the job\n\n#### Example\n```\n{\n \"filename\": \"customer_2022118T101900576_39503369.xml\"\ ,\n \"mode\": \"REPLACE\",\n \"unitname\": \"inSPIRED\",\n \"targetdomainname\"\ : \"inSPIRED-Home-Entertainment\",\n \"locale\": \"en_US\",\n \"loglevel\"\ : \"WARN\",\n \"skipValidation\": false,\n \"description\": \"Import uploaded\ \ customer import file\"\n}\n```" content: application/json: schema: $ref: '#/components/schemas/ParameterRO' text/xml: schema: $ref: '#/components/schemas/ParameterRO' responses: "201": description: Created content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource /batchprocesses/productimports/{GenericBatchProcessResourceKey}: get: tags: - BatchProcesses summary: Returns information about a product import process description: This operation returns information about a product import process operationId: getJobInfo_2 parameters: - name: GenericBatchProcessResourceKey in: path description: The process id of the product import process required: true schema: type: string description: The process id of the product import process example: ExampleProcessId example: ExampleProcessId x-item-key: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/JobRO' text/xml: schema: $ref: '#/components/schemas/JobRO' "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo() x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource /batchprocesses/scaledpriceimports: get: tags: - Batch Processes (Imports) summary: Returns scaled price import process information description: This operation returns scaled price import processes. operationId: listProcesses_5 parameters: - name: state in: query description: "Only return jobs with this state, show all if empty." schema: type: string enum: - disabled - pending - ready - running responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getJobInfo_5 parameters: GenericBatchProcessResourceKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type JobRO security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource post: tags: - Batch Processes (Imports) summary: Creates a scaled price import process description: This operation creates a new price import process. operationId: createProcess_5 requestBody: description: "The parameters of the job, given as a map of the following values:\n\ \n- **filename**: Either an URI to an external file or the name of a file\ \ that has been created in the course of an file upload via HTTP multipart\ \ REST request in ICM unit's import/export directory before \n- **mode**:\ \ The import mode\n- **unitname**: The name of the repository to run the\ \ import\n- **targetdomainname**: The name of the repository to import the\ \ products into, if not set unitname is used\n- **locale**: The locale for\ \ the job\n- **loglevel**: The log level for the job\n- **skipValidation**:\ \ If true, skip the validation step\n- **description**: A description for\ \ the job\n\n#### Example\n```\n{\n \"filename\": \"customer_2022118T101900576_39503369.xml\"\ ,\n \"mode\": \"REPLACE\",\n \"unitname\": \"inSPIRED\",\n \"targetdomainname\"\ : \"inSPIRED-Home-Entertainment\",\n \"locale\": \"en_US\",\n \"loglevel\"\ : \"WARN\",\n \"skipValidation\": false,\n \"description\": \"Import uploaded\ \ customer import file\"\n}\n```" content: application/json: schema: $ref: '#/components/schemas/ParameterRO' text/xml: schema: $ref: '#/components/schemas/ParameterRO' responses: "201": description: Created content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource /batchprocesses/scaledpriceimports/{GenericBatchProcessResourceKey}: get: tags: - BatchProcesses summary: Returns information about a scaled price import process description: This operation returns information about a scaled price import process operationId: getJobInfo_5 parameters: - name: GenericBatchProcessResourceKey in: path description: The process id of the scaled price import process required: true schema: type: string description: The process id of the scaled price import process example: ExampleProcessId example: ExampleProcessId x-item-key: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/JobRO' text/xml: schema: $ref: '#/components/schemas/JobRO' "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo() x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource /batchprocesses/uploads: get: tags: - File Uploads summary: Returns all uploaded import files. description: Returns all uploaded import files of the requested site operationId: getFiles responses: "200": description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/UploadFileRO' text/xml: schema: type: array items: $ref: '#/components/schemas/UploadFileRO' "404": description: Not found "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned at least one of the following permissions: - (SLD_IMPEX_PRODUCTS, SLD_IMPEX_CATALOGS, SLD_IMPEX_USERS, SLD_IMPEX_CONSUMERS, SLD_IMPEX_ORDERS) security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileListResource.getFiles() x-origin-class: com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileListResource post: tags: - File Uploads summary: Uploads the content of an import file. description: Uploads the content of an import file via a HTTP multipart request. The uploaded content is stored in the import/export folder of the unit of the requested site. operationId: uploadFile requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/MultipartRequest' encoding: file: contentType: text/plain responses: "200": description: File content upload was successful. content: application/json: schema: $ref: '#/components/schemas/UploadFileRO' text/xml: schema: $ref: '#/components/schemas/UploadFileRO' "404": description: Not found "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned at least one of the following permissions: - (SLD_IMPEX_PRODUCTS, SLD_IMPEX_CATALOGS, SLD_IMPEX_USERS, SLD_IMPEX_CONSUMERS, SLD_IMPEX_ORDERS) security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public com.intershop.application.backoffice.rest.batch.capi.resourceobject.UploadFileRO\ \ com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileListResource.uploadFile(java.io.InputStream,java.lang.String,java.lang.String)" x-origin-class: com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileListResource /batchprocesses/uploads/{UploadFileKey}: delete: tags: - File Uploads summary: Removes the uploaded file. description: Removes the uploaded file from the import/export directory of the requested site. operationId: deleteUploadFile parameters: - name: UploadFileKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileListResource responses: "204": description: File was successfully deleted. "404": description: Not found "401": description: Unauthorized "403": description: |- FORBIDDEN Requires authentication with user having assigned at least one of the following permissions: - (SLD_IMPEX_PRODUCTS, SLD_IMPEX_CATALOGS, SLD_IMPEX_USERS, SLD_IMPEX_CONSUMERS, SLD_IMPEX_ORDERS) security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileItemResource.deleteUploadFile() x-origin-class: com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileItemResource /batchprocesses/userimports: get: tags: - Batch Processes (Imports) summary: Returns user import process information description: This operation returns user import processes. operationId: listProcesses_3 parameters: - name: state in: query description: "Only return jobs with this state, show all if empty." schema: type: string enum: - disabled - pending - ready - running responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getJobInfo_4 parameters: GenericBatchProcessResourceKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type JobRO security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource post: tags: - Batch Processes (Imports) summary: Creates a user import process description: This operation creates a new user import process. operationId: createProcess_3 requestBody: description: "The parameters of the job, given as a map of the following values:\n\ \n- **filename**: Either an URI to an external file or the name of a file\ \ that has been created in the course of an file upload via HTTP multipart\ \ REST request in ICM unit's import/export directory before \n- **mode**:\ \ The import mode\n- **unitname**: The name of the repository to run the\ \ import\n- **targetdomainname**: The name of the repository to import the\ \ products into, if not set unitname is used\n- **locale**: The locale for\ \ the job\n- **loglevel**: The log level for the job\n- **skipValidation**:\ \ If true, skip the validation step\n- **description**: A description for\ \ the job\n\n#### Example\n```\n{\n \"filename\": \"customer_2022118T101900576_39503369.xml\"\ ,\n \"mode\": \"REPLACE\",\n \"unitname\": \"inSPIRED\",\n \"targetdomainname\"\ : \"inSPIRED-Home-Entertainment\",\n \"locale\": \"en_US\",\n \"loglevel\"\ : \"WARN\",\n \"skipValidation\": false,\n \"description\": \"Import uploaded\ \ customer import file\"\n}\n```" content: application/json: schema: $ref: '#/components/schemas/ParameterRO' text/xml: schema: $ref: '#/components/schemas/ParameterRO' responses: "201": description: Created content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource /batchprocesses/userimports/{GenericBatchProcessResourceKey}: get: tags: - BatchProcesses summary: Returns information about a user import process description: This operation returns information about a user import process operationId: getJobInfo_3 parameters: - name: GenericBatchProcessResourceKey in: path description: The process id of the user import process required: true schema: type: string description: The process id of the user import process example: ExampleProcessId example: ExampleProcessId x-item-key: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/JobRO' text/xml: schema: $ref: '#/components/schemas/JobRO' "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo() x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource /batchprocesses/variationtypeimports: get: tags: - Batch Processes (Imports) summary: Returns variation type import process information description: This operation returns variation type import processes. operationId: listProcesses_4 parameters: - name: state in: query description: "Only return jobs with this state, show all if empty." schema: type: string enum: - disabled - pending - ready - running responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getJobInfo_3 parameters: GenericBatchProcessResourceKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type JobRO security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource.listProcesses(java.lang.String) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource post: tags: - Batch Processes (Imports) summary: Creates a variation type import process description: This operation creates a new variation type import process. operationId: createProcess_4 requestBody: description: "The parameters of the job, given as a map of the following values:\n\ \n- **filename**: Either an URI to an external file or the name of a file\ \ that has been created in the course of an file upload via HTTP multipart\ \ REST request in ICM unit's import/export directory before \n- **mode**:\ \ The import mode\n- **unitname**: The name of the repository to run the\ \ import\n- **targetdomainname**: The name of the repository to import the\ \ products into, if not set unitname is used\n- **locale**: The locale for\ \ the job\n- **loglevel**: The log level for the job\n- **skipValidation**:\ \ If true, skip the validation step\n- **description**: A description for\ \ the job\n\n#### Example\n```\n{\n \"filename\": \"customer_2022118T101900576_39503369.xml\"\ ,\n \"mode\": \"REPLACE\",\n \"unitname\": \"inSPIRED\",\n \"targetdomainname\"\ : \"inSPIRED-Home-Entertainment\",\n \"locale\": \"en_US\",\n \"loglevel\"\ : \"WARN\",\n \"skipValidation\": false,\n \"description\": \"Import uploaded\ \ customer import file\"\n}\n```" content: application/json: schema: $ref: '#/components/schemas/ParameterRO' text/xml: schema: $ref: '#/components/schemas/ParameterRO' responses: "201": description: Created content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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) x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource /batchprocesses/variationtypeimports/{GenericBatchProcessResourceKey}: get: tags: - BatchProcesses summary: Returns information about a variation type import process description: This operation returns information about a variation type import process operationId: getJobInfo_4 parameters: - name: GenericBatchProcessResourceKey in: path description: The process id of the variation type import process required: true schema: type: string description: The process id of the variation type import process example: ExampleProcessId example: ExampleProcessId x-item-key: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/JobRO' text/xml: schema: $ref: '#/components/schemas/JobRO' "404": description: Not found security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.application.smc.rest.job.capi.resourceobject.JobRO com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource.getJobInfo() x-origin-class: com.intershop.application.backoffice.rest.batch.internal.GenericBatchProcessResource components: schemas: AbstractResourceObject: title: Object type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true description: The list of elements ResourceCollectionRO: type: object properties: pageable: type: string description: The pageable ID total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/AbstractResourceObject' type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of an element xml: attribute: true description: A list of ResourceObjects xml: name: ResourceCollection LinkRO: title: Link type: object properties: name: type: string description: The name of the returned element xml: attribute: true type: type: string description: "This is a constant: **Link**" readOnly: true example: Link xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' uri: type: string description: The URI relation: type: string description: The relation of the link externalDocs: description: Link Relations (www.iana.org) url: http://www.iana.org/assignments/link-relations/link-relations.xml enum: - 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 title: type: string description: The title of the link description: type: string description: The description of the link itemId: type: string description: The ID of the linked item attribute: $ref: '#/components/schemas/ResourceAttribute' description: A Link pointing to a resource xml: name: Link ResourceAttribute: title: Attribute type: object properties: name: type: string description: The attribute's name xml: attribute: true type: type: string description: "This is a constant: **ResourceAttribute**" example: ResourceAttribute xml: attribute: true value: type: object description: The attribute's value. description: An attribute xml: name: ResourceAttribute ResourceCollectionROLinkRO: title: Link List type: object properties: pageable: type: string description: The pageable ID. total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/LinkRO' type: type: string description: "This is a constant: **ResourceCollection**" example: ResourceCollection xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of the returned element xml: attribute: true description: A list of links xml: name: ResourceCollection ParameterRO: title: Parameter type: object properties: name: type: string description: The name of the parameter. xml: attribute: true type: type: string description: "This is a constant: **Parameters**" readOnly: true example: Parameters xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' attribute: $ref: '#/components/schemas/ResourceAttribute' description: A representation of a parameter value. xml: name: Parameters JobRO: title: Job type: object properties: name: type: string description: The name of the returned element xml: attribute: true description: type: string status: type: string type: type: string description: The type of the returned element readOnly: true xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' domain: type: string extendedStatus: type: integer format: int32 hostName: type: string installationID: type: string lastExecutionDuration: type: integer format: int32 lastExecutionTime: type: string format: date-time login: type: string pipelineName: type: string serverGroup: type: string serverName: type: string startNodeName: type: string process: $ref: '#/components/schemas/ProcessRO' attribute: $ref: '#/components/schemas/ResourceAttribute' description: Describes a job or schedule xml: name: Job ProcessRO: title: Process type: object properties: name: type: string description: The name of the returned element xml: attribute: true description: type: string status: type: string type: type: string description: The type of the returned element readOnly: true xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' domain: type: string hostName: type: string server: type: string processType: type: string progressSize: type: integer format: int32 progressValue: type: integer format: int32 startDate: type: string format: date-time endDate: type: string format: date-time user: type: string duration: type: integer format: int64 id: type: string attribute: $ref: '#/components/schemas/ResourceAttribute' description: Describes a process xml: name: Process UploadFileRO: title: UploadFile type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true location: type: string description: The path to the uploaded file at the server starting from the sites folder readOnly: true example: TestRestEnterprise-TestRestSalesChannel-Site/units/TestRestEnterprise-TestRestSalesChannel/impex/src/customer fileName: type: string description: "The name of the uploaded file at the server in the format:\ \ '{date}T{time}_{random_number}.{file_type_extension}'" readOnly: true example: 20220915T234133318_35887120.xml fileCreationTime: type: string description: The creation time of the uploaded file at the server format: date-time readOnly: true example: 2022-09-15T21:41:33+02:00 uri: type: string description: The URI uniquely identifying the uploaded file in REST. readOnly: true example: TestRestEnterprise-Site/TestRestSalesChannel/batchprocesses/uploads/20220915T234133318_35887120.xml description: Represents the result of a successful file upload ResourceCollectionROUploadFileRO: type: object properties: pageable: type: string description: The pageable ID total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/UploadFileRO' type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of an element xml: attribute: true description: A list of ResourceObjects xml: name: ResourceCollection MultipartRequest: required: - file - fileType - type type: object properties: file: type: string description: The content of the file to be uploaded. format: binary example: "\n\n\t\n\t\tPRIVATE\n\ \t\t\n\t\t\t\n\t\t\t\t2019-01-02T09:00:00+02:00\n\t\t\t\n\ \t\t\n\t\t\n\t\t\t\n\t\t\t\tHeimroth\n\ \t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\talexandra@test.intershop.de\n\ \t\t\t\t\t\t1930316f492bd468698e92c14ea5ee1a226270d8a711781f4e5396fb6eb98a63674a58174ae7da37\n\ \t\t\t\t\t\t\n\t\t\t\t\t\t1\n\t\t\t\t\t\t\ 547596a12d5e6dd01f710edfff2b4fd13cc4d13c9d4680494e267c31e62405c04c594371d80185db\n\ \t\t\t\t\t\t\n\t\t\t\t\t\talexandra@test.intershop.de\n\ \t\t\t\t\t\tWho was your first employer?\n\t\t\t\t\t\ \t\n\t\t\t\t\t\t2019-01-18T17:06:48+02:00\n\ \t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\ \t\t2019-01-18T17:06:48+02:00\n\t\t\t\t\ \talexandra@test.intershop.de\n\t\t\t\t\t1973-09-13\n\ \t\t\t\t\tHeimroth\n\t\t\t\t\ten_US\n\ \t\t\t\t\tAlexandra\n\t\t\t\t\tConsumer\ \ Channel Consumer\n\t\t\t\t\t1\n\ \t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\ \n\t\t\n\t\t\t\n\t\t\t\tcustomeraddr-AKhpqjoiDGmmhnRIiqeCBunDLo\n\ \t\t\t\tPotsdam\n\t\t\t\tDE\n\ \t\t\t\t14439\n\t\t\t\t4936412587\n\ \t\t\t\tHeimroth\n\t\t\t\tAlexandra\n\ \t\t\t\tWeiergasse 19\n\t\t\t\t1\n\ \t\t\t\n\t\t\t\n\t\t\t\tcustomeraddr-AreETWxrLysniLekIEUhKLKJso\n\ \t\t\t\tPotsdam\n\t\t\t\tDE\n\ \t\t\t\t14434\n\t\t\t\t4936412587\n\ \t\t\t\tHeimroth\n\t\t\t\tAlexandra\n\ \t\t\t\tRentnerstieg 12\n\t\t\t\t1\n\ \t\t\t\n\t\t\n\t\n" type: type: string description: The import type. example: Customer enum: - Catalog - Product - PriceList - ScaledPrice - VariationType - User - Customer fileType: type: string description: The file type of the import file to be uploaded. example: XML enum: - XML - CSV responses: "200": description: OK "201": description: Created "202": description: Accepted "204": description: No Content "205": description: Reset Content "206": description: Partial Content "300": description: Multiple Choices "301": description: Moved Permanently "302": description: Found "303": description: See Other "304": description: Not Modified "305": description: Use Proxy "307": description: Temporary Redirect "308": description: Permanent Redirect "400": description: Bad Request "401": description: Unauthorized "402": description: Payment Required "403": description: Forbidden "404": description: Not Found "405": description: Method Not Allowed "406": description: Not Acceptable "407": description: Proxy Authentication Required "408": description: Request Timeout "409": description: Conflict "410": description: Gone "411": description: Length Required "412": description: Precondition Failed "413": description: Request Entity Too Large "414": description: Request-URI Too Long "415": description: Unsupported Media Type "416": description: Requested Range Not Satisfiable "417": description: Expectation Failed "428": description: Precondition Required "429": description: Too Many Requests "431": description: Request Header Fields Too Large "451": description: Unavailable For Legal Reasons "500": description: Internal Server Error "501": description: Not Implemented "502": description: Bad Gateway "503": description: Service Unavailable "504": description: Gateway Timeout "505": description: HTTP Version Not Supported "511": description: Network Authentication Required parameters: loc: name: loc in: path description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using a\ \ underscore, e. g. ```en_US```." required: false style: matrix schema: type: string description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using\ \ a underscore, e. g. ```en_US```." default: en_US examples: en_US: description: English (United States) value: en_US fr_FR: description: French (France) value: fr_FR de_DE: description: German (Germany) value: de_DE x-matrixParamPath: / cur: name: cur in: path description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." required: false style: matrix schema: type: string description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." default: USD examples: FJD: description: Fiji Dollar value: FJD MXN: description: Mexican Peso value: MXN STD: description: São Tomé / Príncipe Dobra value: STD LVL: description: Latvian Lats value: LVL SCR: description: Seychelles Rupee value: SCR CDF: description: Congolese Franc value: CDF BBD: description: Barbados Dollar value: BBD GTQ: description: Guatemalan Quetzal value: GTQ CLP: description: Chilean Peso value: CLP HNL: description: Honduran Lempira value: HNL UGX: description: Ugandan Shilling value: UGX ZAR: description: South African Rand value: ZAR TND: description: Tunisian Dinar value: TND BSD: description: Bahamian Dollar value: BSD SLL: description: Sierra Leonean Leone value: SLL SDG: description: Sudanese Pound value: SDG IQD: description: Iraqi Dinar value: IQD CUP: description: Cuban Peso value: CUP GMD: description: Gambian Dalasi value: GMD TWD: description: New Taiwan Dollar value: TWD RSD: description: Serbian Dinar value: RSD ZRZ: description: Zaire value: ZRZ DOP: description: Dominican Peso value: DOP KMF: description: Comoro Franc value: KMF MYR: description: Malaysian Ringgit value: MYR FKP: description: Falkland Islands Pound value: FKP XOF: description: CFA Franc BCEAO value: XOF GEL: description: Lari value: GEL UYU: description: Uruguayan Peso value: UYU MAD: description: Moroccan Dirham value: MAD CVE: description: Cape Verde Escudo value: CVE TOP: description: Tongan Pa'anga value: TOP AZN: description: Azerbaijanian Manat value: AZN OMR: description: Omani Rial value: OMR PGK: description: Papua New Guinean Kina value: PGK KES: description: Kenyan Shilling value: KES SEK: description: Swedish Krona value: SEK BTN: description: Ngultrum value: BTN UAH: description: Ukrainian Hryvnia value: UAH GNF: description: Guinea Franc value: GNF ERN: description: Nakfa value: ERN MZN: description: Mozambican Metical value: MZN SVC: description: Salvadoran Colón value: SVC ARS: description: Argentine Peso value: ARS QAR: description: Qatari Riyal value: QAR IRR: description: Iranian Rial value: IRR NLG: description: Dutch Guilder value: NLG MRO: description: Mauritanian Ouguiya value: MRO CNY: description: Yuan Renminbi value: CNY THB: description: Thai Baht value: THB UZS: description: Uzbekistani Som value: UZS XPF: description: CFP Franc value: XPF BDT: description: Bangladeshi Taka value: BDT LYD: description: Libyan Dinar value: LYD BMD: description: Bermudian Dollar value: BMD KWD: description: Kuwaiti Dinar value: KWD PHP: description: Philippine Peso value: PHP RUB: description: Russian Ruble value: RUB PYG: description: Paraguayan Guarani value: PYG ISK: description: Iceland Krona value: ISK JMD: description: Jamaican Dollar value: JMD GWP: description: Guinea Peso value: GWP BEF: description: Belgian Franc value: BEF ESP: description: Spanish Peseta value: ESP COP: description: Colombian Peso value: COP MKD: description: Denar value: MKD USD: description: US Dollar value: USD DZD: description: Algerian Dinar value: DZD PAB: description: Panamanian Balboa value: PAB SGD: description: Singapore Dollar value: SGD ETB: description: Ethiopian Birr value: ETB KGS: description: Som value: KGS SOS: description: Somali Shilling value: SOS VEF: description: Venezuelan Bolivar Fuerte value: VEF VUV: description: Vanuatu Vatu value: VUV LAK: description: Lao Kip value: LAK BND: description: Brunei Dollar value: BND ZMK: description: Zambian Kwacha value: ZMK XAF: description: CFA Franc BEAC value: XAF LRD: description: Liberian Dollar value: LRD ATS: description: Austrian Schilling value: ATS CHF: description: Swiss Franc value: CHF HRK: description: Croatian Kuna value: HRK ITL: description: Italian Lira value: ITL ALL: description: Albanian Lek value: ALL DJF: description: Djibouti Franc value: DJF MTL: description: Maltese Lira value: MTL TZS: description: Tanzanian Shilling value: TZS VND: description: Vietnamese Dong value: VND AUD: description: Australian Dollar value: AUD ILS: description: New Israeli Sheqel value: ILS GHS: description: Ghanaian Cedi value: GHS GYD: description: Guyanese Dollar value: GYD KPW: description: North Korean Won value: KPW BOB: description: Boliviano value: BOB KHR: description: Cambodian Riel value: KHR MDL: description: Moldovan Leu value: MDL IDR: description: Indonesian Rupiah value: IDR KYD: description: Cayman Islands Dollar value: KYD AMD: description: Armenian Dram value: AMD BWP: description: Botswana Pula value: BWP SHP: description: Saint Helena Pound value: SHP TRY: description: Turkish Lira value: TRY CYP: description: Cyprus Pound value: CYP LBP: description: Lebanese Pound value: LBP TJS: description: Tajikistani Somoni value: TJS JOD: description: Jordanian Dinar value: JOD AED: description: United Arab Emirates Dirham value: AED HKD: description: Hong Kong Dollar value: HKD RWF: description: Rwanda Franc value: RWF EUR: description: Euro value: EUR LSL: description: Lesotho Loti value: LSL DKK: description: Danish Krone value: DKK CAD: description: Canadian Dollar value: CAD BGN: description: Bulgarian Lev value: BGN EEK: description: Estonian Kroon value: EEK MMK: description: Kyat value: MMK MUR: description: Mauritian Rupee value: MUR NOK: description: Norwegian Krone value: NOK SYP: description: Syrian Pound value: SYP ZWL: description: Zimbabwean Dollar value: ZWL GIP: description: Gibraltar Pound value: GIP RON: description: Romanian New Leu value: RON LKR: description: Sri Lankan Rupee value: LKR NGN: description: Nigerian Naira value: NGN CRC: description: Costa Rican Colon value: CRC CZK: description: Czech Koruna value: CZK IEP: description: Irish Pound value: IEP PKR: description: Pakistani Rupee value: PKR GRD: description: Greek Drachma value: GRD XCD: description: East Carribean Dollar value: XCD ANG: description: Netherlands Antillian Guilder value: ANG HTG: description: Haitian Gourde value: HTG BHD: description: Bahraini Dinar value: BHD SIT: description: Slovenian Tolar value: SIT PTE: description: Portuguese Escudo value: PTE BPP: description: Bonus Point Price value: BPP KZT: description: Kazakhstani Tenge value: KZT SRD: description: Surinam Dollar value: SRD SZL: description: Swazi Lilangeni value: SZL LTL: description: Lithuanian Litas value: LTL SAR: description: Saudi Riyal value: SAR TTD: description: Trinidad and Tobago Dollar value: TTD YER: description: Yemeni Rial value: YER MVR: description: Maldivian Rufiyaa value: MVR AFN: description: Afghani value: AFN BPV: description: Bonus Point Value value: BPV INR: description: Indian Rupee value: INR AWG: description: Aruban Florin value: AWG KRW: description: South Korean Won value: KRW NPR: description: Nepalese Rupee value: NPR JPY: description: Japanese Yen value: JPY MNT: description: Mongolian Tugrik value: MNT AOA: description: Angolan Kwanza value: AOA PLN: description: Polish Złoty value: PLN GBP: description: Pound Sterling value: GBP SBD: description: Solomon Islands Dollar value: SBD HUF: description: Hungarian Forint value: HUF BYR: description: Belarussian Ruble value: BYR LUF: description: Luxembourgian Franc value: LUF BIF: description: Burundi Franc value: BIF MWK: description: Malawian Kwacha value: MWK MGA: description: Malagasy Ariary value: MGA FIM: description: Finnish Mark value: FIM BZD: description: Belize Dollar value: BZD DEM: description: Deutsche Mark value: DEM BAM: description: Convertible Marks value: BAM EGP: description: Egyptian Pound value: EGP MOP: description: Macanese Pataca value: MOP NAD: description: Namibian Dollar value: NAD SKK: description: Slovakian Krona value: SKK NIO: description: Cordoba Oro value: NIO PEN: description: Peruvian Nuevo Sol value: PEN NZD: description: New Zealand Dollar value: NZD WST: description: Samoan Tala value: WST TMT: description: Turkmenistani Manat value: TMT FRF: description: French Franc value: FRF BRL: description: Brazilian Real value: BRL x-matrixParamPath: / regionals: name: regionals in: path required: false style: matrix schema: type: object properties: loc: type: string description: The locale ID example: en_US cur: type: string description: The currency code example: EUR x-matrixParamPath: / pgid: name: pgid in: path description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 spgid: name: spgid in: path description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 securitySchemes: basicAuth: type: http description: "Basic access authentication. In basic authentication, a request\ \ contains a header field in the form of authorization: ```Basic ```,\ \ where credentials is the Base64 encoding of ID and password joined by a\ \ single colon :." scheme: basic authToken: type: apiKey description: User authentication token to authenticate the request. The token is a string generated by the ICM server in the same header in every response of an REST endpoint. name: authentication-token in: header bearerAuth: type: http description: "Bearer token authentication. A request contains a header field\ \ in the form of authorization: ```Bearer ```, where is a string\ \ generated by an authentication service in response to a login request." scheme: bearer bearerFormat: JWT x-apiID: process x-origin-class: "com.intershop.component.rest.capi.resource.RootResource,com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileItemResource,com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileItemResource,com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileItemResource,com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileItemResource,com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileItemResource,com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileItemResource,com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileItemResource,com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileItemResource,com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileItemResource,com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileItemResource,com.intershop.application.backoffice.rest.batch.internal.resource.UploadFileItemResource"