Skip to main content

My partner sends a custom XML file — can I consume it as a Mosaic payload?

A
Written by Ashwath Kirthyvasan
Updated over 2 weeks ago

Audience: Integrators, API developers, B2B integration teams using Mosaic (simplified JSON)

This article explains whether Orderful can convert a custom XML file received over MFT into a Mosaic (simplified JSON) payload for consumption by your integration. For background on Any file over MFT, see Any file over MFT.


How Any file over MFT works today — expected behavior

Any file over MFT is a pass-through. When Orderful receives a custom XML file from your trading partner, it stores the file and delivers it to you exactly as received — without any parsing, transformation, or conversion. The file is available in its original format via the transaction details page, the content endpoint (GET /v4/transactions/{id}/content), or your configured inbound communication channel.

Orderful does not produce a Mosaic JSON representation of any file transactions in the current release.


The issue

If your integration is built to consume Mosaic JSON — for example via the Poller or HTTP channel — it will receive either a downloadContentHref link to the raw file (Poller) or the raw file bytes (HTTP). There is no Mosaic JSON body available for any file transactions. This applies to all any file formats — custom XML, CSV, PDF, and others.


What to do

If your downstream system expects Mosaic JSON, you will need to handle the conversion from your partner's custom XML in your own integration layer, outside of Orderful, before passing data to your downstream systems.

For Poller integrations, retrieve the raw file via the downloadContentHref URL, then transform it in your integration layer before processing.


What is coming

Conversion from custom file formats to Mosaic JSON is not available today, but it is the direction Orderful is heading. Contact your Orderful account team if this is a priority for your integration.


What to Send Orderful Support

If you are unsure how to retrieve and handle the raw file content in your integration, contact [email protected] with:

  • Your inbound communication channel type (Poller, HTTP, AS2, FTP, SFTP)

  • The custom file format you are receiving (e.g. custom XML, CSV)

  • A description of what your downstream system expects and where the integration is breaking


Frequently Asked Questions

Does this limitation apply to other file formats too?

Yes. For all supported any file formats — JSON, XML, CSV, PDF, and JPEG — Orderful currently delivers the file as-is, with no conversion to Mosaic JSON. Note that some formats like PDF and JPEG are binary documents that would never be candidates for Mosaic conversion regardless.

Can Orderful validate that the incoming file matches an expected schema?

Not in the current release. In MFT mode, validation covers routing metadata only. Schema-level validation for custom files is not available today, but it is the direction Orderful is heading.

My partner sends standard X12 — does this apply to me?

No. Standard X12 and EDIFACT transactions are fully processed by Orderful, including conversion to Mosaic JSON. This limitation only applies to any file over MFT transactions.

Did this answer your question?