ediverse Explore the platform

Spotlight PEPPOL BIS Billing 3.0 The EU e-invoicing mandate is here — France Sept 2026, Belgium Jan 2026, Germany 2025.
BOD GetCatalog

GetCatalog

OAGIS BOD combining the Get verb with the Catalog noun. Direct canonical equivalent of EDI EDIFACT PRICAT and X12 832 messages in OAGIS 10.x's Catalog domain.

BOD purpose

The GetCatalog BOD queries a supplier or central system to fetch the current content of a product catalogue. The calling ERP specifies a filter (segment, validity period, supplier). The response is a ShowCatalog.

Structure (ApplicationArea + DataArea)

Like every OAGIS BOD, GetCatalog stacks an ApplicationArea technical envelope (Sender, BODID, CreationDateTime) and a business DataArea that contains the verb and the noun.

  • Get verb with Expression (catalogue filter).
  • Catalog noun typically empty or partial to specify the scope.

XML example

Minimal OAGIS 10.x payload for didactic purposes. Structural elements (header + at least one line) are required in any conformant implementation.

xml GetCatalog-OAGIS-10.xml
<?xml version="1.0" encoding="UTF-8"?>
<GetCatalog
    xmlns="http://www.openapplications.org/oagis/10"
    releaseID="10.11" versionID="10.11">

  <ApplicationArea>
    <Sender>
      <LogicalID>ERP-CENTRAL-EU</LogicalID>
      <ComponentID>CatalogModule</ComponentID>
      <ConfirmationCode>OnError</ConfirmationCode>
    </Sender>
    <CreationDateTime>2026-05-15T10:15:00Z</CreationDateTime>
    <BODID>5a8f7d2e-2b15-4c1a-9e6f-getcatalog-2026-0014</BODID>
  </ApplicationArea>

  <DataArea>
    <Get>
      <Expression expressionLanguage="XPath">//Catalog[Status='New']</Expression>
    </Get>
    <Catalog>
      <CatalogHeader>
        <DocumentID><ID>CAT-2026-NORTH-Q2</ID></DocumentID>
        <DocumentDateTime>2026-05-15T07:00:00Z</DocumentDateTime>
        <SupplierParty><PartyIDs><ID>5790000123456</ID></PartyIDs></SupplierParty>
        <ValidityPeriod>
          <StartDate>2026-04-01</StartDate>
          <EndDate>2026-06-30</EndDate>
        </ValidityPeriod>
      </CatalogHeader>
      <CatalogItem>
        <ItemIDs><ID>RBC-2200</ID></ItemIDs>
        <Description>Roulement à billes 22 mm</Description>
        <PriceLine><Amount currencyID="EUR">8.40</Amount></PriceLine>
      </CatalogItem>
    </Catalog>
  </DataArea>
</GetCatalog>

Use case

A procurement platform queries its 200 catalogue suppliers night after night: GetCatalog is sent with a filter on the Office Supplies segment. ShowCatalog returns the valid list as of 11:59 pm the previous night.

EDI equivalences

On an EDI gateway, this BOD typically maps to:

Further reading

Last updated: May 15, 2026

Official source: OAGi — OAGIS 10.x — OAGi — OAGIS, free distribution via oagi.org