Customer Orders

Fluid Company APIs (1.0)

The Fluid Company APIs provide a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. These APIs use Company API tokens for authentication and provide full access to manage your company's resources including users, orders, products, media, and more.

For APIs that authenticate with User tokens, see the Rep APIs documentation. For public SDK APIs, see the Public SDK APIs documentation.

Download OpenAPI description

company.api.json

company.api.yaml

Overview

E-mail support@fluid.app

License MIT

Servers

Mock server

https://fluid-commerce.redocly.app/_mock/docs/apis/company.api/

Production server with company subdomain

https://{company}.fluid.app/

Local development server

http://fluid.lvh.me:{port}/

Activities

Operations

Admins

Operations

Agreements

Operations

Announcements

Operations

Application Theme Resources

Operations

Application Theme Templates

Operations

Application Themes

Operations

Authentication

Operations

Bank Accounts

Operations

Brand Guidelines

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Catch Ups

Operations

Categories

Operations

Checkout

Operations

Collections

Operations

Companies

Operations

Company Countries

Operations

Compliance

Content compliance scanning endpoints for products, media, playlists, categories, collections, posts, and enrollment packs

Operations

Contacts

Operations

Conversations

Operations

Countries

Operations

Currencies

Operations

Custom Pages

Operations

Customer Notes

Operations

Customer Orders

Operations

List of customer orders

Request

List Customers Orders for a Rep, including orders with no buyer, given the Rep token as Authorization header.

Query

paginationobject

curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/company.api/api/customer_orders?page=0&per_page=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

success

Bodyapplication/json

ordersArray of objectsrequired

orders[].idinteger

orders[].order_numberstring

Example: "F1248177316463"

orders[].currency_codestring

Example: "USD"

orders[].currency_symbolstring

Example: "$"

orders[].created_atstring

Example: "2023-07-24T10:00:00.000Z"

orders[].customernull or object

Any of:

null

orders[].fulfillment_statusstring

Example: "Fulfilled"

orders[].financial_statusstring

Example: "Paid"

orders[].order_statusstring

Example: "Completed"

orders[].payment_statusstring

Example: "Paid"

orders[].is_cancellableboolean

Example: true

orders[].notestring or null

Example: "Order notes"

orders[].notesArray of objects

orders[].repobject or null

Example: {"email":{"type":"string","example":"john.doe@example.com"},"name":{"type":"string","example":"John Doe"},"id":{"type":"integer","example":1},"image_url":{"type":"string","example":"https://example.com/image.png"},"external_id":{"type":"string","example":"1234567890"}}

orders[].companyobject

orders[].refundsArray of objects or null or null

orders[].activitiesArray of objects

orders[].payment_methodobject or null

orders[].totalstring

Example: "100.00"

orders[].total_in_currencystring

Example: "$100.00 USD"

orders[].sub_totalstring

Example: "90.00"

orders[].subtotalstring

Example: "90.00"

orders[].sub_total_in_currencystring

Example: "$90.00 USD"

orders[].shippingobject

orders[].shipping_discountnumber

Example: 10.45

orders[].items_countinteger

Example: 10

orders[].metadataobject

Example: {"level":"gold","tags":["Tag1","Tag2"],"camapaign":{"id":1,"name":"Winter 2025"}}

orders[].metafields_collectionArray of objects

orders[].metafieldsArray of objects(LegacyMetafield)

orders[].transaction_feenumber or string

Example: 3

orders[].transaction_fee_in_currencystring

Example: "$3.00 USD"

orders[].enrollment_feenumber or string

Example: 3

orders[].enrollment_fee_in_currencystring

Example: "$3.00 USD"

orders[].discountstring

Example: "10.00"

orders[].taxstring

Example: "8.00"

orders[].dynamic_chargesobject

Example: {"handling":2}

orders[].dynamic_charges_in_currencyobject

Example: {"handling":"$2.00 USD"}

orders[].buyerobject or null

Example: {"share_guid":"f6b4c9"}

orders[].shipping_addressobject or null

orders[].billing_addressobject or null

orders[].itemsArray of objects

orders[].discount_in_currencystring

Example: "$10.00 USD"

orders[].tax_in_currencystring

Example: "$8.00 USD"

orders[].cvinteger

Example: 100

orders[].qvinteger

Example: 100

orders[].statusstring

Example: "awaiting_payment"

orders[].external_idstring or null

Example: "1234567890"

orders[].cart_idstring or null

Example: 1

orders[].cart_tokenstring or null

Example: "CART_TOKEN"

orders[].sourcestring

Enum"mobile""web""admin""backoffice""subscription"

Example: "web"

metaobjectrequired

meta.request_idstring

Example: "123e4567-e89b-12d3-a456-426614174000"

meta.timestampstring

Example: "2021-01-01T00:00:00Z"

meta.paginationobject

Response

application/json

{
  "orders": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z",
    "pagination": { … }
  }
}

Customers

Operations

DAM

Digital Asset Management endpoints

Operations

Default Libraries

Operations

Devices

Operations

Discounts

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

Events

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

Global Embeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Languages

Operations

Libraries

Operations

Lighthouse

Lighthouse performance scanning endpoints for products, media, playlists, categories, collections, posts, and enrollment packs

Operations

MCC Codes

Operations

Media

Operations

Menus

Operations

Messages

Operations

Metafield Definitions

Operations

Metafields

Operations

Mobile Widgets

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Points

Operations

Points Ledgers

Operations

Points Values

Operations

Posts

Operations

Product Bundles

Operations

Product Images

Operations

Product Redirects

Operations

Product Subscription Plans

Operations

Products

Operations

Prompts

Operations

Public Assets

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Recipients

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Root Themes

Operations

Search

Operations

Shares

Operations

Shop

Operations

Sitemap

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Theme Region Rules

Operations

Tiles

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variant Images

Operations

Variant Inventory Levels

Operations

Variants

Operations

Warehouses

Operations

Webhook Events

Operations

Webhook Schemas

Operations

Webhooks

Operations

Webhooks Resources

Operations

affiliate

Operations

carts

Operations

checkout

Operations

enrollment-packs

Operations

events

Operations

fingerprint

Operations

lead

Operations

media

Operations

page

Operations

playlist

Operations

product

Operations

session

Operations

settings

Operations

url

Operations

widgets

Operations