1. Integration Guide
  2. Definitions

Definitions

This section will describe the overall format and design of the Integration XML Schema Definition (XSD) schemas for use when implementing interfaces.

The following definitions are used widely in the remainder of the document and deserve detailed explanation of their exact meaning.

  • Global element/type/attribute: This is an XSD definition which is an immediate child of the <xsd:schema> document element.
  • Local element/type/attribute: This is an XSD definition that is contained within a parent definition e.g. an element definition within a named complex type.
  • Local reference: This refers to using the 'ref=' attribute to reference a global element definition i.e. as opposed to a Local element definition.
  • Primary Document: These are the global element definitions for XML documents which can be sent as messages to and from Transportation and Global Trade Management Cloud. The main example is the Transmission.
  • Transaction interface: These are the definitions which relate to the high level business object interface e.g. for Orders, Shipments, Invoices etc. The Transmission primary document will contain one or more Transaction interface elements.