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

The REST services use the OAuth2 client-credentials flow. The end-to-end shape is: get a token, then call a service with that token as a Bearer credential.

1. Get an access token

POST your client credentials to the token endpoint. Paxon shares the client_id and client_secret during onboarding.

curl -X POST https://ruc-oauth.fulfilit.cloud/v1/oauth/token \
  -H 'Content-Type: application/json' \
  -d '{
    "grant_type": "client_credentials",
    "client_id": "<client_id>",
    "client_secret": "<client_secret>"
  }'

A successful response returns an access_token. See the OAuth2 guide for the full flow, the staging endpoint and token handling.

2. Make an authenticated request

Pass the token as a Bearer credential in the Authorization header. For example, to read the status of an order:

curl https://ruc-public-api.fulfilit.cloud/v1/orderService/orders/<clientId>/<orderId>/getOrderStatus \
  -H 'Authorization: Bearer <access_token>'

A request without a valid Bearer token returns 401 Unauthorized.

Where to go next