This document describes the XML data used by OASIS internally to indicate a new order. An O2O may be generated and shared in the following ways:
- generated by the manufacturer version of OASIS and transmitted to the representative version of OASIS
- generated by the representative version of OASIS and transmitted to the distributor version of OASIS
The definition below may be used to do basic validation of the XML. For more information, please contact OASIS support by email at support@oasissalessoftware.com or by phone at 501-843-6750.
Definition
The XSD is downloadable here: O2O-NewOrder.xsd
Example
The example is downloadable here: NewOrderExample.xml
Note: the file suffix of .o2o is used to indicate the file content is a native OASIS document. Otherwise, it is possible the file may be rejected, especially if the file is to be manually "dropped" onto the OASIS application.
Field Descriptions
The following fields are defined:
NewOrderType Fields
| Name | Description | Data Values |
|---|---|---|
| VERSION | See "VERSIONTYPE" | |
| DocumentDate | Date the document was created | Date |
| From | Business entity the quote is being sent from; see "PartyType" | |
| FromDBID | Database ID assigned by Ingen Software (don't make anything up - results are not predictable) | String:32 |
| To | Business entity the quote is being sent to; see "PartyType" | |
| MyQuoteDBID | Used to identify quote uniquely in OASIS | String:32 |
| MyQuoteID | Used to identify quote uniquely in OASIS | Integer |
| YourQuoteDBID | Used to identify quote uniquely in OASIS | String:32 |
| YourQuoteID | Used to identify quote uniquely in OASIS | Integer |
| ProjectName | The name of the project | String:255 |
| ProjectNameAlias | Listing of project names | String:255 |
| LocationCity | City where the job will be constructed | String:255 |
| LocationState | State / Providence where the job will be constructed | String:2 |
| Specifiers | Listing of companies influencing the purchase; see "PartyType" | |
| STAMP | Short message with importance; e.g., "NEXT DAY AIR!" | String:32 |
| MyPOID | Used to uniquely identify the PO in OASIS | Integer |
| MyPODBID | Used to uniquely identify the PO in OASIS | String:32 |
| PONumber | The customer PO number | String:32 |
| EntryDate | The order "entry" date | Date |
| SoldTo | Sold to name and address | See "PartyType" |
| BillTo | Bill to name and address | See "PartyType" |
| ShipTo | Ship to name and address | See "PartyType" |
| FreightType | Generic description of the shipping type; e.g., Ground, Will Call, Next Day Air, or shipping product. | String:32 |
| FreightAccount | Customer freight account to use | String:32 |
| Remarks | Basic notes on the order | String:256 |
| Notes | Notes to communicate about the order - typically build related notes | String |
| ShippingInstructions | Shipping notes only (how to pack and ship the product) | String |
| Terms | Terms for entering the order | String |
| Lines | The lines of the order | See "OrderLineType" |
VERSIONTYPE Fields
| Name | Description | Data Values |
|---|---|---|
| v | OASIS version being used | MUST BE '2.7.0' |
| dbv | OASIS database version being used | String:32 |
| r | OASIS version release | String:32 |
PartyType Fields
| Name | Description | Data Values |
|---|---|---|
| NAME | Company Name | String:255 |
| LINE1 | Address line 1 | String:255 |
| LINE2 | Address line 2 | String:255 |
| CITY | City Name | String:255 |
| STATE | State of provence | String:2 |
| COUNTY | County | String:32 |
| COUNTRY | Country | String:3 - prefer ISO code |
| Contacts | Listing of contacts; see "ContactType" |
ContactType Fields
| Name | Description | Data Value |
|---|---|---|
| FullName | Name of contact | String:32 |
| Email address for contact | String:32 | |
| Phone | Contacts phone number | String:32 |
OrderLineType Fileds
| Name | Description | Data Value |
|---|---|---|
| OrderLineCode | Omit or blank if part/fixture; otherwise, this indicates note, lot, or other line code | |
| MyLineUID | Internal OASIS line identifier | Integer |
| YourLineUID | Internal OASIS line identifier | Integer |
| Quantity | Count of items | Decimal:12,2 |
| FixtureType | Fixture type | String:32 |
| MyManufacturerID | Manufacturer ID used by the sender. | String:32 |
| CatalogNumber | The catalog number only (no description, etc.) | String:128 |
| Description | Marketing description of the item | String |
| Notes | Build and other notes about fixture | String |
| UnitQuantityCount | For "per 100" pricing, use the value 100; default is 1. | Decimal |
| PartQuantity | Lable for quantity (e.g. foot, meter, etc); no standards | String:32 |
| ReleaseQuantity | Number of items to release for shipment initially; enter 0 for the item to be on hold pending release. | Integer |
| NetPrice | Price where factory will pay overage (e.g. if value here is $100 and the item sell for $120, the overage will be $20) | Decimal:14,4 |
| CommissionRate | Commission rate on base price; value is stored as ##.##. 50.25 is 50.25% | Decimal:5,2 |
| OverageableSplit | Rep's take of the overage; value is stored as ##.##. 50.25 is 50.25% | Decimal:5,2 |
| SellPrice | The customer sell price; sell is required if there is no overage on the order (standard for the distributor version of OASIS) | Decimal:14,4 |
Comments
0 comments
Please sign in to leave a comment.