ProductAvailability

Product Availability represents information on the availability of a specified item at a specified inventory location for a specified date.  Product availability is typically needed in the processing of customer sales orders.  It is used in this context as the object of an inquiry function.

Where the ItemQuantity indicates the number of Iterms requested and the AvailableQuantity indicates the number of items available.

Element information

Content

• Sequence [1..1]
  from type DocumentIdentificationBaseType
  ID [0..1]    Is the Identifiers of the given instance of an entity within the scope of the integration. The schemeAgencyID attribute identifies the party that provided or knows this party by the given identifier.
  RevisionID [0..1]    Is the revision of the semantically named document. The combination of the ID and its revision uniquely identifies the associated entity.
  VariationID [0..1]    
  DocumentIDSet [0..*]    
  from type HeaderBaseType
  LastModificationDateTime [0..1]    The datetime on which the object was last modified
  DocumentDateTime [0..1]    The date that document was created within the system of record.
  from group FreeFormTextGroup
  Description [0..*]    
  Note [0..*]    
  from group ReferencesGroup
  DocumentReference [0..*]    
  Attachment [0..*]    The Attachment represents binary data files that may be included within a BOD. These files replace the paper specifications and drawings attached to a BOD definition to clearly communicate design requirements. This Data Type is optional. Attachment usage is further defined by its position.
  from type ProductRequirementBaseType
  from group InventoryTransactionGroup
  GLEntityID [0..1]    A G/L entity is the smallest organizational unit for which individual financial statements must be drawn up according to relevant commercial law. It is normally the primary balancing segment of the GL Account structure. Typically, this is the owning entity for the transaction. Synonyms are Business Unit, Fund, G/L Company, Joint Venture, Non-Profit Association Name
  Facility [0..*]    A Facility identifies a location within an entity. The facility may have sub-locators identified using a sequenced identification notation e.g. Warehouse A100 Sub-Location 11, Row R10 would be represented as an array of three Facility elements with values as A100, 11, R10, name attribute as Warehouse, Sub-Location and Row and sequence attribute as 1,2 and 3 respectively.
  Status [0..1]    Indicates the status of the associated object by providing the Status Code along with a description and when the status is effective.
  ReasonCode [0..*]    Identifies the reason for an activity
  TransactionDateTime [0..1]    The datetime of occurence of the transaction
  ProductLineClassification [0..1]    Specifies something that is sold either internally or externally. It typically is a grouping of Items. SYNONYMS: Commodity Product Family Kit
  RequiredQuantity [0..1]    The quantity required of the associated entity.
  RequiredDateTime [0..1]    Indicates the date the goods or services must be delivered to the customer. Specified by the customer.
  PurchaseOrderReference [0..1]    Is a reference to a PurchaseOrder
  SalesOrderReference [0..1]    Is a reference to a SalesOrder
  ProductionOrderReference [0..1]    Is reference to a ProductionOrder
  from type ProductAvailabilityBaseType
  AvailableQuantity [0..1]    
  AvailableDateTime [0..1]    Is the datetime that the associated entities will be available.
  AllowSubstitutionIndicator [0..1]    Indicates if the buyer will accept the order if it is shipped prior to the dates on the order.
  SubstituteItemInstance [0..1]    
  1. Extension [0..1]    Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS.This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document through the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document.The Open Applications Group will make best efforts to quickly consider all proposed submissions.The Extension is always the last element in all components, except where the component has been extended inline.

Attributes

Used in

• Type AcknowledgeProductAvailabilityDataAreaType (Element DataArea)
• Type CancelAcknowledgeProductAvailabilityDataAreaType (Element DataArea)
• Type CancelProductAvailabilityDataAreaType (Element DataArea)
• Type ChangeAcknowledgeProductAvailabilityDataAreaType (Element DataArea)
• Type ChangeProductAvailabilityDataAreaType (Element DataArea)
• Type GetProductAvailabilityDataAreaType (Element DataArea)
• Type NotifyProductAvailabilityDataAreaType (Element DataArea)
• Type ProcessProductAvailabilityDataAreaType (Element DataArea)
• Type ShowProductAvailabilityDataAreaType (Element DataArea)
• Type SyncProductAvailabilityDataAreaType (Element DataArea)
• Type SyncResponseProductAvailabilityDataAreaType (Element DataArea)

Sample instance

<ProductAvailability>
   <ID/>
   <RevisionID>normalizedString</RevisionID>
   <VariationID>normalizedString</VariationID>
   <DocumentIDSet>
      <ID/>
   </DocumentIDSet>
   <LastModificationDateTime></LastModificationDateTime>
   <DocumentDateTime></DocumentDateTime>
   <Description/>
   <Note/>
   <DocumentReference>
      <ID/>
      <RevisionID>normalizedString</RevisionID>
      <VariationID>normalizedString</VariationID>
      <DocumentIDSet>
         <ID/>
      </DocumentIDSet>
      <DocumentDateTime></DocumentDateTime>
      <Description/>
      <Note/>
      <Status>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Description/>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Status>
      <LineNumberID/>
      <LineIDSet>
         <ID/>
      </LineIDSet>
      <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>
   </DocumentReference>
   <Attachment>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <EmbeddedDataBinaryObject/>
      <URI>normalizedString</URI>
      <ISBN>normalizedString</ISBN>
      <FileName/>
      <DocumentDateTime></DocumentDateTime>
      <Description/>
      <Note/>
      <FileTypeCode>normalizedString</FileTypeCode>
      <FileSizeQuantity>1.0</FileSizeQuantity>
      <Title/>
      <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>
   </Attachment>
   <GLEntityID>normalizedString</GLEntityID>
   <Facility>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <Name/>
      <Description/>
      <Note/>
      <Address>
         <ID/>
         <IDSet>...
         </IDSet>
         <Name/>
         <AttentionOfName/>
         <CareOfName/>
         <BuildingNumber/>
         <BuildingName/>
         <BlockName/>
         <StreetName/>
         <StreetTypeCode>normalizedString</StreetTypeCode>
         <Floor/>
         <Unit/>
         <StairCase/>
         <Door/>
         <PostOfficeBox/>
         <DeliveryPointID>normalizedString</DeliveryPointID>
         <PlotID>normalizedString</PlotID>
         <CityName/>
         <CitySubDivisionName/>
         <CountrySubDivisionCode>token</CountrySubDivisionCode>
         <CountryCode>token</CountryCode>
         <PostalCode>normalizedString</PostalCode>
         <Status>...
         </Status>
         <Preference>...
         </Preference>
         <GeographicalCoordinate>...
         </GeographicalCoordinate>
         <Usage>...
         </Usage>
         <Extension>.......................................
         </Extension>
      </Address>
      <Coordinate>
         <ID/>
         <IDSet>...
         </IDSet>
         <Description/>
         <ReferenceSystemID/>
         <VerticalReferenceSystemID/>
         <VerticalMeasure>1.0</VerticalMeasure>
         <LatitudeMeasure>1.0</LatitudeMeasure>
         <LongitudeMeasure>1.0</LongitudeMeasure>
         <VerticalAccuracyMeasure>1.0</VerticalAccuracyMeasure>
         <HorizontalAccuracyMeasure>1.0</HorizontalAccuracyMeasure>
         <Extension>.......................................
         </Extension>
      </Coordinate>
      <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>
   </Facility>
   <Status>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <Code/>
      <Description/>
      <ReasonCode>normalizedString</ReasonCode>
      <Reason/>
      <EffectiveTimePeriod>
         <InclusiveIndicator>true</InclusiveIndicator>
         <StartDateTime></StartDateTime>
         <StartTime>token</StartTime>
         <Duration>P1Y2M3DT10H</Duration>
         <EndDateTime></EndDateTime>
         <EndTime>token</EndTime>
      </EffectiveTimePeriod>
      <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>
   </Status>
   <ReasonCode>normalizedString</ReasonCode>
   <TransactionDateTime></TransactionDateTime>
   <ProductLineClassification>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <UNSPSCCode>normalizedString</UNSPSCCode>
      <Codes>
         <Code/>
      </Codes>
      <Description/>
      <Note/>
      <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>
   </ProductLineClassification>
   <RequiredQuantity>1.0</RequiredQuantity>
   <RequiredDateTime></RequiredDateTime>
   <PurchaseOrderReference>
      <ID/>
      <RevisionID>normalizedString</RevisionID>
      <VariationID>normalizedString</VariationID>
      <DocumentIDSet>
         <ID/>
      </DocumentIDSet>
      <DocumentDateTime></DocumentDateTime>
      <Description/>
      <Note/>
      <Status>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Description/>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Status>
      <LineNumberID/>
      <LineIDSet>
         <ID/>
      </LineIDSet>
      <ReleaseNumberID>normalizedString</ReleaseNumberID>
      <ScheduleLineNumberID>normalizedString</ScheduleLineNumberID>
      <SubLineNumberID>normalizedString</SubLineNumberID>
      <OrderQuantity>1.0</OrderQuantity>
      <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>
   </PurchaseOrderReference>
   <SalesOrderReference>
      <ID/>
      <RevisionID>normalizedString</RevisionID>
      <VariationID>normalizedString</VariationID>
      <DocumentIDSet>
         <ID/>
      </DocumentIDSet>
      <DocumentDateTime></DocumentDateTime>
      <Description/>
      <Note/>
      <Status>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Description/>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Status>
      <LineNumberID/>
      <LineIDSet>
         <ID/>
      </LineIDSet>
      <ReleaseNumberID>normalizedString</ReleaseNumberID>
      <ScheduleLineNumberID>normalizedString</ScheduleLineNumberID>
      <SubLineNumberID>normalizedString</SubLineNumberID>
      <OrderQuantity>1.0</OrderQuantity>
      <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>
   </SalesOrderReference>
   <ProductionOrderReference>
      <ID/>
      <RevisionID>normalizedString</RevisionID>
      <VariationID>normalizedString</VariationID>
      <DocumentIDSet>
         <ID/>
      </DocumentIDSet>
      <DocumentDateTime></DocumentDateTime>
      <Description/>
      <Note/>
      <Status>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Description/>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Status>
      <LineNumberID/>
      <LineIDSet>
         <ID/>
      </LineIDSet>
      <ItemIdentification>
         <ID/>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
         <ItemIDSet>...
         </ItemIDSet>
         <Extension>.......................................
         </Extension>
      </ItemIdentification>
      <Facility>
         <ID/>
         <IDSet>...
         </IDSet>
         <Name/>
         <Description/>
         <Note/>
         <Address>...
         </Address>
         <Coordinate>...
         </Coordinate>
         <Extension>.......................................
         </Extension>
      </Facility>
      <SerialLot>
         <ID/>
         <IDSet>...
         </IDSet>
         <ItemQuantity>1.0</ItemQuantity>
         <Lot>...
         </Lot>
         <Disposition>...
         </Disposition>
         <SerialNumberID>normalizedString</SerialNumberID>
         <ParentSerialNumberID>normalizedString</ParentSerialNumberID>
         <Description/>
         <Note/>
         <Extension>.......................................
         </Extension>
      </SerialLot>
      <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>
   </ProductionOrderReference>
   <AvailableQuantity>1.0</AvailableQuantity>
   <AvailableDateTime></AvailableDateTime>
   <AllowSubstitutionIndicator>true</AllowSubstitutionIndicator>
   <SubstituteItemInstance>
      <ID/>
      <RevisionID>normalizedString</RevisionID>
      <VariationID>normalizedString</VariationID>
      <ItemIDSet>
         <ID/>
      </ItemIDSet>
      <CustomerItemIdentification>
         <ID/>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
         <ItemIDSet>...
         </ItemIDSet>
         <Extension>.......................................
         </Extension>
      </CustomerItemIdentification>
      <ManufacturerItemIdentification>
         <ID/>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
         <ItemIDSet>...
         </ItemIDSet>
         <Extension>.......................................
         </Extension>
      </ManufacturerItemIdentification>
      <SupplierItemIdentification>
         <ID/>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
         <ItemIDSet>...
         </ItemIDSet>
         <Extension>.......................................
         </Extension>
      </SupplierItemIdentification>
      <UPCID>normalizedString</UPCID>
      <EPCID>normalizedString</EPCID>
      <GTINID>normalizedString</GTINID>
      <UID>normalizedString</UID>
      <RFID>normalizedString</RFID>
      <SerialNumberID>normalizedString</SerialNumberID>
      <SerialLot>
         <ID/>
         <IDSet>...
         </IDSet>
         <ItemQuantity>1.0</ItemQuantity>
         <Lot>...
         </Lot>
         <Disposition>...
         </Disposition>
         <SerialNumberID>normalizedString</SerialNumberID>
         <ParentSerialNumberID>normalizedString</ParentSerialNumberID>
         <Description/>
         <Note/>
         <Extension>.......................................
         </Extension>
      </SerialLot>
      <ReferenceDesignatorID>normalizedString</ReferenceDesignatorID>
      <FindNumberID>normalizedString</FindNumberID>
      <Lot>
         <ID/>
         <IDSet>...
         </IDSet>
         <LotIDs>...
         </LotIDs>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Quantity/>
         <SerialNumberID>normalizedString</SerialNumberID>
         <RFID>normalizedString</RFID>
         <Disposition>...
         </Disposition>
         <Extension>.......................................
         </Extension>
      </Lot>
      <Quantity/>
      <Description/>
      <Note/>
      <Classification>
         <ID/>
         <IDSet>...
         </IDSet>
         <UNSPSCCode>normalizedString</UNSPSCCode>
         <Codes>...
         </Codes>
         <Description/>
         <Note/>
         <Extension>.......................................
         </Extension>
      </Classification>
      <Specification>
         <ID/>
         <IDSet>...
         </IDSet>
         <Property>...
         </Property>
         <Extension>.......................................
         </Extension>
      </Specification>
      <HazardousMaterial>
         <ID/>
         <IDSet>...
         </IDSet>
         <MFAGID>normalizedString</MFAGID>
         <TechnicalName/>
         <PlacardEndorsement/>
         <PlacardNotation/>
         <MarinePollutionLevelCode>normalizedString</MarinePollutionLevelCode>
         <ToxicityZoneCode>normalizedString</ToxicityZoneCode>
         <Temperature/>
         <FlashpointTemperature>1.0</FlashpointTemperature>
         <PrimaryEntryRoute/>
         <Description/>
         <EmergencyContact>...
         </EmergencyContact>
         <HazardousClass/>
         <PackingGroup/>
         <Extension>.......................................
         </Extension>
      </HazardousMaterial>
      <Packaging>
         <ID/>
         <IDSet>...
         </IDSet>
         <Description/>
         <Note/>
         <Dimensions>...
         </Dimensions>
         <UPCPackagingLevelCode>normalizedString</UPCPackagingLevelCode>
         <PerPackageQuantity>1.0</PerPackageQuantity>
         <CapacityPerPackageQuantity>1.0</CapacityPerPackageQuantity>
         <OuterPackID/>
         <InnerPackID/>
         <Extension>.......................................
         </Extension>
      </Packaging>
      <Dimensions>
         <ID/>
         <IDSet>...
         </IDSet>
         <WidthMeasure>1.0</WidthMeasure>
         <LengthMeasure>1.0</LengthMeasure>
         <HeightMeasure>1.0</HeightMeasure>
         <Description/>
         <Measure/>
         <VolumeMeasure>1.0</VolumeMeasure>
         <NetVolumeMeasure>1.0</NetVolumeMeasure>
         <GrossVolumeMeasure>1.0</GrossVolumeMeasure>
         <DimensionRandomSizeIndicator>true</DimensionRandomSizeIndicator>
         <SizeLimitRange>...
         </SizeLimitRange>
         <WeightRange>...
         </WeightRange>
         <NetWeightMeasure>1.0</NetWeightMeasure>
         <TareWeightMeasure>1.0</TareWeightMeasure>
         <GrossWeightMeasure>1.0</GrossWeightMeasure>
         <Extension>.......................................
         </Extension>
      </Dimensions>
      <ExportControl>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <CountryCode>token</CountryCode>
         <RegionCode>normalizedString</RegionCode>
         <EncryptionStatusCode>normalizedString</EncryptionStatusCode>
         <Extension>.......................................
         </Extension>
      </ExportControl>
      <HarmonizedTariff>
         <ID/>
         <IDSet>...
         </IDSet>
         <CountryCode>token</CountryCode>
         <RegionCode>normalizedString</RegionCode>
         <Extension>.......................................
         </Extension>
      </HarmonizedTariff>
      <Trademark>
         <ID/>
         <IDSet>...
         </IDSet>
         <MarkAttachment>...
         </MarkAttachment>
         <MarkOwnerParty>...
         </MarkOwnerParty>
         <MarkEffectivity>...
         </MarkEffectivity>
         <Extension>.......................................
         </Extension>
      </Trademark>
      <DocumentReference>
         <ID/>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
         <DocumentIDSet>...
         </DocumentIDSet>
         <DocumentDateTime></DocumentDateTime>
         <Description/>
         <Note/>
         <Status>...
         </Status>
         <LineNumberID/>
         <LineIDSet>...
         </LineIDSet>
         <Extension>.......................................
         </Extension>
      </DocumentReference>
      <Attachment>
         <ID/>
         <IDSet>...
         </IDSet>
         <EmbeddedDataBinaryObject/>
         <URI>normalizedString</URI>
         <ISBN>normalizedString</ISBN>
         <FileName/>
         <DocumentDateTime></DocumentDateTime>
         <Description/>
         <Note/>
         <FileTypeCode>normalizedString</FileTypeCode>
         <FileSizeQuantity>1.0</FileSizeQuantity>
         <Title/>
         <Extension>.......................................
         </Extension>
      </Attachment>
      <CountryOfOriginCode>token</CountryOfOriginCode>
      <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>
   </SubstituteItemInstance>
   <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>
</ProductAvailability>