HCL Commerce Enterprise

ContractExport URL

This URL exports a contract to an XML file.

The file generates under the WC_instance_name/xml/trading directory.

URL structure

http:// host_name/path/
The fully qualified name of your Transaction server and the configuration path.

Parameter values

Required: The contract ID for the contract you want to export, as found in the CONTRACT database table.
Required: The name you want the contract XML file to have. If you do not specify the full path name for the XML file, the XML file will be written to the WC_eardir/xml/trading/xml directory.
Required: Use this parameter to specify the language of the descriptions in the contract you want exported. Descriptions in languages other than the language specified by this parameter will not be exported to the generated XML file.
Required: The XSD file name to use for the root element.
Use this parameter to specify the encoding of the generated XML file. If you do not specify this option, the generated XML file will be encoded using UTF-8 encoding. For a list of all supported international encodings that can be specified with this parameter, see the related topic below.
Specifies whether to include all reference numbers and timestamps when exporting the contract or not. Valid values for this parameter are true and false. Use true to include all reference numbers and timestamps. Use false to omit all reference numbers and timestamps

If this parameter is not specified, a value of true is assumed.

Required: The URL to be called when the command completes successfully.


The following example exports contractID 260369 to a UTF-8 encoded XML file in the default directory called contract260369.xml:



This URL creates an XML file from the information in the HCL Commerce database for the specified contract number.

Exception conditions

  • _ERR_CONTRACT_OBJECT_NOT_FOUND will be thrown if a contract with the specified contract ID is not found in the HCL Commerce database.
  • _ERR_UNSUPPORTED_ENCODING will be thrown if the xmlFileEncoding parameter specified is not supported.
  • _ERR_WRONG_CONTRACT_STATE will be thrown if the contract is in the DeploymentInProgress or DeploymentFailed state.