{ "openapi": "3.0.1", "info": { "title": "Data Extract", "description": "Provide APIs related to data extraction", "version": "9.1.20.0", "x-introduced": "9.1.0.0" }, "servers": [ { "url": "https://{hostname}:{port}/wcs/resources", "variables": { "port": { "default": "443", "enum": [ "443", "5443" ] }, "hostname": { "default": "localhost", "enum": [ "localhost", "test.hcl.com" ] } } } ], "externalDocs": { "description": "Some REST services require authentication. HCL Commerce REST services are authenticated on secure and unsecured channels. This authentication can include the use of the WCToken and WCTrustedToken. To use REST services that require authentication, you must first get authentication data by using a supported identity services.\n\nAfter you obtain the authentication data, you must pass either the WCToken or WCTustedToken parameters, or both, within the HTTP header for every request that requires authentication. If a request is sent over HTTP, pass the WCToken parameter in the HTTP header. Do not pass the WCTrustedToken in HTTP requests, as the parameter value might display. Send both the WCToken and the WCTrustedToken parameters when the request is being sent over HTTPS.\n\nThe HCL Commerce REST APIs can also use session cookies that are created by the HCL Commerce store runtime for authentication. These cookies allow you to mix requests to the HCL Commerce REST APIs and the HCL Commerce store runtime within the same user session.\n\n", "url": "https://help.hcltechsw.com/commerce/9.1.0/webservices/concepts/cwvrestauth.html?hl=rest%2Cauthentication" }, "tags": [ { "name": "Catalog", "description": "Provides RESTful services to get all catalogs for a store. It uses the Catalog noun." }, { "name": "Catalog Export", "description": "Provides RESTful service to create a catalog export job to retrieve all categories with hierarchy or all products for a store." }, { "name": "Catalog Download", "description": "Provides RESTful service to download a catalog export file based on the export ID." }, { "name": "Order Download", "description": "Provides RESTful service to download an order export file based on the export ID." }, { "name": "Order Export", "description": "Provides RESTful service to create an order export job to retrieve orders for a store." } ], "paths": { "/store/{storeId}/order_export": { "post": { "tags": [ "Order Export" ], "summary": "Exports orders for a store.", "operationId": "exportOrders", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" }, "example": "1" } ], "requestBody": { "description": "Specify parameters in the body in JSON format. For example, you can specify the order status, and the number of days to set back for the time placed of the order.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.order.handler.OrderExportHandler-OrderExportRequest" } } }, "required": true }, "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.order.handler.OrderExportHandler-OrderExportResponse" }, "example": { "exportId": "10001" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.order.handler.OrderExportHandler-OrderExportResponse" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.order.handler.OrderExportHandler-OrderExportResponse" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.order.handler.OrderExportHandler-OrderExportResponse" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request aren't valid.", "content": {} }, "401": { "description": "Not authenticated. The user session isn't valid.", "content": {} }, "403": { "description": "The user isn't authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource couldn't be found.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/store/{storeId}/catalog": { "get": { "tags": [ "Catalog" ], "summary": "Get all the catalogs of a store by store id.", "operationId": "findByStoreId", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "langId", "in": "query", "description": "Language identifier. If not specified, the \"locale\" parameter will be used. If \"locale\" isn't specified, then the store default language shall be used.", "schema": { "type": "string" }, "example": "-1" }, { "name": "profileName", "in": "query", "description": "Profile name. Profiles determine the subset of data to be returned by a query.", "schema": { "type": "string", "enum": [ "IBM_Admin_Summary", "IBM_Admin_Details" ] } }, { "name": "pageNumber", "in": "query", "description": "Page number, starting at 1. Valid values include positive integers of 1 and above. The \"pageSize\" must be specified for paging to work.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The \"pageNumber\" must be specified for paging to work.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details" } }, "application/atom+xml": { "schema": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request aren't valid.", "content": {} }, "401": { "description": "Not authenticated. The user session isn't valid.", "content": {} }, "403": { "description": "The user isn't authorized to perform the specified request.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } } } }, "/store/{storeId}/catalog_export/{objectType}": { "post": { "tags": [ "Catalog Export" ], "summary": "Exports all categories or all products for a store.", "operationId": "exportCatalogForObjectType", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "objectType", "in": "path", "description": "Specify the object type to export. Specify Category to export all categories and specify Product to export all products.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Specify optional parameters in the body in JSON format. For example, you can specify exportMode, catalogId, langId and CSVColumnList in the body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.catalog.handler.CatalogExportHandler-CatalogExportRequest" } } }, "required": false }, "responses": { "200": { "description": "The requested completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.catalog.handler.CatalogExportHandler-CatalogExportResponse" }, "example": { "exportId": "10001" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.catalog.handler.CatalogExportHandler-CatalogExportResponse" } }, "application/xhtml+xml": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.catalog.handler.CatalogExportHandler-CatalogExportResponse" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/com.ibm.commerce.rest.catalog.handler.CatalogExportHandler-CatalogExportResponse" } } } }, "400": { "description": "Bad request. Some of the inputs provided to the request aren't valid.", "content": {} }, "401": { "description": "Not authenticated. The user session isn't valid.", "content": {} }, "403": { "description": "The user isn't authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource couldn't be found.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } }, "x-codegen-request-body-name": "body" } }, "/store/{storeId}/catalog_download/byExportId/{exportId}": { "get": { "tags": [ "Catalog Download" ], "summary": "Download a catalog export file by export ID.", "operationId": "downloadByExportId", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "exportId", "in": "path", "description": "The export ID from the catalog export REST API call.", "required": true, "schema": { "type": "string" } }, { "name": "deleted", "in": "query", "description": "The optional deleted flag. The value can be true or false. The default is false if it is not specified. If it is true, the file downloaded will only contains the deleted objects since last export.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested completed successfully.", "content": {} }, "400": { "description": "Bad request. Some of the inputs provided to the request aren't valid.", "content": {} }, "401": { "description": "Not authenticated. The user session isn't valid.", "content": {} }, "403": { "description": "The user isn't authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource couldn't be found.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } } } }, "/store/{storeId}/order_download/byExportId/{exportId}": { "get": { "tags": [ "Order Download" ], "summary": "Download an order export file by export ID.", "parameters": [ { "name": "storeId", "in": "path", "description": "The store identifier.", "required": true, "schema": { "type": "string" }, "example": "1" }, { "name": "exportId", "in": "path", "description": "The export ID from the order export REST API call.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The requested completed successfully.", "content": {} }, "400": { "description": "Bad request. Some of the inputs provided to the request aren't valid.", "content": {} }, "401": { "description": "Not authenticated. The user session isn't valid.", "content": {} }, "403": { "description": "The user isn't authorized to perform the specified request.", "content": {} }, "404": { "description": "The specified resource couldn't be found.", "content": {} }, "500": { "description": "Internal server error. Additional details will be contained on the server logs.", "content": {} } } } } }, "components": { "schemas": { "catalog-IBM_Admin_Details_item.attachmentReference.attachmentAsset.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentAsset.userData.userDataField" } } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentIdentifier.externalIdentifier" } } }, "catalog-IBM_Admin_Details_item": { "required": [ "catalogIdentifier" ], "type": "object", "properties": { "description": { "type": "array", "items": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.description" } }, "default": { "type": "boolean" }, "primary": { "type": "boolean" }, "catalogId": { "type": "string" }, "attachmentReference": { "type": "array", "items": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference" } }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attributes" } }, "catalogIdentifier": { "type": "string" } } }, "catalog-IBM_Admin_Details_item.attributes": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.rest.order.handler.OrderExportHandler-OrderExportRequest": { "required": [ "timePlacedInDays" ], "type": "object", "properties": { "status": { "type": "string", "description": "A list of order status to be included in the export. This is the status of the order, not the status of the individual order item within the order. The default is null which does not consider the order status." }, "timePlacedInDays": { "type": "string", "description": "The number of days to set back for the time placed of the order. 0 means exporting all the orders for today, 1 means exporting all the orders starting from yesterday, 2 means 2 days ago until now." } }, "example": { "status": "M", "timePlacedInDays": "2" } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentIdentifier.externalIdentifier.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentReferenceDescription": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentReferenceDescription.userData" }, "shortDescription": { "type": "string" }, "name": { "type": "string" }, "language": { "type": "string" }, "longDescription": { "type": "string" } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentUsage.attachmentUsageDescription.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.rest.catalog.handler.CatalogExportHandler-CatalogExportResponse": { "required": [ "exportId" ], "type": "object", "properties": { "exportId": { "type": "string", "description": "Export ID returned from the catalog export. It can be used in the catalog download REST API." } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentDescription": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentDescription.userData" }, "shortDescription": { "type": "string" }, "name": { "type": "string" }, "language": { "type": "string" }, "longDescription": { "type": "string" } } }, "Empty": { "type": "object", "description": "Empty model. Used as default value when no model is specified." }, "catalog-IBM_Admin_Details_item.attachmentReference.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "catalog-IBM_Admin_Details_item.description.attributes": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "com.ibm.commerce.rest.catalog.handler.CatalogExportHandler-CatalogExportRequest": { "type": "object", "properties": { "langId": { "type": "string", "description": "The ID of the language for the description to be exported. The default is the store default language if it is not specified." }, "catalogId": { "type": "string", "description": "The ID of the catalog to be exported. The default is the store master catalog if it is not specified." }, "exportMode": { "type": "string", "description": "Export mode can be full or delta. The default is full if it is not specified." }, "CSVColumnList": { "type": "string", "description": "A list of CSV columns to be exported. The default is to export all columns configured if it is not specified." } }, "example": { "langId": "-1", "catalogId": "10502", "exportMode": "delta", "CSVColumnList": "name" } }, "catalog-IBM_Admin_Details_item.description.override.descriptionOverrideIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" } } }, "catalog-IBM_Admin_Details_item.attachmentReference": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.userData" }, "attachmentIdentifier": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentIdentifier" }, "attachmentReferenceIdentifier": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentReferenceIdentifier" }, "displaySequence": { "type": "string" }, "attachmentReferenceDescription": { "type": "array", "items": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentReferenceDescription" } }, "attachmentAsset": { "type": "array", "items": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentAsset" } }, "attachmentDescription": { "type": "array", "items": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentDescription" } }, "attachmentUsage": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentUsage" } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentReferenceIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentIdentifier.externalIdentifier": { "required": [ "identifier" ], "type": "object", "properties": { "ownerID": { "type": "string" }, "identifier": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentIdentifier.externalIdentifier.storeIdentifier" } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentReferenceDescription.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentReferenceDescription.userData.userDataField" } } } }, "catalog-IBM_Admin_Details_item.description": { "type": "object", "properties": { "keyword": { "type": "string" }, "language": { "type": "string" }, "fullImage": { "type": "string" }, "longDescription": { "type": "string" }, "breadcrumb": { "type": "array", "items": { "type": "string" } }, "override": { "type": "array", "items": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.description.override" } }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.description.attributes" } }, "shortDescription": { "type": "string" }, "thumbnail": { "type": "string" }, "name": { "type": "string" } } }, "catalog-IBM_Admin_Details": { "type": "object", "properties": { "recordSetCount": { "type": "integer", "format": "int64" }, "recordSetComplete": { "type": "boolean" }, "recordSetStartNumber": { "type": "integer", "format": "int64" }, "resultList": { "type": "array", "items": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item" } }, "recordSetTotal": { "type": "integer", "format": "int64" } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentAsset.storeIdentifier.externalIdentifier": { "type": "object", "properties": { "ownerID": { "type": "string" }, "nameIdentifier": { "type": "string" } } }, "catalog-IBM_Admin_Details_item.attachmentReference.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.userData.userDataField" } } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentAsset.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentUsage": { "required": [ "usageName" ], "type": "object", "properties": { "displaySequence": { "type": "string" }, "attachmentUsageDescription": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentUsage.attachmentUsageDescription" }, "image": { "type": "string" }, "usageName": { "type": "string" } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentUsage.attachmentUsageDescription": { "type": "object", "properties": { "userData": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentUsage.attachmentUsageDescription.userData" }, "shortDescription": { "type": "string" }, "name": { "type": "string" }, "language": { "type": "string" }, "longDescription": { "type": "string" } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentUsage.attachmentUsageDescription.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentUsage.attachmentUsageDescription.userData.userDataField" } } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentIdentifier.externalIdentifier.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentIdentifier.externalIdentifier.storeIdentifier.externalIdentifier" } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentAsset": { "required": [ "attachmentAssetPath" ], "type": "object", "properties": { "mimeType": { "type": "string" }, "attachmentAssetIdentifier": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentAsset.attachmentAssetIdentifier" }, "rootDirectory": { "type": "string" }, "language": { "type": "array", "items": { "type": "string" } }, "directoryPath": { "type": "string" }, "storeIdentifier": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentAsset.storeIdentifier" }, "localAsset": { "type": "boolean" }, "userData": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentAsset.userData" }, "attachmentAssetPath": { "type": "string" } } }, "catalog-IBM_Admin_Details_item.description.override": { "type": "object", "properties": { "name": { "type": "string" }, "keyword": { "type": "string" }, "fullImage": { "type": "string" }, "longDescription": { "type": "string" }, "descriptionOverrideIdentifier": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.description.override.descriptionOverrideIdentifier" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.description.override.attributes" } }, "shortDescription": { "type": "string" }, "thumbnail": { "type": "string" } } }, "catalog-IBM_Admin_Details_item.description.override.attributes": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentAsset.storeIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" }, "externalIdentifier": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentAsset.storeIdentifier.externalIdentifier" } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentDescription.userData": { "type": "object", "properties": { "userDataField": { "type": "array", "items": { "$ref": "#/components/schemas/catalog-IBM_Admin_Details_item.attachmentReference.attachmentDescription.userData.userDataField" } } } }, "com.ibm.commerce.rest.order.handler.OrderExportHandler-OrderExportResponse": { "required": [ "exportId" ], "type": "object", "properties": { "exportId": { "type": "string", "description": "Export ID returned from the order export. It can be used in the order download REST API." } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentDescription.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentAsset.attachmentAssetIdentifier": { "type": "object", "properties": { "uniqueID": { "type": "string" } } }, "catalog-IBM_Admin_Details_item.attachmentReference.attachmentReferenceDescription.userData.userDataField": { "required": [ "key" ], "type": "object", "properties": { "value": { "type": "string" }, "key": { "type": "string" } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ], "x-aes-documentation": { "gettingstarted": [ { "content": "HCL Commerce REST services support JSON and XML formats for input and output data by default. The default format is JSON. When an XML String is sent to a REST service, you must set Content-Type HTTP header to be \"application/xml\". The REST service converts the XML input data to the JSON format that is accepted by REST services. Therefore, your input XML format must follow a certain structure so that it can be transformed to the JSON object that is accepted by REST services. See more here: ", "codeSnippets": [], "name": "Response formats" }, { "content": "Preview tokens are encrypted strings that encapsulates a set of preview options and restrictions on when and where the token can be used. Any user who is authorized to access your server and has a preview token, can complete preview actions in the same store for which that token is generated. See more here: ", "codeSnippets": [], "name": "Preview tokens" }, { "content": "Some HCL Commerce REST services require a request to be sent over HTTPS. Learn more here: ", "codeSnippets": [], "name": "Secure Sockets Layer" } ] } }