Schema documentation for ProcessedOrder.xsd

No namespace

	Main Schema
	ProcessedOrder.xsd

	Included Schemas
	CommonElements.xsd

	Elements
	Address Attribute Attributes Errors ProcessedOrder ProcessedOrderLineItem ProcessedOrderLineItems ProcessedOrderListSubmit ProcessedOrders RestrictionList

	Attribute Groups
	CommonAttributes

	Main Schema
	ProcessedOrder.xsd

	Included Schemas
	CommonElements.xsd

	Elements
	Address Attribute Attributes Errors ProcessedOrder ProcessedOrderLineItem ProcessedOrderLineItems ProcessedOrderListSubmit ProcessedOrders RestrictionList

	Attribute Groups
	CommonAttributes

ProcessedOrder.xsd

	Main Schema
	ProcessedOrder.xsd

	Elements
	ProcessedOrder ProcessedOrderLineItem ProcessedOrderLineItems ProcessedOrderListSubmit ProcessedOrders

CommonElements.xsd

	Included Schemas
	CommonElements.xsd

	Elements
	Address Attribute Attributes Errors RestrictionList

	Attribute Groups
	CommonAttributes

Change from 1.5: Added element ReplacedForProductItemCode

<ProcessedOrderListSubmit Culture="en" EndTime="" ErrorCount="0" LoadFilter="" LoadType="" SiteID="" StartTime="" StatusID="" TransactionID="" Transformed="false" Version="">
  <ProcessedOrders Version="">{1,1}</ProcessedOrders>
  <Errors>{0,1}</Errors>
</ProcessedOrderListSubmit>

QName

Type

Default

Use

Annotation

Culture

xs:string

optional

EndTime

xs:dateTime

optional

ErrorCount

xs:integer

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

<ProcessedOrders Version="">
  <ProcessedOrder Version="1.0">{0,unbounded}</ProcessedOrder>
</ProcessedOrders>

QName	Type	Use
Version	xs:decimal	optional

Element

ProcessedOrders

<ProcessedOrder Version="1.0">
  <WarehouseCode>{1,1}</WarehouseCode>
  <OrderNo>{1,1}</OrderNo>
  <OrderDate>{1,1}</OrderDate>
  <ConfirmationNo>{1,1}</ConfirmationNo>
  <AccountCode>{1,1}</AccountCode>
  <OrderStatusCode>{1,1}</OrderStatusCode>
  <InvoiceTo1>{1,1}</InvoiceTo1>
  <InvoiceTo2>{1,1}</InvoiceTo2>
  <InvoiceTo3>{1,1}</InvoiceTo3>
  <InvoiceTo4>{1,1}</InvoiceTo4>
  <DeliverTo1>{1,1}</DeliverTo1>
  <DeliverTo2>{1,1}</DeliverTo2>
  <DeliverTo3>{1,1}</DeliverTo3>
  <DeliverTo4>{1,1}</DeliverTo4>
  <OurRef>{1,1}</OurRef>
  <CustRef>{1,1}</CustRef>
  <FaxNo>{1,1}</FaxNo>
  <NoOfItems>{1,1}</NoOfItems>
  <Discount>{1,1}</Discount>
  <Freight>{1,1}</Freight>
  <OtherCharges>{1,1}</OtherCharges>
  <Tax>{1,1}</Tax>
  <OrderTotal>{1,1}</OrderTotal>
  <ShipmentComplete>{1,1}</ShipmentComplete>
  <DeliveryInstructions>{1,1}</DeliveryInstructions>
  <DateDelivered>{1,1}</DateDelivered>
  <ProcessedOrderLineItems>{1,1}</ProcessedOrderLineItems>
</ProcessedOrder>

QName	Type	Default	Use
Version	xs:decimal	1.0	optional

The order status code which will update the order status in myBidfood. Each site will have is own status code mapping in DB

The originating Web Order Reference number if the order came via BDirect.

Information field.  Can be used to declare the total discount applied to the order.  Prices send to Bdirect are already inclusive of discounts.  Not currently displayed on the site but may be in future.

Indicates the entire order has been fulfilled.

Element

ProcessedOrder

<ProcessedOrderLineItems>
  <ProcessedOrderLineItem>{0,unbounded}</ProcessedOrderLineItem>
</ProcessedOrderLineItems>

<ProcessedOrderLineItem>
  <OrderLineNo>{1,1}</OrderLineNo>
  <ProductItemCode>{1,1}</ProductItemCode>
  <Description>{1,1}</Description>
  <InvUOM>{1,1}</InvUOM>
  <QtyOrdered>{1,1}</QtyOrdered>
  <QtyBackOrdered>{1,1}</QtyBackOrdered>
  <QtyDelivered>{1,1}</QtyDelivered>
  <UnitPrice>{1,1}</UnitPrice>
  <ExtendedPrice>{1,1}</ExtendedPrice>
  <LineTax>{1,1}</LineTax>
  <OrderLineStatus>{1,1}</OrderLineStatus>
  <BrandRef>{1,1}</BrandRef>
  <PackSizeRef>{1,1}</PackSizeRef>
  <CustGLCode1>{1,1}</CustGLCode1>
  <CustGLCode2>{1,1}</CustGLCode2>
  <CustGLCode3>{1,1}</CustGLCode3>
  <CustGLCode4>{1,1}</CustGLCode4>
  <LineItemNote>{0,1}</LineItemNote>
  <ReplacedForProductItemCode>{0,1}</ReplacedForProductItemCode>
</ProcessedOrderLineItem>

<Errors>
  <Error>{0,unbounded}</Error>
</Errors>

<Error>
  <ErrorCode>{1,1}</ErrorCode>
  <ErrorRef>{1,1}</ErrorRef>
  <ErrorMsg>{1,1}</ErrorMsg>
  <AdditionalInfo>{0,1}</AdditionalInfo>
</Error>

<RestrictionList>
  <RestrictionCode RestrictionType="">{0,unbounded}</RestrictionCode>
</RestrictionList>

QName

Type

Use

Annotation

RestrictionType

xs:string

required

RestrictTo, Permit, or Deny

Element

Attributes

<Attribute Deprecated="" Scope="">
  <EntityCode>{0,1}</EntityCode>
  <Name>{1,1}</Name>
  <Value DataType="">{0,1}</Value>
</Attribute>

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.

The code of the entity these attributes belong t  - i.e. ProductItemCode  Field is mandatory if attributes are ssent on a separate file.

Name of the Attribute

Value of the Attribute, must be the string representation of the appropriate type

QName	Type	Use
DataType	xs:string	optional

Deprecated at Entity Level..  Please use the separate AttributeList Load File to load entity specific attributes.

<Attributes Version="">
  <Attribute Deprecated="" Scope="">{0,unbounded}</Attribute>
</Attributes>

QName	Type	Use
Version	xs:decimal	optional

Generic Address Element

<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>

QName	Type	Use
Type	restriction of xs:string	optional
Version	xs:decimal	optional

<GeoRef>
  <Lat>{1,1}</Lat>
  <Long>{1,1}</Long>
</GeoRef>

<Phone>
  <Number Description="" Seq="" Type="">{0,unbounded}</Number>
</Phone>

QName	Type	Use
Description	restriction of xs:string	optional
Seq	xs:integer	optional
Type	restriction of xs:string	required

<Fax>
  <Number Description="" Seq="" Type="">{0,unbounded}</Number>
</Fax>

QName	Type	Use
Description	restriction of xs:string	optional
Seq	xs:integer	optional
Type	restriction of xs:string	required

<Email>
  <Address Description="" Seq="" Type="">{0,unbounded}</Address>
</Email>

QName	Type	Use
Description	restriction of xs:string	optional
Seq	xs:integer	optional
Type	restriction of xs:string	required

<Social>
  <Address Description="" Seq="" Type="">{0,unbounded}</Address>
</Social>

QName	Type	Use
Description	restriction of xs:string	optional
Seq	xs:integer	optional
Type	restriction of xs:string	required

Address notes – may be used for special purposes such as delivery address notes

TimeZone Offset. Decimal 9.5 =  “+9:30”        http://wwp.greenwichmeantime.com/info/timezone.htm

Name of Time Zone (Microsoft)

Element

ProcessedOrder

Element

ProcessedOrders

Attribute Group

CommonAttributes

Attribute Group

CommonAttributes

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.

Attribute Group

CommonAttributes

LoadFilter must indicate the Entity Type.  Only one Entity Type per file is allowed. i.e. “Product”

Attribute Group

CommonAttributes

Attribute Group

CommonAttributes

Attribute Group

CommonAttributes

Attribute Group

CommonAttributes

Attribute Group

CommonAttributes

Attribute Group

CommonAttributes

Attribute Group

CommonAttributes

Attribute Group

CommonAttributes

RestrictTo, Permit, or Deny

Element

Attribute/Value

Element

Attribute

Public, Private, Admin : defines the visibility of the attribute within the site.  Default determined by the of Entity type.

Element

Attribute

Element

Attributes

enumeration	business
enumeration	other
enumeration	mobile
enumeration	work
enumeration	home

enumeration	business
enumeration	other
enumeration	work
enumeration	home

Element

Address/Fax/Number

Element

Address/Fax/Number

Element

Address/Fax/Number

enumeration	business
enumeration	other
enumeration	work
enumeration	personal

enumeration	other
enumeration	lynkedin
enumeration	skype
enumeration	im
enumeration	twitter
enumeration	facebook
enumeration	website

enumeration	business
enumeration	other
enumeration	physical
enumeration	postal
enumeration	delivery
enumeration	home
enumeration	work

QName

Type

Default

Use

Annotation

Culture

xs:string

optional

EndTime

xs:dateTime

optional

ErrorCount

xs:integer

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

XML Schema documentation generated by <oXygen/>^® XML Editor.

Showing:

Table of Contents