Introduction
The BTO order definition is published as draft on this page. You can contribute to the BTO order definition by adding comments to the field definitions.
Background
A customer panel is currently active in developing the BTO (build to order) order process and as a first deliverable we’ve work on the BTO ordering. Other modules like material creation and order validation are currently worked on.
An overview of the process is below.
BTO in PIP3A4 Purchase Order Request
We decided to incorporate the BTO fields into the existing order schema and thus not design a complete new schema. This because the BTO fields are an addition to the current order. Like the current ProductLineItem element is still valid for ordering bundles and only requires some additional fields.
We’ve identified header and line level fields required for BTO ordering. We’ve added a BTOOrder element on header level and BTOLine to the line level.
An example XML is available:
b132147e-6934-4407-98ce-c1c83ce128ccDECIDED0d33522c-699f-476e-aa74-f3fb4f14409dDraft for BTOOrder element on header level- Draft for BTOOrder element on header level
Parent | Field name | Description | Type | Cardinality | XML element / attribute | XML properties |
/ | ||||||
/ | Order | Element | 1 | Pip3A4PurchaseOrderRequest | Root element | |
Order | Order header | Element | 1 | PurchaseOrder | Element | |
Order / Order header | BTO | Element | 1 | BTOOrder | Element | |
Order / Order header / BTO / Shipment | Shipment Type | Shipment to enduser by Reseller, Distributor or Manufacturer | Enum | 1 | ShipBy/GlobalPartnerRoleClassificationCode | Enumeration (Reseller, Distributor, Manufacturer) |
Order / Order header / BTO | End User | Element | 1 | EndUser | Element | |
Order / Order header / BTO / End User | End user business name | Company name of the end user | String | 1 | PartnerDescription/BusinessDescription/businessName/FreeFormText | Attribute: string |
Order / Order header / BTO / End User | End user name | Name of the end user | String | 1 | PartnerDescription/ContactInformation/contactName/FreeFormText | Attribute: string |
Order / Order header / BTO / End User | End user phone | Phone of the end user | String | 1 | PartnerDescription/ContactInformation/CommunicationsNumber | Attribute: string |
Order / Order header / BTO / End User | End user fax | Fax of the end user | String | 0..1 | PartnerDescription/ContactInformation/facsimileNumber | Attribute: string |
Order / Order header / BTO / End User | End user email | Email of the end user | 1 | PartnerDescription/ContactInformation/EmailAddress | Attribute: string | |
Order / Order header | End user reference | BID / Bundle / order reference / etc. | String | 1 | PurchaseOrder/DocumentReference/ProprietaryDocumentIdentifier | Attribute: string |
Order / Order header | Qualifier | Fixed: EndUser | PurchaseOrder/DocumentReference/GlobalDocumentReferenceTypeCode | Enumeration | ||
- Draft for BTOLine element on line level
Parent | Field name | Description | Type | Cardinality | XML element / attribute | XML properties |
Order | Order Line | Element | 1..n | ProductLineItem | Element | |
Order / Order line | Bid ID | ID of the BID provided by the manufacturer | String | 1 | ProductLineItem/DocumentLineReference/ProprietaryDocumentIdentifier | Attribute: string |
Order / Order line | Qualfier | Fixed: Contract | ProductLineItem/DocumentLineReference/GlobalDocumentReferenceTypeCode | Enumeration | ||
Order / Order line | Requested Delivery Date | Requested delivery date (goods receipt) by the end user | Date | 1 | requestedEvent/TransportationEvent/DateStamp | DateTimeStamp ([0-9]{8}T[0-9]{6}) |
Order / Order line | Qualfier | Ship or Delivery | requestedEvent/TransportationEvent/GlobalTransportEventCode | Enumeration(Ship,Delivery) | ||
Order / Order line | Quantity | The number / quantity of bundles/configurations ordered | Numeric | 1 | OrderQuantity/requestedQuantity/ProductQuantity | Attribute: xsd:nonNegativeInteger |
Order / Order line | Bundle ID | Id for the bundle provided by the manufacturer | String | 1 | PartnerProductIdentification/ProprietaryProductIdentifier | Attribute: string |
Order / Order line | Qualfier | Fixed: Manufacturer | PartnerProductIdentification/GlobalPartnerClassificationCode | Enumeration | ||
Order / Order line | Bundle Price | Amount for each bundle provided by the manufacturer | Amount | 1 | requestedUnitPrice/FinancialAmount/MonetaryAmount | Attribute: decimal |
Order / Order line | Currency | Currency | String | 1 | requestedUnitPrice/FinancialAmount/GlobalCurrencyCode | Attribute: string |
Order / Order line | BTO Line | BTOLine | Element | |||
Order / Order line / BTO Line | Bid Version | Version of the BID provided by the manufacturer | String | 0..1 | BTOLine/BidVersion | Attribute: string |
Order / Order line / BTO Line | Validate Bid | Instruction whether this bid needs to be validated and bounced by Onetrail | Boolean | 1 | BTOLine/ValidateBid | Enumeration (Yes,No) |
Order / Order line / BTO Line | Manufacturer GLN | Manufacturer of the configuration | String | 0..1 | BTOLine/SuppliedBy/PartnerDescription/BusinessDescription/GlobalBusinessIdentifier | |
Order / Order line / BTO Line | Qualfier | Fixed: Manufacturer | BTOLine/SuppliedBy/PartnerDescription/BusinessDescription/GlobalPartnerRoleClassificationCode | Enumeration | ||
Order / Order line / BTO Line | Bundle | Element | 0..n | BundleLineItem | Element | |
Order / Order line / BTO Line / Bundle | Sequence Number | Sequence number, the sequence of the bundle items is important to some manufacturers | Numeric | 1 | BundleLineItem/SequenceNumber | Attribute: xsd:nonNegativeInteger |
Order / Order line / BTO Line / Bundle | SKU | Internal product ID from distributor | String | 1 | BundleLineItem/PartnerProductIdentification/ProprietaryProductIdentifier | Attribute: string |
Order / Order line / BTO Line / Bundle | Qualfier | Fixed: Seller | String | 1 | BundleLineItem/PartnerProductIdentification/GlobalPartnerClassificationCode | Enumeration |
Order / Order line / BTO Line / Bundle | manufacturer Part Number | Internal product ID from manufacturer | String | 1 | BundleLineItem/PartnerProductIdentification/ProprietaryProductIdentifier | Attribute: string |
Order / Order line / BTO Line / Bundle | Qualfier | Fixed: Manufacturer | String | 1 | BundleLineItem/PartnerProductIdentification/GlobalPartnerClassificationCode | Enumeration |
Order / Order line / BTO Line / Bundle | Localisation Code | Required if the bid is not country specific | String | 0..1 | BundleLineItem/PartnerProductIdentification/revisionIdentifier | Attribute: string |
Order / Order line / BTO Line / Bundle | Quantity | Number of items in one config | Numeric | 1 | BundleLineItem/OrderQuantity/requestedQuantity/ProductQuantity | Attribute: xsd:nonNegativeInteger |
Order / Order line / BTO Line / Bundle | Unit Price | Amount for each bundle provided by the manufacturer | Amount | 1 | BundleLineItem/requestedUnitPrice/FinancialAmount/MonetaryAmount | Attribute: decimal |
Order / Order line / BTO Line / Bundle | Currency | Currency | String | 1 | BundleLineItem/requestedUnitPrice/FinancialAmount/GlobalCurrencyCode | Attribute: string |
