Order Standard XML

Field Name

Description

User Requirement

        <SalesOrder>

            <Identifier>

                <SourceKey>002152252</SourceKey>

Identifier that will come from the source system; typically this will match the PartnerPO.

Read Only (LB Generated)

                <LogicbrokerKey>42088</LogicbrokerKey>

ID to identify the document in the logicbroker system. Required to save this in your system to prevent duplicates.

Read Only (LB Generated)

                <LinkKey>1604032521</LinkKey>

Used to link the document to the original source document. For example, It is best to supply the Order's linkkey when posting a shipment. This will make sure the order shipped quanitites are updated on the original order and all statuses are updated appropriateley.

Optional (LB Generated)

            </Identifier>

            <OrderNumber>002152252</OrderNumber>

Contains the end customer's order number, this will be used on the packing slip.

Required

            <VendorNumber>V12345</VendorNumber>

This is the internal vendor number provided to the supplier from the merchant

Optional

            <CustomerNumber>V12345</CustomerNumber>

End User's customer ID; typically used on the packing slip

Optional

            <PartnerPO>159999998718</PartnerPO>

This will be the purcahse order number, this will be the main Key to link all your documents.

Required

            <TypeCode>SA</TypeCode>

Purchase Order Type Code will indicate what type of PO is being sent. Examples are shown below.

SA = Stand Alone

RE = Re-Order

DS = Drop Ship

Optional

            <OrderDate>2013-10-31T00:00:00</OrderDate>

Date on the Purchase Order

Required

            <DocumentDate>2016-04-22T20:45:22.79</DocumentDate>

Date the document was created in the logicbroker system.

Required

            <SenderCompanyId>100988</SenderCompanyId>

Logicbroker Internal Company ID to specify what company is sending the document.

Required

            <ReceiverCompanyId>100988</ReceiverCompanyId>

Logicbroker Internal Company ID to specify what company is to receive the document.

Required

            <Discounts>

                <Discount>

                    <DiscountCode>0001883</DiscountCode>

Promotional/Deal Number or Code

Optional

                    <DiscountPercent>0</DiscountPercent>

Terms Discount Percent to calculate applicable discount amount for timely payment

Optional

                    <DiscountAmount>5</DiscountAmount>

Discount amount to be applied and included in the order total.

Optional

                </Discount>

            </Discounts>

            <Taxes>

                <Tax>

                    <TaxAmount>3</TaxAmount>

Tax Amount to be applied and included in the order total.

Optional

                </Tax>

            </Taxes>

            <PaymentTerm>

                <PayInNumberOfDays>30</PayInNumberOfDays>

Number of days in which the invoice is due, before additional charges are accrued.

Optional

                <DiscountInNumberOfDays>10</DiscountInNumberOfDays>

Discount days due when discount will be applied.

Optional

                <AvailableDiscount>0</AvailableDiscount>

Terms discount amount that will be applied within timely payment.

Optional

                <DueDate>0001-01-01T12:00:00</DueDate>

Date in which the invoice is due, before additional charges are accrued.

Optional

                <DiscountDueDate>0001-01-01T12:00:00</DiscountDueDate>

Discount due date when discount will be applied.

Optional

                <EffectiveDate>2012-01-04T12:00:00</EffectiveDate>

Date when the Payment terms begin.

Optional

            </PaymentTerm>

            <ShipmentInfos>

                <ShipmentInfo>

                    <CarrierCode>string</CarrierCode>

This will typically be the Standard Carrier Alpha Code (SCAC).

Optional

                    <ClassCode>UPSN_CG</ClassCode>

The shipping method that will be used to send the merchandise. This is a free form field and can include UPS Ground, or Overnight, etc.

Required

                    <ServiceLevelCode>ND</ServiceLevelCode>

Service Level set to ship by the carrier. Check with trading partner to see applicable codes. An example of a few would be:

ND = Next Day

CG = Ground

ON = Overnight

SA = Same Day

Optional

                </ShipmentInfo>

            </ShipmentInfos>

            <ShipToAddress>

Address where the order will be shipped

Required

                <CompanyName>Merchant Co</CompanyName>

Required

                <FirstName>Jerry</FirstName>

Optional

                <LastName>Only</LastName>

Optional

                <Address1>111 Merchant Lane</Address1>

Required

                <Address2>Apt 1</Address2>

Optional

                <City>Yonkers</City>

Required

                <State>NY</State>

Required

                <Country>USA</Country>

Optional

                <Zip>10704</Zip>

Required

                <AddressCode>1234567890</AddressCode>

Address code that will indicate the location where the address is related to. Typically will be a store or DC number.

Optional

                <Phone>111-222-3333</Phone>

Optional

                <Email>Merchant@co.com</Email>

Optional

            </ShipToAddress>

            <BillToAddress>

Address for whom the order will be billed to.

Optional

                <CompanyName>Merchant Co</CompanyName>

Optional

                <FirstName>Jerry</FirstName>

Optional

                <LastName>Only</LastName>

Optional

                <Address1>111 Merchant Lane</Address1>

Optional

                <Address2>Apt 1</Address2>

Optional

                <City>Yonkers</City>

Optional

                <State>NY</State>

Optional

                <Country>USA</Country>

Optional

                <Zip>10704</Zip>

Optional

                <AddressCode>123456789</AddressCode>

Address code that will indicate the location where the address is related to. Typically will be a store or DC number.

Optional

                <Phone>111-222-3333</Phone>

Optional

                <Email>Merchant@co.com</Email>

Optional

            </BillToAddress>

            <OrderedByAddress>

This is the bill to address for the end customer. This is typically used for dropship orders.

Optional

                <CompanyName>JOANNE WELLS</CompanyName>

Optional

                <FirstName>Customer</FirstName>

Optional

                <LastName>Name</LastName>

Optional

                <Address1>111 Merchant Lane</Address1>

Optional

                <Address2>Apt 1</Address2>

Optional

                <City>CLIFTON PARK</City>

Optional

                <State>NY</State>

Optional

                <Country>USA</Country>

Optional

                <Zip>120658763</Zip>

Optional

                <AddressCode>1123456789</AddressCode>

Address code that will indicate the location where the address is related to. Typically will be a store or DC number.

Optional

                <Phone>1231231234</Phone>

Optional

                <Email>DS@customer.com</Email>

Optional

            </OrderedByAddress>

            <ExtendedAttributes>

Section will include specific custom information for the trading partner. These can be specific codes; details will be provided on a trading partner basis. The Name will contain the field's label and the value will be the attribute associated with the field. The section will indicate where the value was received and will typically not be used, unless specified. Anything entered in this section will carry over to other linked documents such as the acknowledgement, shipment, and invoice.

Optional

                <ExtendedAttribute>

                    <Name>StoreNumber</Name>

Used to identify the store where the order will get shipped for customer pickup. Will also be used to differentiate between D2S and D2C.

Optional

                    <Value>12243</Value>

                </ExtendedAttribute>

                <ExtendedAttribute>

                    <Name>InternalOrderNumber</Name>

This is the internal order number within the merchant's system; typically required on the packing slip.

Optional

                    <Value>1604032521</Value>

                </ExtendedAttribute>

                <ExtendedAttribute>

                    <Name>GiftWrap</Name>

Will be used to indicate gift wrap. "1" will be used to indicate gift wrapping the entire order.

Optional

                    <Value>1</Value>

                </ExtendedAttribute>

                <ExtendedAttribute>

                    <Name>MiscCharge</Name>

Charges to be applied to the PO total; format will be XX.XX

Optional

                    <Value>11.22</Value>

                </ExtendedAttribute>

                <ExtendedAttribute>

                    <Name>CustomerDiscount</Name>

Discount amount the end customer received. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

                    <Value>5.99</Value>

                </ExtendedAttribute>

                <ExtendedAttribute>

                    <Name>CustomerShipping</Name>

Shipping and Handling amount the end customer paid. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

                    <Value>2.95</Value>

                </ExtendedAttribute>

                <ExtendedAttribute>

                    <Name>CustomerTax</Name>

Tax amount the end customer paid. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

                    <Value>16.22</Value>

                </ExtendedAttribute>

                <ExtendedAttribute>

                    <Name>CustomerMiscCharge</Name>

Miscellaneous charge amount the end customer paid. This can be gift wrapping charge, special services, etc. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

                    <Value>0.25</Value>

                </ExtendedAttribute>

                <ExtendedAttribute>

                    <Name>CustomerOrderDate</Name>

Will be used to show date when customer placed order; typically used on the packing slip.

Optional

                    <Value>2016-11-13</Value>

                </ExtendedAttribute>

            </ExtendedAttributes>

            <Currency>USD</Currency>

Currency Code used on the purchase order.

Optional

            <StatusCode>1000</StatusCode>

This will be used to identify the status of your order. This is tied to all the documents associated with it.

100 (Submitted) =  Status used when order is first received, once the order is picked up it should be moved to the next status, typically this will be 500 (Ready to Ship). For most partners the order will rarely stay in this status and can be picked up on 500 (Ready to Ship).

500 (Ready to Ship) = Indicates the order is pending shipment and waiting on the shipment. Once this shipment is sent the order shipped quantity will be updated and when all items have been shipped the status will automatically move to 600 (Ready to Invoice).

600 (Ready to Invoice) = Status indicates order is pending invoicing. Once the invoice is received and all item Quantities have been shipped the status will move to complete.

1000 (Complete) = Order flow is complete and all necessary documents have been received and processed for it. Some flows can include Acknowledgement, Shipment, and Invoice.

1100 (Cancelled) = Indicates the order and all line items have been cancelled. If you are sending an Acknowledgement as a cancellation, the status will need to be moved to this status and will not be done automatically.

1200 (Failed) = The status will indicate there was an error processing the order. Will go to this status automatically if the order fails to send via EDI, or has failed validation rules. See the events associated with the order to see the reason for the failure.

Required - Conditional

            <HandlingAmount>15</HandlingAmount>

Shipping amount to be applied and included in the order total.

Optional

            <Note>Thank you for shopping at ONLINE!</Note>

This section will include gift and packing slip messages.

Optional

            <RequestedShipDate>2015-11-06T12:00:00</RequestedShipDate>

Date requested for order to leave the warehouse/shipping location.

Optional

            <DoNotShipAfter>2015-11-07T08:51:56</DoNotShipAfter>

Date in which the PO should be cancelled if the date has been passed before shipment.

Optional

            <ReleaseNumber>001</ReleaseNumber>

Used for replacement orders to not duplicate the fulfillment of the same PO.

Optional

            <SalesRequirement>NoBackorder</SalesRequirement>

Indicates the terms of completing the purchase order. Applicable codes are listed below:

0 = NoBackorder

1 = Backorder if out of stock

2 = ShipComplete

Optional

            <OrderLines>

                <OrderLine>

                    <ItemIdentifier>

                        <SupplierSKU>49-98760</SupplierSKU>

The Item Identifier that is used by the supplier or the person fulfilling the product.

Required

                        <PartnerSKU>J07874</PartnerSKU>

The Item identifier that is internal to the purchaser/merchant.

Optional

                        <ManufacturerSKU>0025252</ManufacturerSKU>

Manufacturer's ID for the product.

Optional

                        <UPC>123456789012</UPC>

Typically the U.P.C Consumer Package code will be provided; however additional standardized codes can be provided here as well. See specific partner instructions for details.

Optional

                        <ISBN>string</ISBN>

International Standard Book Number

Optional

                    </ItemIdentifier>

                    <Price>31.02</Price>

Unit cost that the merchant expects to be billed for each unit fulfilled.

Required

                    <PriceCode>WH</PriceCode>

Used to indicate the price level for the product. See specific partner details for applicable codes.

Optional

                    <RetailPrice>47.98</RetailPrice>

Unit Price to be charged to the customer or end receiver. This will typically be the value on the packing slip.

Optional

                    <Description>BLOUSE</Description>

Standard short description or name of the product.

Optional

                    <Discounts>

                        <Discount>

                            <DiscountAmount>0</DiscountAmount>

Discount amount applied to the corresponding item.

Optional

                        </Discount>

                    </Discounts>

                    <ShipmentInfos>

                        <ShipmentInfo>

                            <CarrierCode>string</CarrierCode>

Used for specific shipping instructions on the line item level. This will typically be the Standard Carrier Alpha Code (SCAC).

Optional

                            <ClassCode>UPSN_CG</ClassCode>

Item level shipping method that will be used to send the merchandise. This is a free form field and can include UPS Ground, or Overnight, etc.

Optional

                            <ShipmentCost>0</ShipmentCost>

Shipping amount to be applied to this item.

Optional

                            <Weight>0</Weight>

Total weight of the package or carton.

Optional

                            <WeightUnit>LB</WeightUnit>

Weight Unit of Measure for the package or carton.

Optional

                        </ShipmentInfo>

                    </ShipmentInfos>

                    <Taxes>

                        <Tax>

                            <TaxAmount>3.20</TaxAmount>

Item Level Tax amount

Optional

                        </Tax>

                    </Taxes>

                    <Quantity>5</Quantity>

Contains the quantity of items to be fulfilled.

Required

                    <QuantityUOM>EA</QuantityUOM>

Unit of Measure for the quantity ordered. See partner's details for specifics.

Required

                    <LineNumber>1</LineNumber>

Purchase order line number.

Required

                    <Weight>0</Weight>

Weight of the product

Optional

                    <Note>string</Note>

Specific Notes related to the product. See specific partner for applicable item level messages.

Optional

                    <ExtendedAttributes>

Section will provide custom item information.These can be specific codes; details will be provided on a trading partner basis. The Name will contain the field's label and the value will be the attribute associated with the field. The section will indicate where the value was received and will typically not be used, unless specified.

Optional

                        <ExtendedAttribute>

                            <Name>Color</Name>

Color code used to identify specific product attribute. Can also include color description; see specific partner for details.

Optional

                            <Value>15</Value>

                        </ExtendedAttribute>

                        <ExtendedAttribute>

                            <Name>Gift Message</Name>

Item Level Gift Message

Optional

                            <Value>Get well soon!</Value>

                        </ExtendedAttribute>

                        <ExtendedAttribute>

                            <Name>Item Level Message</Name>

Item Level message, to specify additional details for the product. This can include customizations or other instructions.

Optional

                            <Value>MONOGRAM = DAS</Value>

                        </ExtendedAttribute>

                        <ExtendedAttribute>

                            <Name>Size</Name>

Size identifier for the product.

Optional

                            <Value>SIZE 15</Value>

                        </ExtendedAttribute>

                        <ExtendedAttribute>

                            <Name>GiftWrap</Name>

Will be used to indicate gift wrap. "1" will be used to indicate gift wrapping this specific item.

Optional

                            <Value>1</Value>

                        </ExtendedAttribute>

                        <ExtendedAttribute>

                            <Name>MiscCharge</Name>

Item level charges to be applied to the PO total; format will be XX.XX

Optional

                            <Value>11.99</Value>

                        </ExtendedAttribute>

                        <ExtendedAttribute>

                            <Name>CustomerDiscount</Name>

Item level discount amount the end customer received. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

                            <Value>4.95</Value>

                        </ExtendedAttribute>

                        <ExtendedAttribute>

                            <Name>CustomerShipping</Name>

Item level shipping and Handling amount the end customer paid. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

                            <Value>0.99</Value>

                        </ExtendedAttribute>

                        <ExtendedAttribute>

                            <Name>CustomerTax</Name>

Tax amount the end customer paid. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

                            <Value>14.12</Value>

                        </ExtendedAttribute>

                        <ExtendedAttribute>

                            <Name>CustomerMiscCharge</Name>

Miscellaneous charge amount the end customer paid. This can be gift wrapping charge, special services, etc. Typically used for drop ship and will be used on the packing slip. Format will be XX.XX

Optional

                            <Value>11.11</Value>

                        </ExtendedAttribute>

                        <ExtendedAttribute>

                            <Name>SpecialInstructions</Name>

This would include instruction on packing or shipping this specific item.

Optional

                            <Value>Mark as FRAGILE</Value>

                        </ExtendedAttribute>

                        <ExtendedAttribute>

                            <Name>MiscItemIdentifier</Name>

This would be an item identifier that does not fit in the standard SupplierSKU, PartnerSKU, or UPC. You would need to refer to the specific trading partner on the usage.

Optional

                            <Value>SKU000999</Value>

                        </ExtendedAttribute>

                    </ExtendedAttributes>

                </OrderLine>

            </OrderLines>

        </SalesOrder>