Orders

Fluid Rep APIs (1.0)

The Fluid Rep APIs provide endpoints for authenticated Reps (Users) to access their own data and perform actions on their behalf.

Authentication

These APIs use User tokens for authentication. User tokens are obtained through:

  • Magic link authentication
  • JWT exchange (/api/user_companies/jwt_exchange)
  • Token exchange (/api/user_companies/token_exchange)

Unlike Company APIs which use Company API tokens for administrative access, Rep APIs authenticate the individual user and provide access to their personal data, orders, team, and settings.

For Company-level management APIs, see the Company APIs documentation.

Download OpenAPI description
rep.json
rep.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/rep/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Authentication

Operations

User Profile

Operations

Contacts

Operations

Tasks

Operations

Media

Operations

Libraries

Operations

Orders

Operations

List orders

Request

Returns all orders associated with the current user.

This includes orders placed by the user's contacts and customers, as well as the user's own purchases. Orders are sorted by date descending.

Query
statusstring

Filter by order status: pending, processing, shipped, delivered, cancelled

from_datestring

Filter orders from this date (ISO 8601)

to_datestring

Filter orders to this date (ISO 8601)

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/rep/api/orders?from_date=string&status=string&to_date=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

orders retrieved

Bodyapplication/jsonArray [
object
]
Response
application/json
[
  {
    "id": 78234,
    "order_number": "DM-2024-78234",
    "status": "shipped",
    "total": 249.99,
    "subtotal": 224.99,
    "tax": 15,
    "shipping": 10,
    "currency": "USD",
    "items_count": 3,
    "created_at": "2024-01-15T14:30:00Z",
    "shipped_at": "2024-01-16T09:00:00Z",
    "tracking_number": "1Z999AA10123456784",
    "tracking_url": "https://ups.com/track?num=1Z999AA10123456784",
    "customer": { … },
    "shipping_address": { … }
  },
  {
    "id": 78235,
    "order_number": "DM-2024-78235",
    "status": "delivered",
    "total": 89.97,
    "subtotal": 79.97,
    "tax": 5,
    "shipping": 5,
    "currency": "USD",
    "items_count": 1,
    "created_at": "2024-01-14T10:00:00Z",
    "shipped_at": "2024-01-15T08:00:00Z",
    "delivered_at": "2024-01-17T14:30:00Z",
    "customer": { … }
  },
  {
    "id": 78236,
    "order_number": "DM-2024-78236",
    "status": "pending",
    "total": 524.95,
    "subtotal": 499.95,
    "tax": 25,
    "shipping": 0,
    "currency": "USD",
    "items_count": 5,
    "created_at": "2024-01-18T16:45:00Z",
    "customer": { … }
  }
]

MySite

Operations

Analytics

Operations

Events

Operations

Training

Operations