Integration flow
An end-to-end view of how orders, inventory, work orders and feeds move between a client system and Paxon.
Overview
A RUC integration combines two channels: the XML feed API for bulk data exchange, and the REST services for synchronous queries and operational actions. Inbound feeds flow from the client into Paxon; outbound feeds flow from Paxon back to the client. The REST services sit alongside the feeds for real-time lookups and updates.
This guide gives the end-to-end picture. For endpoint-by-endpoint detail, follow the reference links; for authentication, see the OAuth2 guide.
Inbound: client to Paxon
Inbound XML feeds carry master and transactional data into Paxon. Each feed is a raw XML payload POSTed to the XML API, validated against its XSD, and acknowledged with a token. Partners that cannot POST over a live connection can deliver the same feeds over SFTP instead; the payloads and schemas are identical, only the transport differs.
| Feed | Purpose | Schema |
|---|---|---|
| CAT | Catalogue / item master — product information. | /xsd/CAT.xsd |
| NO | Sales orders to be fulfilled by Paxon. | /xsd/NO.xsd |
| PO | Purchase order / ASN — deliveries Paxon should expect. | /xsd/PO.xsd |
| RMA | Return merchandise authorisation. | /xsd/RMA.xsd |
A typical sequence: send a CAT feed so Paxon knows your products, send PO feeds so the warehouse expects inbound stock, then send NO feeds as customer orders arrive to be picked, packed and shipped.
Outbound: Paxon to client
Paxon pushes outbound XML feeds back to a client endpoint over HTTPS as orders and stock move through the warehouse. Your endpoint accepts the raw XML payload and replies with HTTP 200.
| Feed | Purpose | Schema |
|---|---|---|
| ADJ | Stock-level adjustments for SKUs. | /xsd/ADJ.xsd |
| INV | Full inventory snapshot of all items. | /xsd/INV.xsd |
| OS | Order status updates as orders progress. | /xsd/OS.xsd |
| GR | Goods received and put away against a PO. | /xsd/GR.xsd |
| RS | Returns received from customers. | /xsd/RS.xsd |
| IMS | Item master synchronisation from the warehouse system. | /xsd/IMS.xsd |
| ACK | Final transaction disposition — accepted or rejected. | /xsd/ApiResponse.xsd |
Every inbound feed is acknowledged twice: a synchronous response with a correlation token, then a later ACK carrying the final accepted-or-rejected disposition once Paxon's downstream systems have processed the feed.
Real-time REST alongside the feeds
The REST services complement the feed exchange with synchronous operations:
- Order — check status, retrieve full detail, cancel or amend an order or order line, and look up RMAs, documents and OLPNs. See /reference/order.
- Inventory — query live stock levels and detailed attributes for one or many SKUs. See /reference/inventory.
- Work Order — request assembly of finished goods from component SKUs, then track completion. See /reference/workorder.
- Item Master and Facility — look up product and facility reference data. See /reference/item-master and /reference/facility.
Work orders
A work order asks Paxon to assemble a new item (the finished good) from a set of existing items (components). Both the finished good and its component SKUs must already be known to Paxon before processing.
As assembly runs, Paxon emits work order completion events reporting how much of each component was consumed and how many finished goods were produced. Processing can happen in batches, so multiple completion events may arrive for one work order. Subscribe to these events through the Webhook service.
Events and tracking
Beyond feeds and synchronous calls, Paxon can push event streams to your endpoints:
- Order status updates as orders move through the warehouse.
- Carrier events for track-and-trace once a parcel ships. See the Carrier events guide.
Both can be delivered through webhook subscriptions. See the Webhooks guide for how to register an endpoint.
Next
- OAuth2 authentication — secure the REST calls.
- Webhooks — receive events instead of polling.
- Carrier events — milestone and event payloads.