This document describes the XML data used by OASIS internally to indicate order shipping status. 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-OrderStatus.xsd (6 KB download)
Example
The example is downloadable here: OrderStatusExample.xml (4 KB download)
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" | |
| YourQuoteID | Used to identify quote uniquely in OASIS | Integer |
| 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" |
| Lines | The lines of the order | See "OrderStatusLineType" |
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 |
| Shipments | Listing of OrderStatusShipmentType; do not use if "Lines" is populated | |
| Lines | Listing of OrderStatusLine to indicate partial item shipment (e.g. the bolts are shipping for a pole); do not use if "Shipments" is populated |
ContactType Fields
| Name | Description | Data Value |
|---|---|---|
| Quantity | Number of items shipped or scheduled to ship | Integer |
| DateType | 1=schedule date; 2=actual shipment with all fields provided | Integer |
| MFGSalesOrder | The factory sales order number | String:32 |
| Date | Schedule date (DateType=1) or actual ship date (DateType=2) | Date |
| SCAC | Highly prefer the standardized carrier code, but the carrier name can be used if the standardized carrier code can not be provided or does not exist. (Required if DateType=2). | String:32 |
| PRONumber | The PRO or tracking number as provided by the carrier. NOTE: Intermediate ship-to locations (e.g. international shipments) should not be sent. (Required if DateType=2). | String:32 |
| MFGWarehouseID |
A short code representing the factory warehouse; typically the city and/ or state code. The goal is to help the end user of the information estimate the shipping time from the warehouse to the job site. (Required if DateType=2). |
String:32 |
Article attachments:
Comments
0 commentsArticle is closed for comments.