GetProductAvailability

The purpose of the GetProductAvailability is to enable requests of product availability data by an Order Management business application to an Available to Promise (ATP) or Production business application.  The business process scenario is the Order Management application interacting with the Available to Promise or Production application in order to determine availability of a product for the customer.

This scenario is commonly referred to as Make to Order or Build to Order.
The response to this request is the ShowProductAvailability.

Element information

Namespace: http://www.openapplications.org/oagis/10

Schema document: GetProductAvailability.xsd

Type: GetProductAvailabilityType

Properties: Global, Qualified, ID: oagis-id-b1e79dfc6a3e48eb8c1d06d107029d3d

Content

Sequence [1..1]
1. DataArea [1..1] Is where the information that the BOD message carries is provided, in this case GetProductAvailability. The information consists of a Verb and one or more Nouns. The verb (Get) indicates the action to be performed on the Noun (ProductAvailability).

Attributes

Name	Occ	Type	Description	Notes
releaseID	[1..1]	NormalizedStringType	OAGIS Release this BOD Instances belongs or the OAGIS release that the derivative work is based on.	from type BusinessObjectDocumentType
versionID	[0..1]	NormalizedStringType	Indicates the version of the given BOD definition.	from type BusinessObjectDocumentType
systemEnvironmentCode	[0..1]	SystemEnvironmentCodeContentType	Indicates whether this BOD is being sent in a "Test" or a "Production" mode. If the BOD is being sent in a test mode, it's information should not affect the business operation. However, if the BOD is sent in "Production" mode it is assumed that all test has been complete and the contents of the BOD are to affect the operation of the receiving business application(s).	Default value is "Production". from type BusinessObjectDocumentType
languageCode	[0..1]	LanguageCodeContentType	Indicates the language that the contents of the BOD is in unless otherwise stated.	Default value is "en-US". from type BusinessObjectDocumentType

Sample instance

<GetProductAvailability releaseID="normalizedString">
   <ApplicationArea>
      <Sender>
         <LogicalID>normalizedString</LogicalID>
         <ComponentID>normalizedString</ComponentID>
         <TaskID>normalizedString</TaskID>
         <ReferenceID>normalizedString</ReferenceID>
         <ConfirmationCodes>...
         </ConfirmationCodes>
         <AuthorizationID>normalizedString</AuthorizationID>
      </Sender>
      <Receiver>
         <LogicalID>normalizedString</LogicalID>
         <ComponentID>normalizedString</ComponentID>
         <ID/>
      </Receiver>
      <CreationDateTime></CreationDateTime>
      <Signature>
         <!--any element-->
      </Signature>
      <ScenarioID>normalizedString</ScenarioID>
      <CorrelationID>normalizedString</CorrelationID>
      <BODID>normalizedString</BODID>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </ApplicationArea>
   <DataArea>
      <Get>
         <Expression>token</Expression>
      </Get>
      <ProductAvailability>
         <ID/>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
         <DocumentIDSet>...
         </DocumentIDSet>
         <LastModificationDateTime></LastModificationDateTime>
         <DocumentDateTime></DocumentDateTime>
         <Description/>
         <Note/>
         <DocumentReference>...
         </DocumentReference>
         <Attachment>...
         </Attachment>
         <GLEntityID>normalizedString</GLEntityID>
         <Facility>...
         </Facility>
         <Status>...
         </Status>
         <ReasonCode>normalizedString</ReasonCode>
         <TransactionDateTime></TransactionDateTime>
         <ProductLineClassification>...
         </ProductLineClassification>
         <RequiredQuantity>1.0</RequiredQuantity>
         <RequiredDateTime></RequiredDateTime>
         <PurchaseOrderReference>...
         </PurchaseOrderReference>
         <SalesOrderReference>...
         </SalesOrderReference>
         <ProductionOrderReference>...
         </ProductionOrderReference>
         <AvailableQuantity>1.0</AvailableQuantity>
         <AvailableDateTime></AvailableDateTime>
         <AllowSubstitutionIndicator>true</AllowSubstitutionIndicator>
         <SubstituteItemInstance>...
         </SubstituteItemInstance>
         <Extension>.......................................
         </Extension>
      </ProductAvailability>
   </DataArea>
</GetProductAvailability>