Share via

Catalog Adapter Message Types

  • Article

For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.

Commerce Server includes a BizTalk adapter that is designed to interact with the Commerce Server Catalog System, known as the Catalog adapter. There are two types of Catalog adapters, the Catalog receive adapter and the Catalog send adapter, each of which is associated with different message types. This topic provides an introduction to the messages associated with each type of Catalog adapter.

Note

The message body schemas are identified as being either Commerce Server system schemas or adapter schemas. System schemas may need to be regenerated periodically as you change the schemas associated with the corresponding Commerce Server systems. Adapter schemas are adapter-specific and will not change unless new versions of Commerce Server adapters themselves are released and installed, and maybe not even then. For more information about generating up-to-date Commerce Server system schemas and about the complete set of schemas used by the Commerce Server adapters, see Generating and Using the XSD Files Required by Different Commerce Server Systems and Adapter Message Schemas, respectively.

Catalog Receive Adapter Message Types

The Catalog receive adapter produces a single type of message, which is used to periodically export information from the Commerce Server Catalog System.

CommerceServerCatalogExport

Messages of type CommerceServerCatalogExport are one-way messages that contain Commerce Server catalog data requested according to the configuration of the corresponding receive location.

The following table shows context properties and message body schemas that are associated with this one-way message.

Message type

Context properties

Message body schema

CommerceServerCatalogExport

  • CommerceServerMessageType. Written and promoted by the Catalog receive adapter.

  • Sitename. If configured, written and promoted by the Catalog receive adapter.

  • System schema:

    DefaultCatalog.xsd (default version)

Catalog Send Adapter Message Types

The Catalog send adapter processes several distinct pairs of solicit/response messages, which are used to retrieve information from the Commerce Server Catalog System.

CommerceServerCatalogQuery / CommerceServerCatalogQueryResponse

Messages of type CommerceServerCatalogQuery are solicit messages that contain an arbitrary query of the Commerce Server Catalog System.

Note

CommerceServerCatalogQuery messages do not support querying more than one catalog. The ProductCatalog attribute of the CommerceServerCatalogQuery element must specify a single product catalog name, and not a comma-separated list of multiple product catalog names.

Messages of type CommerceServerCatalogQueryResponse are the response messages that result from the corresponding solicit message being sent to the Commerce Server Catalog System. Such messages communicate success or failure using the context property CommerceServerCommandResults.

The following table shows context properties and message body schemas that are associated with this solicit/response message pair.

Message type

Context properties

Message body schemas

CommerceServerCatalogQuery

  • CommerceServerMessageType. Must be present if the endpoint transport property Endpoint Message Type is set to From Context.

  • Adapter schema:

    CatalogQuery.xsd

CommerceServerCatalogQueryResponse

  • CommerceServerMessageType. Written and promoted by the Catalog send adapter.

  • CommerceServerCommandResults. Written and promoted by the Catalog send adapter.

  • Sitename. If configured, written and promoted by the Catalog send adapter.

  • System schema:

    DefaultCatalog.xsd (default version)

CommerceServerCatalogImport / CommerceServerCatalogImportResponse

Messages of type CommerceServerCatalogImport are solicit messages that contain catalog data to be imported into the Commerce Server Catalog System.

Aa544840.alert_caution(en-US,CS.70).gifImportant Note:

Imported catalogs can present a security risk. Catalog display names and text-type custom properties may contain HTML markup, which may contain malicious script. To avoid importing malicious script, use the authentication and authorization features available in Commerce Server to validate the sources from which you are importing your catalog data.

Messages of type CommerceServerCatalogImportResponse are the response messages that result from the corresponding solicit message being sent to the Commerce Server Catalog System. Such messages communicate success or failure using the context property CommerceServerCommandResults.

The following table shows context properties and message body schemas that are associated with this solicit/response message pair.

Message type

Context properties

Message body schemas

CommerceServerCatalogImport

  • CommerceServerMessageType. Must be present if the endpoint transport property Endpoint Message Type is set to From Context.

  • System schema:

    DefaultCatalog.xsd (default version)

CommerceServerCatalogImportResponse

  • CommerceServerMessageType. Written and promoted by the Catalog send adapter.

  • CommerceServerCommandResults. Written and promoted by the Catalog send adapter.

  • Sitename. If configured, written and promoted by the Catalog send adapter.

  • Successful imports:

    System schema:

    DefaultCatalog.xsd (default version)

  • Unsuccessful imports:

    Adapter schema:

    CatalogResponseMessage.xsd

See Also

Other Resources

Orders Adapter Message Types

Inventory Adapter Message Types

Profiles Adapter Message Types

Generating and Using the XSD Files Required by Different Commerce Server Systems

Adapter Message Types