Share via

Inventory 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 Inventory System, known as the Inventory adapter. There are two types of Inventory adapters, the Inventory receive adapter and the Inventory send adapter, each of which is associated with different message types. This topic provides an introduction to the messages associated with each type of Inventory 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.

Inventory Receive Adapter Message Types

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

CommerceServerInventoryExport

Messages of type CommerceServerInventoryExport are one-way messages that contain Commerce Server inventory 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

CommerceServerInventoryExport

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

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

  • System schema:

    DefaultInventory.xsd (default version)

Inventory Send Adapter Message Types

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

CommerceServerInventoryQuery / CommerceServerInventoryQueryResponse

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

Note

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

Messages of type CommerceServerInventoryQueryResponse are the response messages that result from the corresponding solicit message being sent to the Commerce Server Inventory System. Such messages communicate success or failure using the context property CommerceServerCommandResults. When successful, the format of the message body of the CommerceServerInventoryQueryResponse message is the same format is as used for the CommerceServerInventoryExport message.

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

CommerceServerInventoryQuery

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

  • Adapter schema:

    InventoryQuery.xsd

CommerceServerInventoryQueryResponse

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

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

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

  • System schema:

    DefaultInventory.xsd (default version)

CommerceServerInventoryImport / CommerceServerInventoryImportResponse

Messages of type CommerceServerInventoryImport are solicit messages that contain inventory data to be imported into the Commerce Server Inventory System.

Messages of type CommerceServerInventoryImportResponse are the response messages that result from the corresponding solicit message being sent to the Commerce Server Inventory 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

CommerceServerInventoryImport

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

  • System schema:

    DefaultInventory.xsd (default version)

CommerceServerInventoryImportResponse

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

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

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

  • Successful imports:

    System schema:

    DefaultInventory.xsd (default version)

  • Unsuccessful imports:

    Adapter schema:

    InventoryResponseMessage.xsd

See Also

Other Resources

Orders Adapter Message Types

Catalog Adapter Message Types

Profiles Adapter Message Types

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

Adapter Message Types