Getting started

What the RUC platform is, the eight services it exposes, and how to make your first authenticated API call.

What RUC is

RUC is Paxon's 3PL and logistics middleware platform. It connects a client's order management, ERP and webstore systems to Paxon's warehouse, transport and carrier operations across Europe.

Integration happens through two complementary channels, with the XML feed API as the core for exchanging order and product data:

  • An XML feed API, secured with an API key, for the bulk exchange of catalogue, order, purchase-order and return feeds between client and Paxon systems.
  • A set of synchronous REST APIs, secured with OAuth2, for querying and managing orders, inventory, work orders, facilities, items and webhooks.

Partners that cannot integrate over a live API can exchange the same XML feeds over SFTP, supported out of the box.

All REST services follow the OpenAPI 3.0.3 standard. Every endpoint, request body and response is documented in the interactive reference, where you can inspect schemas and build requests against your own credentials.

The eight services

ServiceWhat it doesReference
XML APIInbound and outbound XML feeds: catalogue (CAT), orders (NO), purchase orders / ASN (PO), returns (RMA), and the matching outbound feeds./reference/xml-inbound
OrderQuery order status and detail, cancel or update orders and order lines, retrieve RMAs, documents, OLPNs and carrier service codes./reference/order
InventoryLook up stock levels and detailed inventory attributes for one or many SKUs, including historical snapshots for reporting./reference/inventory
Work OrderCreate, update, cancel and list work orders that assemble finished goods from component SKUs./reference/workorder
FacilityList facilities and fetch the details of a specific facility./reference/facility
Item MasterFetch product details for a single SKU or a list of SKUs./reference/item-master
Carrier DeterminationIdentify the most suitable carrier and service for a shipment using a price matrix and business rules./reference/cdm
WebhookRegister, update, inspect and delete webhooks so Paxon can push events to your endpoints./reference/webhook

Quickstart: your first call

Your first call to RUC is an XML feed. Send a CAT (catalogue) feed first: it registers your products so later purchase-order, return and sales-order feeds can reference known SKUs.

1. Send a CAT feed

POST a catalogue payload to your per-client endpoint, authenticated with the X-API-KEY Paxon issues during onboarding:

curl -X POST https://rucapi.fulfilit.cloud/feeds/<clientId>/CAT \
  -H 'X-API-KEY: <api_key>' \
  -H 'Content-Type: text/xml' \
  --data-binary @cat.xml

cat.xml is an itemMaster document with one or more items. The full payload, every field, and the other feed types (PO, RMA, NO) are in the XML API guide. Test against the staging host rucapi.stage.fulfilit.cloud before going live.

2. Read the acknowledgement

RUC answers synchronously with an apiResponse ACK: a correlation token, the parse-time disposition, and — for a single-item CAT — the SKU as objectId.

<?xml version="1.0" encoding="UTF-8"?>
<apiResponse>
	<token>b7e3c1a90d2f4e6a8c5b9f1e2d3a4c6b</token>
	<success>true</success>
	<feedType>CAT</feedType>
	<objectId>SKU0001</objectId>
</apiResponse>

A second, asynchronous outbound feed follows once Paxon's systems finish processing — see the Integration flow guide.

Calling the JSON REST services

The seven REST services (Order, Inventory, Work Order, Facility, Item Master, Carrier Determination and Webhook) are queried over OAuth2-secured JSON. Get an access token and send it as a Bearer credential — the full flow is in the Authentication guide.

Where to go next

  • XML API — every feed type (CAT, PO, RMA, NO), schemas and the acknowledgement contract.
  • Integration flow — how inbound and outbound feeds and the REST services fit together end to end.
  • OAuth2 authentication — the client-credentials flow for the JSON REST services in full.
  • Webhooks — subscribe to events instead of polling.
  • Carrier events — track-and-trace milestones and event payloads.