Showing:

Annotations
Attributes
Diagrams
Facets
Instances
Used by

Table of Contents

Group by:
Main schema DeliveryAddress.xsd
[ top ]
Included schema CommonElements.xsd
[ top ]
Element DeliveryAddressListSubmit
Diagram
Diagram DeliveryAddress.tmp#CommonAttributes DeliveryAddress.tmp#DeliveryAddresses DeliveryAddress.tmp#Errors
Instance
<DeliveryAddressListSubmit Culture="en" EndTime="" ErrorCount="0" LoadFilter="" LoadType="" SiteID="" StartTime="" StatusID="" TransactionID="" Transformed="false" Version="">
  <DeliveryAddresses Version="">{1,1}</DeliveryAddresses>
  <Errors>{0,1}</Errors>
</DeliveryAddressListSubmit>
Attributes
QName Type Default Use Annotation
Culture xs:string en optional
EndTime xs:dateTime optional
ErrorCount xs:integer 0 optional
LoadFilter xs:string optional
LoadFilter must indicate the Entity Type.  Only one Entity Type per file is allowed. i.e. “Product”
LoadType xs:string required
FULL, FULLBranch, or PARTIAL
Note: partial loads require each record to explicitly declare if it is deprecated or not.  Full loads assume anything not in the load is deprecated.
SiteID xs:string optional
StartTime xs:dateTime optional
StatusID xs:integer optional
TransactionID xs:string optional
Transformed xs:boolean false optional
Version xs:decimal required
[ top ]
Element DeliveryAddresses
Diagram
Diagram DeliveryAddress.tmp#DeliveryAddresses_Version DeliveryAddress.tmp#DeliveryAddress
Used by
Instance
<DeliveryAddresses Version="">
  <DeliveryAddress Deprecated="" Version="">{0,unbounded}</DeliveryAddress>
</DeliveryAddresses>
Attributes
QName Type Use
Version xs:decimal optional
[ top ]
Element DeliveryAddress
Diagram
Diagram DeliveryAddress.tmp#DeliveryAddress_Version DeliveryAddress.tmp#DeliveryAddress_Deprecated DeliveryAddress.tmp#DeliveryAddress_AccountCode DeliveryAddress.tmp#Address DeliveryAddress.tmp#DeliveryAddress_DeliveryRegion DeliveryAddress.tmp#DeliveryAddress_DeliveryRuns DeliveryAddress.tmp#RestrictionList DeliveryAddress.tmp#DeliveryAddress_ShipToAccountChargeCode DeliveryAddress.tmp#DeliveryAddress_ShipToNotes DeliveryAddress.tmp#DeliveryAddress_ShipToCode DeliveryAddress.tmp#Attributes DeliveryAddress.tmp#DeliveryAddress_TypeID
Used by
Instance
<DeliveryAddress Deprecated="" Version="">
  <AccountCode>{1,1}</AccountCode>
  <Address Type="" Version="">{1,1}</Address>
  <DeliveryRegion>{0,1}</DeliveryRegion>
  <DeliveryRuns>{0,1}</DeliveryRuns>
  <RestrictionList>{0,1}</RestrictionList>
  <ShipToAccountChargeCode>{0,1}</ShipToAccountChargeCode>
  <ShipToNotes>{0,1}</ShipToNotes>
  <ShipToCode>{0,1}</ShipToCode>
  <Attributes Version="">{0,1}</Attributes>
  <TypeID>{0,1}</TypeID>
</DeliveryAddress>
Attributes
QName Type Use
Deprecated xs:boolean optional
Version xs:decimal optional
[ top ]
Element DeliveryAddress / AccountCode
Annotations
Related Customer Account Code for the Address
Diagram
Diagram
Facets
maxLength 36
[ top ]
Element Address
Annotations
Generic Address Element
Diagram
Diagram DeliveryAddress.tmp#Address_Type DeliveryAddress.tmp#Address_Version DeliveryAddress.tmp#Address_Name DeliveryAddress.tmp#Address_Street1 DeliveryAddress.tmp#Address_Street2 DeliveryAddress.tmp#Address_Suburb DeliveryAddress.tmp#Address_City DeliveryAddress.tmp#Address_Area DeliveryAddress.tmp#Address_State DeliveryAddress.tmp#Address_Country DeliveryAddress.tmp#Address_Other DeliveryAddress.tmp#Address_PostCode DeliveryAddress.tmp#Address_GeoRef DeliveryAddress.tmp#Address_Phone DeliveryAddress.tmp#Address_Fax DeliveryAddress.tmp#Address_Email DeliveryAddress.tmp#Address_Social DeliveryAddress.tmp#Address_Notes DeliveryAddress.tmp#Address_TimeZone DeliveryAddress.tmp#Address_TimeZoneName
Used by
Element DeliveryAddress
Instance
<Address Type="" Version="">
  <Name>{1,1}</Name>
  <Street1>{1,1}</Street1>
  <Street2>{1,1}</Street2>
  <Suburb>{0,1}</Suburb>
  <City>{1,1}</City>
  <Area>{0,1}</Area>
  <State>{0,1}</State>
  <Country>{0,1}</Country>
  <Other>{0,1}</Other>
  <PostCode>{1,1}</PostCode>
  <GeoRef>{0,1}</GeoRef>
  <Phone>{0,1}</Phone>
  <Fax>{0,1}</Fax>
  <Email>{0,1}</Email>
  <Social>{0,1}</Social>
  <Notes>{0,1}</Notes>
  <TimeZone>{0,1}</TimeZone>
  <TimeZoneName>{0,1}</TimeZoneName>
</Address>
Attributes
QName Type Use
Type restriction of xs:string optional
Version xs:decimal optional
[ top ]
Element Address / Name
Diagram
Diagram
Facets
maxLength 100
[ top ]
Element Address / Street1
Diagram
Diagram
Facets
maxLength 100
[ top ]
Element Address / Street2
Diagram
Diagram
Facets
maxLength 100
[ top ]
Element Address / Suburb
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / City
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / Area
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / State
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / Country
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / Other
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / PostCode
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / GeoRef
Diagram
Diagram DeliveryAddress.tmp#Address_Address_GeoRef_Lat DeliveryAddress.tmp#Address_Address_GeoRef_Long
Instance
<GeoRef>
  <Lat>{1,1}</Lat>
  <Long>{1,1}</Long>
</GeoRef>
[ top ]
Element Address / GeoRef / Lat
Diagram
Diagram
[ top ]
Element Address / GeoRef / Long
Diagram
Diagram
[ top ]
Element Address / Phone
Diagram
Diagram DeliveryAddress.tmp#Address_Address_Phone_Number
Instance
<Phone>
  <Number Description="" Seq="" Type="">{0,unbounded}</Number>
</Phone>
[ top ]
Element Address / Phone / Number
Diagram
Diagram DeliveryAddress.tmp#Address_Address_Phone_Address_Address_Phone_Number_Type DeliveryAddress.tmp#Address_Address_Phone_Address_Address_Phone_Number_Seq DeliveryAddress.tmp#Address_Address_Phone_Address_Address_Phone_Number_Description
Attributes
QName Type Use
Description restriction of xs:string optional
Seq xs:integer optional
Type restriction of xs:string required
[ top ]
Element Address / Fax
Diagram
Diagram DeliveryAddress.tmp#Address_Address_Fax_Number
Instance
<Fax>
  <Number Description="" Seq="" Type="">{0,unbounded}</Number>
</Fax>
[ top ]
Element Address / Fax / Number
Diagram
Diagram DeliveryAddress.tmp#Address_Address_Fax_Address_Address_Fax_Number_Type DeliveryAddress.tmp#Address_Address_Fax_Address_Address_Fax_Number_Seq DeliveryAddress.tmp#Address_Address_Fax_Address_Address_Fax_Number_Description
Attributes
QName Type Use
Description restriction of xs:string optional
Seq xs:integer optional
Type restriction of xs:string required
[ top ]
Element Address / Email
Diagram
Diagram DeliveryAddress.tmp#Address_Address_Email_Address
Instance
<Email>
  <Address Description="" Seq="" Type="">{0,unbounded}</Address>
</Email>
[ top ]
Element Address / Email / Address
Diagram
Diagram DeliveryAddress.tmp#Address_Address_Email_Address_Address_Email_Address_Type DeliveryAddress.tmp#Address_Address_Email_Address_Address_Email_Address_Seq DeliveryAddress.tmp#Address_Address_Email_Address_Address_Email_Address_Description
Attributes
QName Type Use
Description restriction of xs:string optional
Seq xs:integer optional
Type restriction of xs:string required
[ top ]
Element Address / Social
Diagram
Diagram DeliveryAddress.tmp#Address_Address_Social_Address
Instance
<Social>
  <Address Description="" Seq="" Type="">{0,unbounded}</Address>
</Social>
[ top ]
Element Address / Social / Address
Diagram
Diagram DeliveryAddress.tmp#Address_Address_Social_Address_Address_Social_Address_Type DeliveryAddress.tmp#Address_Address_Social_Address_Address_Social_Address_Seq DeliveryAddress.tmp#Address_Address_Social_Address_Address_Social_Address_Description
Attributes
QName Type Use
Description restriction of xs:string optional
Seq xs:integer optional
Type restriction of xs:string required
[ top ]
Element Address / Notes
Annotations
Address notes – may be used for special purposes such as delivery address notes
Diagram
Diagram
[ top ]
Element Address / TimeZone
Annotations
TimeZone Offset. Decimal 9.5 =  “+9:30”        http://wwp.greenwichmeantime.com/info/timezone.htm
Diagram
Diagram
[ top ]
Element Address / TimeZoneName
Annotations
Name of Time Zone (Microsoft)
Diagram
Diagram
[ top ]
Element DeliveryAddress / DeliveryRegion
Diagram
Diagram
[ top ]
Element DeliveryAddress / DeliveryRuns
Annotations
A list of run numbers servicing this outlet.
DeliveryRuns should be empty or null if no run data supplied.  Days Offset is an optional attribute.
Runs can be used for public holiday delivery exception handling.
Diagram
Diagram DeliveryAddress.tmp#DeliveryAddress_DeliveryAddress_DeliveryRuns_DeliveryRun
Instance
<DeliveryRuns>
  <DeliveryRun DaysOffset="0">{0,unbounded}</DeliveryRun>
</DeliveryRuns>
[ top ]
Element DeliveryAddress / DeliveryRuns / DeliveryRun
Diagram
Diagram DeliveryAddress.tmp#DeliveryAddress_DeliveryAddress_DeliveryRuns_DeliveryAddress_DeliveryAddress_DeliveryRuns_DeliveryRun_DaysOffset
Attributes
QName Type Default Use
DaysOffset xs:decimal 0 optional
[ top ]
Element RestrictionList
Diagram
Diagram DeliveryAddress.tmp#RestrictionList_RestrictionCode
Used by
Element DeliveryAddress
Instance
<RestrictionList>
  <RestrictionCode RestrictionType="">{0,unbounded}</RestrictionCode>
</RestrictionList>
[ top ]
Element RestrictionList / RestrictionCode
Diagram
Diagram DeliveryAddress.tmp#RestrictionList_RestrictionList_RestrictionCode_RestrictionType
Attributes
QName Type Use Annotation
RestrictionType xs:string required
RestrictTo, Permit, or Deny
[ top ]
Element DeliveryAddress / ShipToAccountChargeCode
Annotations
If Defined, defines the account the delivery must be charged to if this ShipTo address is chosen, regardless of the account submitting the order, the order will be remapped to this account code on completion.
Diagram
Diagram
[ top ]
Element DeliveryAddress / ShipToNotes
Annotations
Standard instructions relating to delivery to this address.
Diagram
Diagram
[ top ]
Element DeliveryAddress / ShipToCode
Diagram
Diagram
[ top ]
Element Attributes
Annotations
Deprecated at Entity Level..  Please use the separate AttributeList Load File to load entity specific attributes.
Diagram
Diagram DeliveryAddress.tmp#Attributes_Version DeliveryAddress.tmp#Attribute
Used by
Element DeliveryAddress
Instance
<Attributes Version="">
  <Attribute Deprecated="" Scope="">{0,unbounded}</Attribute>
</Attributes>
Attributes
QName Type Use
Version xs:decimal optional
[ top ]
Element Attribute
Diagram
Diagram DeliveryAddress.tmp#Attribute_Deprecated DeliveryAddress.tmp#Attribute_Scope DeliveryAddress.tmp#Attribute_EntityCode DeliveryAddress.tmp#Attribute_Name DeliveryAddress.tmp#Attribute_Value
Used by
Element Attributes
Instance
<Attribute Deprecated="" Scope="">
  <EntityCode>{0,1}</EntityCode>
  <Name>{1,1}</Name>
  <Value DataType="">{0,1}</Value>
</Attribute>
Attributes
QName Type Use Annotation
Deprecated xs:boolean optional
Scope xs:string optional
Public, Private, Admin : defines the visibility of the attribute within the site.  Default determined by the of Entity type.
[ top ]
Element Attribute / EntityCode
Annotations
The code of the entity these attributes belong t  - i.e. ProductItemCode  Field is mandatory if attributes are ssent on a separate file.
Diagram
Diagram
Facets
maxLength 36
[ top ]
Element Attribute / Name
Annotations
Name of the Attribute
Diagram
Diagram
[ top ]
Element Attribute / Value
Annotations
Value of the Attribute, must be the string representation of the appropriate type
Diagram
Diagram DeliveryAddress.tmp#Attribute_Attribute_Value_DataType
Attributes
QName Type Use
DataType xs:string optional
[ top ]
Element DeliveryAddress / TypeID
Annotations
Delivery Address Type indicatior.  By default all addresses are standard (0),  however we support Temporary delivery addresses that may be short lived or visaible only by certain modules like Order Entry.
Diagram
Diagram
[ top ]
Element Errors
Diagram
Diagram DeliveryAddress.tmp#Errors_Error
Used by
Instance
<Errors>
  <Error>{0,unbounded}</Error>
</Errors>
[ top ]
Element Errors / Error
Diagram
Diagram DeliveryAddress.tmp#Errors_Errors_Error_ErrorCode DeliveryAddress.tmp#Errors_Errors_Error_ErrorRef DeliveryAddress.tmp#Errors_Errors_Error_ErrorMsg DeliveryAddress.tmp#Errors_Errors_Error_AdditionalInfo
Instance
<Error>
  <ErrorCode>{1,1}</ErrorCode>
  <ErrorRef>{1,1}</ErrorRef>
  <ErrorMsg>{1,1}</ErrorMsg>
  <AdditionalInfo>{0,1}</AdditionalInfo>
</Error>
[ top ]
Element Errors / Error / ErrorCode
Diagram
Diagram
[ top ]
Element Errors / Error / ErrorRef
Diagram
Diagram
[ top ]
Element Errors / Error / ErrorMsg
Diagram
Diagram
[ top ]
Element Errors / Error / AdditionalInfo
Diagram
Diagram
[ top ]
Attribute Address / Phone / Number / @Type
Facets
enumeration business
enumeration other
enumeration mobile
enumeration work
enumeration home
Used by
[ top ]
Attribute Address / Phone / Number / @Seq
Used by
[ top ]
Attribute Address / Phone / Number / @Description
Facets
maxLength 25
Used by
[ top ]
Attribute Address / Fax / Number / @Type
Facets
enumeration business
enumeration other
enumeration work
enumeration home
Used by
[ top ]
Attribute Address / Fax / Number / @Seq
Used by
[ top ]
Attribute Address / Fax / Number / @Description
Facets
maxLength 25
Used by
[ top ]
Attribute Address / Email / Address / @Type
Facets
enumeration business
enumeration other
enumeration work
enumeration personal
Used by
[ top ]
Attribute Address / Email / Address / @Seq
Used by
[ top ]
Attribute Address / Email / Address / @Description
Facets
maxLength 100
Used by
[ top ]
Attribute Address / Social / Address / @Type
Facets
enumeration other
enumeration lynkedin
enumeration skype
enumeration im
enumeration twitter
enumeration facebook
enumeration website
Used by
[ top ]
Attribute Address / Social / Address / @Seq
Used by
[ top ]
Attribute Address / Social / Address / @Description
Facets
maxLength 100
Used by
[ top ]
Attribute Address / @Type
Facets
enumeration business
enumeration other
enumeration physical
enumeration postal
enumeration delivery
enumeration home
enumeration work
Used by
Element Address
[ top ]
Attribute Address / @Version
Used by
Element Address
[ top ]
Attribute DeliveryAddress / DeliveryRuns / DeliveryRun / @DaysOffset
Used by
[ top ]
Attribute RestrictionList / RestrictionCode / @RestrictionType
Annotations
RestrictTo, Permit, or Deny
Used by
[ top ]
Attribute Attribute / Value / @DataType
Used by
Element Attribute/Value
[ top ]
Attribute Attribute / @Deprecated
Used by
Element Attribute
[ top ]
Attribute Attribute / @Scope
Annotations
Public, Private, Admin : defines the visibility of the attribute within the site.  Default determined by the of Entity type.
Used by
Element Attribute
[ top ]
Attribute Attributes / @Version
Used by
Element Attributes
[ top ]
Attribute DeliveryAddress / @Version
Used by
Element DeliveryAddress
[ top ]
Attribute DeliveryAddress / @Deprecated
Used by
Element DeliveryAddress
[ top ]
Attribute DeliveryAddresses / @Version
Used by
[ top ]
Attribute CommonAttributes / @Culture
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @Version
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @LoadType
Annotations
FULL, FULLBranch, or PARTIAL
Note: partial loads require each record to explicitly declare if it is deprecated or not.  Full loads assume anything not in the load is deprecated.
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @LoadFilter
Annotations
LoadFilter must indicate the Entity Type.  Only one Entity Type per file is allowed. i.e. “Product”
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @TransactionID
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @StartTime
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @EndTime
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @SiteID
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @StatusID
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @ErrorCount
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @Transformed
Used by
Attribute Group CommonAttributes
[ top ]
Attribute Group CommonAttributes
Diagram
Diagram DeliveryAddress.tmp#CommonAttributes_Culture DeliveryAddress.tmp#CommonAttributes_Version DeliveryAddress.tmp#CommonAttributes_LoadType DeliveryAddress.tmp#CommonAttributes_LoadFilter DeliveryAddress.tmp#CommonAttributes_TransactionID DeliveryAddress.tmp#CommonAttributes_StartTime DeliveryAddress.tmp#CommonAttributes_EndTime DeliveryAddress.tmp#CommonAttributes_SiteID DeliveryAddress.tmp#CommonAttributes_StatusID DeliveryAddress.tmp#CommonAttributes_ErrorCount DeliveryAddress.tmp#CommonAttributes_Transformed
Used by
Attributes
QName Type Default Use Annotation
Culture xs:string en optional
EndTime xs:dateTime optional
ErrorCount xs:integer 0 optional
LoadFilter xs:string optional
LoadFilter must indicate the Entity Type.  Only one Entity Type per file is allowed. i.e. “Product”
LoadType xs:string required
FULL, FULLBranch, or PARTIAL
Note: partial loads require each record to explicitly declare if it is deprecated or not.  Full loads assume anything not in the load is deprecated.
SiteID xs:string optional
StartTime xs:dateTime optional
StatusID xs:integer optional
TransactionID xs:string optional
Transformed xs:boolean false optional
Version xs:decimal required
[ top ]