Customer Orders

/

List of customer orders

Fluid Commerce APIs (1.0)

The Fluid Commerce APIs provides a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. This bundle offers robust functionality for enhancing messaging solutions, streamlining data management, and improving customer interactions. With detailed documentation, secure authentication, and flexible integration options, the Fluid Public API Bundle is engineered to help you leverage our services efficiently and effectively, unlocking new potentials and achieving greater connectivity within your systems.

Download OpenAPI description

Overview

E-mail support@fluid.app

License MIT

Servers

Mock server

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

Production server with company subdomain

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

Local development server

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

Admins

Operations

Agreements

Operations

ApplePay

Operations

Application Theme Templates

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Categories

Operations

Collections

Operations

Companies

Operations

Company Admins

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

Operations

Company Popups

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Warehouses

Operations

Company Webhook Events

Operations

Contacts

Operations

Currencies

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/swagger/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[].payment_statusstring

Example: "Paid"

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[].metafieldsArray of objects(Metafield)

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[].shipping_addressnull or object

One of:

null

orders[].buyerobject or null

Example: {"share_guid":"f6b4c9"}

orders[].billing_addressnull or object

One of:

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"

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": { … }
  }
}

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Menus

Operations

Metafield Definitions

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Order Fulfillments

Operations

Orders

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Settings

Operations

Settings - Companies

Operations

Shares

Operations

Shop

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations