Orders
/
Transfer an order to a different customer

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
swagger.json
swagger.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.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

Announcements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeResources

Operations

ApplicationThemeTemplates

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

Contacts

Operations

Countries

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

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

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Orchestration

Operations

Fluid Orchestration - Configurations

Operations

Fluid Orchestration - Rule Based

Operations

Fluid Orchestration - Default Fallback

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Languages

Operations

MCC Codes

Operations

Media

Operations

Menus

Operations

Metafield Definitions

Operations

Metafields

Operations

Mobile Widgets

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

List Commerce Orders

Request

List all commerce orders

Query
page[cursor]string

Cursor for pagination

page[limit]integer

Number of orders per page (max 100)

Example: page[limit]=25
start_datestring

Start date

Example: start_date=2025-01-01
end_datestring

End date

Example: end_date=2025-01-31
customer_idinteger

Customer ID

Example: customer_id=123
user_company_idinteger

User company ID

Example: user_company_id=456
searchstring

Search keyword

Example: search=john doe
within_daysinteger

Limit results to within the last N days

Example: within_days=30
subscription_idinteger

Subscription ID

Example: subscription_id=123
statusstring

Status filter

Enum"all""draft""awaiting_shipment""awaiting_payment""archived""cancelled"
Example: status=awaiting_shipment
typestring

Type of Order

Enum"sample_order""customer_order""member_order""enrollment_order""autoship_order"
Example: type=autoship
cart_sourcestring

Cart source

Enum"web""mobile""external""admin"
Example: cart_source=store_type
country_isosstring

Country ISOs

Example: country_isos=US,CA
sortstring

Sort orders by specified field. Prefix with - for descending. Available options: created_at, -created_at, id, -id, status, -status, customer, -customer, amount, -amount, no_of_quantities, -no_of_quantities

Example: sort=-created_at
force_statsboolean

Force stats calculation for large datasets

Example: force_stats=true
order_numberstring

Filter by exact order number

Example: order_number=ORD-12345
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v202506/orders?cart_source=web&country_isos=string&customer_id=0&end_date=string&force_stats=true&order_number=string&page%5Bcursor%5D=string&page%5Blimit%5D=0&search=string&sort=string&start_date=string&status=all&subscription_id=0&type=sample_order&user_company_id=0&within_days=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
ordersArray of objectsrequired
orders[].​idinteger
Example: 1
orders[].​external_idstring or null
Example: "EXT-12345"
orders[].​amountstring
Example: "0.0"
orders[].​amount_in_basestring
Example: "10.0"
orders[].​base_to_currency_ratestring or null
Example: "1.35"
orders[].​shipping_in_basestring or null
Example: "7.99"
orders[].​tax_in_basestring or null
Example: "12.79"
orders[].​subtotal_in_basestring or null
Example: "139.21"
orders[].​enrollment_fee_in_basestring or null
Example: "0.0"
orders[].​discount_in_basestring or null
Example: "0.0"
orders[].​total_display_amountstring

Formatted amount with currency symbol

Example: "$100.50"
orders[].​total_cvinteger

Total Commission Volume for the order

Example: 25
orders[].​total_qvinteger

Total Qualifying Volume for the order

Example: 30
orders[].​bill_toobject
orders[].​billing_addressobject or null
orders[].​created_atstring
Example: "2025-04-25T08:54:27Z"
orders[].​currency_codestring
Example: "USD"
orders[].​split_paymentobject or null
orders[].​points_appliedinteger

Total points used for this order

Example: 500
orders[].​points_applied_amount_in_currencynumber

Total points in currency amount used for this order

Example: 5
orders[].​order_total_after_points_redemptionnumber

The order total (actual card payment) after points redemption

Example: 95
orders[].​discount_codesArray of strings

Discount codes applied to the order

Example: ["DISCOUNT1","DISCOUNT2"]
orders[].​free_shippingboolean

Whether the order has free shipping

Example: false
orders[].​customerobject
orders[].​emailstring or null
Example: "john.doe1@fluid.app"
orders[].​first_namestring or null
Example: "Morgan"
orders[].​itemsArray of objects
orders[].​last_namestring or null
Example: "Olson"
orders[].​notestring or null
Example: "Order notes"
orders[].​order_numberstring
Example: "1001"
orders[].​ship_toobject
orders[].​shipping_addressobject or null
orders[].​shippingstring
Example: "0.0"
orders[].​statusstring
Example: "awaiting_payment"
orders[].​fulfillment_statusstring
Example: "fulfilled"
orders[].​order_statusstring
Example: "Completed"
orders[].​financial_statusstring
Example: "Paid"
orders[].​taxstring
Example: "0.0"
orders[].​tokenstring
Example: "fo_5gczy7wuboaugpn0hemvec"
orders[].​currency_symbolstring
Example: "$"
orders[].​items_countinteger
Example: 10
orders[].​quantity_countinteger
Example: 10
orders[].​updated_atstring
Example: "2025-04-25T08:54:27Z"
orders[].​warehouse_idinteger or null
Example: 1
orders[].​order_on_behalf_ofboolean
Example: false
orders[].​sourcestring
Enum"mobile""web""admin""backoffice""subscription"
Example: "web"
orders[].​subscriptionobject or null
orders[].​subscriptionsArray of objects
metaobjectrequired
meta.​request_idstring
Example: "5d72c7cd-54c5-449d-93f5-6da4631cd267"
meta.​timestampstring
Example: "2025-04-25T09:13:38Z"
meta.​paginationobject
meta.​average_cvnumber
Example: 20
meta.​total_cvnumber
Example: 60
meta.​average_amount_basenumber
Example: 200
meta.​total_amount_basenumber
Example: 600
meta.​fulfilled_orders_countinteger
Example: 2
meta.​property name*anyadditional property
property name*anyadditional property
Response
application/json
{
  "orders": [
    { … }
  ],
  "meta": {
    "request_id": "5d72c7cd-54c5-449d-93f5-6da4631cd267",
    "timestamp": "2025-04-25T09:13:38Z",
    "pagination": { … },
    "average_cv": 20,
    "total_cv": 60,
    "average_amount_base": 200,
    "total_amount_base": 600,
    "fulfilled_orders_count": 2
  }
}

Retrieve Commerce Order

Request

Retrieve a commerce order

Path
idintegerrequired

Order ID

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v202506/orders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
orderobjectrequired
order.​idinteger
Example: 1
order.​external_idstring or null
Example: "EXT-12345"
order.​amountstring
Example: "0.0"
order.​amount_in_basestring
Example: "10.0"
order.​base_to_currency_ratestring or null
Example: "1.35"
order.​shipping_in_basestring or null
Example: "7.99"
order.​tax_in_basestring or null
Example: "12.79"
order.​subtotal_in_basestring or null
Example: "139.21"
order.​enrollment_fee_in_basestring or null
Example: "0.0"
order.​discount_in_basestring or null
Example: "0.0"
order.​total_display_amountstring

Formatted amount with currency symbol

Example: "$100.50"
order.​total_cvinteger

Total Commission Volume for the order

Example: 25
order.​total_qvinteger

Total Qualifying Volume for the order

Example: 30
order.​bill_toobject
order.​billing_addressobject or null
order.​created_atstring
Example: "2025-04-25T08:54:27Z"
order.​currency_codestring
Example: "USD"
order.​split_paymentobject or null
order.​points_appliedinteger

Total points used for this order

Example: 500
order.​points_applied_amount_in_currencynumber

Total points in currency amount used for this order

Example: 5
order.​order_total_after_points_redemptionnumber

The order total (actual card payment) after points redemption

Example: 95
order.​discount_codesArray of strings

Discount codes applied to the order

Example: ["DISCOUNT1","DISCOUNT2"]
order.​free_shippingboolean

Whether the order has free shipping

Example: false
order.​customerobject(Customer)
order.​emailstring or null
Example: "john.doe1@fluid.app"
order.​first_namestring or null
Example: "Morgan"
order.​itemsArray of objects
order.​last_namestring or null
Example: "Olson"
order.​notestring or null
Example: "Order notes"
order.​order_numberstring
Example: "1001"
order.​ship_toobject
order.​shipping_addressobject or null
order.​shippingstring
Example: "0.0"
order.​statusstring
Example: "awaiting_payment"
order.​fulfillment_statusstring
Example: "Unfulfilled"
order.​order_statusstring
Example: "Completed"
order.​financial_statusstring
Example: "Paid"
order.​taxstring
Example: "0.0"
order.​tokenstring
Example: "fo_5gczy7wuboaugpn0hemvec"
order.​currency_symbolstring
Example: "$"
order.​items_countinteger
Example: 10
order.​quantity_countinteger
Example: 10
order.​updated_atstring
Example: "2025-04-25T08:54:27Z"
order.​warehouse_idinteger or null
Example: 1
order.​order_on_behalf_ofboolean
Example: false
order.​sourcestring
Enum"mobile""web""admin""backoffice""subscription"
Example: "web"
order.​subscriptionobject or null
order.​subscriptionsArray of objects
order.​cart_tokenstring or null
Example: "ct_1doa7jhNm4rLXqmJ3dG1GV"
order.​subtotalstring
Example: "100.00"
order.​sub_total_in_currencystring
Example: "$100.00"
order.​tax_in_currencystring
Example: "$10.00"
order.​discountstring
Example: "5.00"
order.​discount_in_currencystring
Example: "$5.00"
order.​transaction_feestring
Example: "2.50"
order.​enrollment_feestring
Example: "0.00"
order.​warehouse_namestring or null
Example: "Main Warehouse"
order.​payment_statusstring
Example: "pending"
order.​payment_methodobject or null
order.​metadataobject or null
order.​is_cancellableboolean
Example: true
order.​price_inclusive_of_taxboolean
Example: false
order.​price_inclusive_tax_namestring or null
Example: null
order.​repobject or null
order.​refundsArray of objects(Refund)
order.​metafieldsArray of objects(LegacyMetafield)
metaobjectrequired
meta.​request_idstring
Example: "f5473a8c-8a86-4e0e-b3e8-95392003921b"
meta.​timestampstring
Example: "2024-12-10T08:04:10Z"
meta.​shop_urlstring
Example: "https://example.com"
Response
application/json
{
  "order": {
    "id": 1,
    "external_id": "EXT-12345",
    "amount": "0.0",
    "amount_in_base": "10.0",
    "base_to_currency_rate": "1.35",
    "shipping_in_base": "7.99",
    "tax_in_base": "12.79",
    "subtotal_in_base": "139.21",
    "enrollment_fee_in_base": "0.0",
    "discount_in_base": "0.0",
    "total_display_amount": "$100.50",
    "total_cv": 25,
    "total_qv": 30,
    "bill_to": { … },
    "billing_address": { … },
    "created_at": "2025-04-25T08:54:27Z",
    "currency_code": "USD",
    "split_payment": { … },
    "points_applied": 500,
    "points_applied_amount_in_currency": 5,
    "order_total_after_points_redemption": 95,
    "discount_codes": [ … ],
    "free_shipping": false,
    "customer": { … },
    "email": "john.doe1@fluid.app",
    "first_name": "Morgan",
    "items": [ … ],
    "last_name": "Olson",
    "note": "Order notes",
    "order_number": "1001",
    "ship_to": { … },
    "shipping_address": { … },
    "shipping": "0.0",
    "status": "awaiting_payment",
    "fulfillment_status": "Unfulfilled",
    "order_status": "Completed",
    "financial_status": "Paid",
    "tax": "0.0",
    "token": "fo_5gczy7wuboaugpn0hemvec",
    "currency_symbol": "$",
    "items_count": 10,
    "quantity_count": 10,
    "updated_at": "2025-04-25T08:54:27Z",
    "warehouse_id": 1,
    "order_on_behalf_of": false,
    "source": "web",
    "subscription": { … },
    "subscriptions": [ … ],
    "cart_token": "ct_1doa7jhNm4rLXqmJ3dG1GV",
    "subtotal": "100.00",
    "sub_total_in_currency": "$100.00",
    "tax_in_currency": "$10.00",
    "discount": "5.00",
    "discount_in_currency": "$5.00",
    "transaction_fee": "2.50",
    "enrollment_fee": "0.00",
    "warehouse_name": "Main Warehouse",
    "payment_status": "pending",
    "payment_method": { … },
    "metadata": {},
    "is_cancellable": true,
    "price_inclusive_of_tax": false,
    "price_inclusive_tax_name": null,
    "rep": {},
    "refunds": [ … ],
    "metafields": [ … ]
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z",
    "shop_url": "https://example.com"
  }
}

Create Order

Request

Create an order from cart

Query
cart_tokenstringrequired

Token of the cart to create order from

Bodyapplication/json
orderobject
curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/orders?cart_token=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order": {
      "email": "customer@example.com",
      "status": "draft",
      "payment_status": "marked_paid/free",
      "order_type": "requested",
      "financial_status": "free",
      "order_status": "completed",
      "fulfillment_status": "fulfilled",
      "note": "Customer requested expedited shipping",
      "metafields": [
        {
          "namespace": "string",
          "key": "string",
          "value": null,
          "value_type": "single_line_text_field"
        }
      ]
    }
  }'

Responses

successful

Bodyapplication/json
orderobjectrequired
order.​idintegerrequired
order.​amount_in_basestring
Example: "10.0"
order.​base_to_currency_ratestring or null
Example: "1.35"
order.​currency_symbolstringrequired
order.​currency_codestring
order.​external_idstring or null
order.​order_numberstring
order.​tokenstring
order.​notestring or null
order.​company_logo_urlstring or null
order.​created_atstring
order.​customerstring or null
order.​emailstring or null
order.​totalstringrequired
order.​total_in_currencystring
order.​subtotalstring
Example: "90.00"
order.​subtotal_after_discountsstring
Example: "87.00"
order.​sub_totalstring
Example: "90.00"
order.​sub_total_in_currencystring
Example: "$90.00"
order.​taxstring
Example: "2.00"
order.​tax_in_currencystring
Example: "$2.00"
order.​transaction_feenumber or string
Example: "1.90"
order.​transaction_fee_in_currencystring
Example: "$1.00"
order.​discountstring
Example: "3.00"
order.​discount_in_currencystring
Example: "$3.00"
order.​warehouse_idinteger or null
Example: 1
order.​warehouseWarehouse (object) or null
One of:
order.​shippingstring
Example: "$11.00"
order.​shipping_in_currencyobject or null
order.​refundable_amountnumber or string(float)
Example: 10.5
order.​payment_statusstringrequired
order.​enrollment_tokenstring or null
order.​enrollment_packobject or null
order.​fulfillment_statusstringrequired
order.​order_statusstring
order.​financial_statusstring
order.​delivery_statusstringrequired
order.​delivery_methodstringrequired
order.​delivery_datestring or null
Example: "2023-07-29"
order.​channelstringrequired
order.​tagsstringrequired
order.​items_countintegerrequired
order.​quantity_countinteger
order.​itemsArray of objectsrequired
order.​items[].​idinteger
Example: 101
order.​items[].​pricenumber or string
Example: 43.41
order.​items[].​price_in_currencystring
Example: "$43.41"
order.​items[].​taxstring
Example: "2.99"
order.​items[].​tax_in_currencystring
Example: "$2.99"
order.​items[].​discount_amountstring
Example: "0.0"
order.​items[].​discount_amount_in_currencystring
Example: "$0.00"
order.​items[].​cvinteger
Example: 5
order.​items[].​cv_in_currencystring
Example: "$5.00"
order.​items[].​qvinteger
Example: 7
order.​items[].​qv_in_currencystring
Example: "$7.00"
order.​items[].​product_titlestring
Example: "Sample Product"
order.​items[].​variant_titlestring or null
Example: "Sample Variant"
order.​items[].​variant_imagestring or null
Example: "https://example.com/image.png"
order.​items[].​variant_idinteger
Example: 202
order.​items[].​quantityinteger
Example: 3
order.​items[].​titlestring
order.​items[].​totalnumber or string
order.​items[].​image_urlstring or null
order.​items[].​skustring or null
order.​items[].​display_pricestring
order.​items[].​display_totalstring
order.​items[].​refundable_amountnumber or string(float)
Example: 10.5
order.​items[].​enrollment_pack_idinteger or null
order.​items[].​display_to_customerboolean or null
Example: true
order.​items[].​bundled_itemsArray of objects
order.​items[].​ordered_variantArray of objects
order.​items[].​productobject
order.​items[].​variantobject
order.​activitiesArray of objects
order.​shipping_methodobject or object
One of:
order.​payment_detailsobject or nullrequired
order.​payment_details.​payment_typestring
order.​payment_details.​detailsobject
order.​primary_domain_hostnamestring or null
Example: "fluid.com"
order.​company_subdomainstring or null
Example: "myco"
order.​shipping_totalstring
Example: "0.0"
order.​shipping_total_for_displaystring
Example: "Free"
order.​ship_toobjectrequired
order.​ship_to.​idinteger
Example: 1
order.​ship_to.​namestring or null
Example: "John Doe"
order.​ship_to.​first_namestring or null
Example: "John"
order.​ship_to.​last_namestring or null
Example: "Doe"
order.​ship_to.​address1string
Example: "123 Main St"
order.​ship_to.​address2string or null
Example: "Apt 4B"
order.​ship_to.​address3string or null
Example: "Building 5"
order.​ship_to.​citystring
Example: "New York"
order.​ship_to.​statestring
Example: "NY"
order.​ship_to.​postal_codestring
Example: "10001"
order.​ship_to.​country_codestring

country_id takes precedence if both country_id and country_code provided.

Example: "US"
order.​ship_to.​subdivision_codestring or null
Example: "NY"
order.​ship_to.​defaultboolean
Example: true
order.​bill_toobject
order.​shipping_addressobject or null
order.​billing_addressobject or null
order.​companyobject
order.​order_on_behalf_ofboolean
Example: true
order.​volume_repobject or null
order.​metadataobject or null
order.​metafieldsArray of objects(LegacyMetafield)
order.​free_shippingboolean

Whether the order has free shipping

Example: false
order.​discount_codesArray of strings

Discount codes applied to the order

Example: ["DISCOUNT1","DISCOUNT2"]
order.​points_appliedinteger

Total points used for this order

Example: 500
order.​points_applied_amount_in_currencynumber

Total points in currency amount used for this order

Example: 5
order.​order_total_after_points_redemptionnumber

The order total (actual card payment) after points redemption

Example: 95
order.​split_paymentobject or null
order.​sourcestring
Enum"mobile""web""admin""backoffice""subscription"
Example: "web"
order.​price_inclusive_of_taxboolean
Example: false
order.​price_inclusive_tax_namestring or null
Example: null
metaobjectrequired
meta.​request_idstring
meta.​timestampstring
meta.​shop_urlstring
Response
application/json
{
  "order": {
    "id": 0,
    "amount_in_base": "10.0",
    "base_to_currency_rate": "1.35",
    "currency_symbol": "string",
    "currency_code": "string",
    "external_id": "string",
    "order_number": "string",
    "token": "string",
    "note": "string",
    "company_logo_url": "string",
    "created_at": "string",
    "customer": "string",
    "email": "string",
    "total": "string",
    "total_in_currency": "string",
    "subtotal": "90.00",
    "subtotal_after_discounts": "87.00",
    "sub_total": "90.00",
    "sub_total_in_currency": "$90.00",
    "tax": "2.00",
    "tax_in_currency": "$2.00",
    "transaction_fee": "1.90",
    "transaction_fee_in_currency": "$1.00",
    "discount": "3.00",
    "discount_in_currency": "$3.00",
    "warehouse_id": 1,
    "warehouse": { … },
    "shipping": "$11.00",
    "shipping_in_currency": { … },
    "refundable_amount": 10.5,
    "payment_status": "string",
    "enrollment_token": "string",
    "enrollment_pack": { … },
    "fulfillment_status": "string",
    "order_status": "string",
    "financial_status": "string",
    "delivery_status": "string",
    "delivery_method": "string",
    "delivery_date": "2023-07-29",
    "channel": "string",
    "tags": "string",
    "items_count": 0,
    "quantity_count": 0,
    "items": [ … ],
    "activities": [ … ],
    "shipping_method": { … },
    "payment_details": { … },
    "primary_domain_hostname": "fluid.com",
    "company_subdomain": "myco",
    "shipping_total": "0.0",
    "shipping_total_for_display": "Free",
    "ship_to": { … },
    "bill_to": { … },
    "shipping_address": { … },
    "billing_address": { … },
    "company": { … },
    "order_on_behalf_of": true,
    "volume_rep": { … },
    "metadata": {},
    "metafields": [ … ],
    "free_shipping": false,
    "discount_codes": [ … ],
    "points_applied": 500,
    "points_applied_amount_in_currency": 5,
    "order_total_after_points_redemption": 95,
    "split_payment": { … },
    "source": "web",
    "price_inclusive_of_tax": false,
    "price_inclusive_tax_name": null
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string",
    "shop_url": "string"
  }
}

Transfer an order to a different customer

Request

Transfers an existing order to a different customer within the same company

Path
idintegerrequired

Order ID

Bodyapplication/json
customer_idintegerrequired

ID of the customer to transfer the order to

curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/orders/{id}/transfer_customer' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "customer_id": 0
  }'

Responses

Order transferred with no address updates

Bodyapplication/json
orderobject
metaobject
Response
application/json
{
  "order": {
    "id": 0,
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "amount": "string",
    "created_at": "string",
    "updated_at": "string",
    "currency_code": "string",
    "order_number": "string",
    "status": "string",
    "note": "string",
    "token": "string",
    "tax": "string",
    "shipping": "string",
    "source": "mobile",
    "items": [ … ],
    "bill_to": {},
    "ship_to": {},
    "customer": { … }
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string"
  }
}

Update an order

Request

Update an order

Path
idintegerrequired

Order ID

Bodyapplication/jsonrequired
orderobject
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/orders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order": {
      "note": "Customer requested expedited shipping",
      "external_id": "EXT-12345",
      "metadata": {
        "source": "mobile_app",
        "campaign_id": "summer2024"
      },
      "sale_date": "2025-11-22T00:07:12Z",
      "metafields": [
        {
          "id": 0,
          "namespace": "string",
          "key": "string",
          "value": null,
          "value_type": "single_line_text_field",
          "_destroy": true
        }
      ]
    }
  }'

Responses

Order updated successfully

Bodyapplication/json
orderobjectrequired
order.​idintegerrequired
order.​amount_in_basestring
Example: "10.0"
order.​base_to_currency_ratestring or null
Example: "1.35"
order.​currency_symbolstringrequired
order.​currency_codestring
order.​external_idstring or null
order.​order_numberstring
order.​tokenstring
order.​notestring or null
order.​company_logo_urlstring or null
order.​created_atstring
order.​customerstring or null
order.​emailstring or null
order.​totalstringrequired
order.​total_in_currencystring
order.​subtotalstring
Example: "90.00"
order.​subtotal_after_discountsstring
Example: "87.00"
order.​sub_totalstring
Example: "90.00"
order.​sub_total_in_currencystring
Example: "$90.00"
order.​taxstring
Example: "2.00"
order.​tax_in_currencystring
Example: "$2.00"
order.​transaction_feenumber or string
Example: "1.90"
order.​transaction_fee_in_currencystring
Example: "$1.00"
order.​discountstring
Example: "3.00"
order.​discount_in_currencystring
Example: "$3.00"
order.​warehouse_idinteger or null
Example: 1
order.​warehouseWarehouse (object) or null
One of:
order.​shippingstring
Example: "$11.00"
order.​shipping_in_currencyobject or null
order.​refundable_amountnumber or string(float)
Example: 10.5
order.​payment_statusstringrequired
order.​enrollment_tokenstring or null
order.​enrollment_packobject or null
order.​fulfillment_statusstringrequired
order.​order_statusstring
order.​financial_statusstring
order.​delivery_statusstringrequired
order.​delivery_methodstringrequired
order.​delivery_datestring or null
Example: "2023-07-29"
order.​channelstringrequired
order.​tagsstringrequired
order.​items_countintegerrequired
order.​quantity_countinteger
order.​itemsArray of objectsrequired
order.​items[].​idinteger
Example: 101
order.​items[].​pricenumber or string
Example: 43.41
order.​items[].​price_in_currencystring
Example: "$43.41"
order.​items[].​taxstring
Example: "2.99"
order.​items[].​tax_in_currencystring
Example: "$2.99"
order.​items[].​discount_amountstring
Example: "0.0"
order.​items[].​discount_amount_in_currencystring
Example: "$0.00"
order.​items[].​cvinteger
Example: 5
order.​items[].​cv_in_currencystring
Example: "$5.00"
order.​items[].​qvinteger
Example: 7
order.​items[].​qv_in_currencystring
Example: "$7.00"
order.​items[].​product_titlestring
Example: "Sample Product"
order.​items[].​variant_titlestring or null
Example: "Sample Variant"
order.​items[].​variant_imagestring or null
Example: "https://example.com/image.png"
order.​items[].​variant_idinteger
Example: 202
order.​items[].​quantityinteger
Example: 3
order.​items[].​titlestring
order.​items[].​totalnumber or string
order.​items[].​image_urlstring or null
order.​items[].​skustring or null
order.​items[].​display_pricestring
order.​items[].​display_totalstring
order.​items[].​refundable_amountnumber or string(float)
Example: 10.5
order.​items[].​enrollment_pack_idinteger or null
order.​items[].​display_to_customerboolean or null
Example: true
order.​items[].​bundled_itemsArray of objects
order.​items[].​ordered_variantArray of objects
order.​items[].​productobject
order.​items[].​variantobject
order.​activitiesArray of objects
order.​shipping_methodobject or object
One of:
order.​payment_detailsobject or nullrequired
order.​payment_details.​payment_typestring
order.​payment_details.​detailsobject
order.​primary_domain_hostnamestring or null
Example: "fluid.com"
order.​company_subdomainstring or null
Example: "myco"
order.​shipping_totalstring
Example: "0.0"
order.​shipping_total_for_displaystring
Example: "Free"
order.​ship_toobjectrequired
order.​ship_to.​idinteger
Example: 1
order.​ship_to.​namestring or null
Example: "John Doe"
order.​ship_to.​first_namestring or null
Example: "John"
order.​ship_to.​last_namestring or null
Example: "Doe"
order.​ship_to.​address1string
Example: "123 Main St"
order.​ship_to.​address2string or null
Example: "Apt 4B"
order.​ship_to.​address3string or null
Example: "Building 5"
order.​ship_to.​citystring
Example: "New York"
order.​ship_to.​statestring
Example: "NY"
order.​ship_to.​postal_codestring
Example: "10001"
order.​ship_to.​country_codestring

country_id takes precedence if both country_id and country_code provided.

Example: "US"
order.​ship_to.​subdivision_codestring or null
Example: "NY"
order.​ship_to.​defaultboolean
Example: true
order.​bill_toobject
order.​shipping_addressobject or null
order.​billing_addressobject or null
order.​companyobject
order.​order_on_behalf_ofboolean
Example: true
order.​volume_repobject or null
order.​metadataobject or null
order.​metafieldsArray of objects(LegacyMetafield)
order.​free_shippingboolean

Whether the order has free shipping

Example: false
order.​discount_codesArray of strings

Discount codes applied to the order

Example: ["DISCOUNT1","DISCOUNT2"]
order.​points_appliedinteger

Total points used for this order

Example: 500
order.​points_applied_amount_in_currencynumber

Total points in currency amount used for this order

Example: 5
order.​order_total_after_points_redemptionnumber

The order total (actual card payment) after points redemption

Example: 95
order.​split_paymentobject or null
order.​sourcestring
Enum"mobile""web""admin""backoffice""subscription"
Example: "web"
order.​price_inclusive_of_taxboolean
Example: false
order.​price_inclusive_tax_namestring or null
Example: null
metaobjectrequired
meta.​request_idstring
meta.​timestampstring
meta.​shop_urlstring
Response
application/json
{
  "order": {
    "id": 0,
    "amount_in_base": "10.0",
    "base_to_currency_rate": "1.35",
    "currency_symbol": "string",
    "currency_code": "string",
    "external_id": "string",
    "order_number": "string",
    "token": "string",
    "note": "string",
    "company_logo_url": "string",
    "created_at": "string",
    "customer": "string",
    "email": "string",
    "total": "string",
    "total_in_currency": "string",
    "subtotal": "90.00",
    "subtotal_after_discounts": "87.00",
    "sub_total": "90.00",
    "sub_total_in_currency": "$90.00",
    "tax": "2.00",
    "tax_in_currency": "$2.00",
    "transaction_fee": "1.90",
    "transaction_fee_in_currency": "$1.00",
    "discount": "3.00",
    "discount_in_currency": "$3.00",
    "warehouse_id": 1,
    "warehouse": { … },
    "shipping": "$11.00",
    "shipping_in_currency": { … },
    "refundable_amount": 10.5,
    "payment_status": "string",
    "enrollment_token": "string",
    "enrollment_pack": { … },
    "fulfillment_status": "string",
    "order_status": "string",
    "financial_status": "string",
    "delivery_status": "string",
    "delivery_method": "string",
    "delivery_date": "2023-07-29",
    "channel": "string",
    "tags": "string",
    "items_count": 0,
    "quantity_count": 0,
    "items": [ … ],
    "activities": [ … ],
    "shipping_method": { … },
    "payment_details": { … },
    "primary_domain_hostname": "fluid.com",
    "company_subdomain": "myco",
    "shipping_total": "0.0",
    "shipping_total_for_display": "Free",
    "ship_to": { … },
    "bill_to": { … },
    "shipping_address": { … },
    "billing_address": { … },
    "company": { … },
    "order_on_behalf_of": true,
    "volume_rep": { … },
    "metadata": {},
    "metafields": [ … ],
    "free_shipping": false,
    "discount_codes": [ … ],
    "points_applied": 500,
    "points_applied_amount_in_currency": 5,
    "order_total_after_points_redemption": 95,
    "split_payment": { … },
    "source": "web",
    "price_inclusive_of_tax": false,
    "price_inclusive_tax_name": null
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string",
    "shop_url": "string"
  }
}

Update an order (PUT method)

Request

Update an order using PUT method

Path
idintegerrequired

Order ID

Bodyapplication/jsonrequired
orderobject
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/orders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order": {
      "note": "Customer requested expedited shipping",
      "external_id": "EXT-12345",
      "metadata": {
        "source": "mobile_app",
        "campaign_id": "summer2024"
      }
    }
  }'

Responses

Order updated successfully

Bodyapplication/json
orderobject

Updated order object with associations

metaobject
Response
application/json
{
  "order": {},
  "meta": {
    "shop_url": "https://test-company.fluid.com",
    "request_id": "string",
    "timestamp": "string"
  }
}

Update Order Warehouse

Request

Update the warehouse for an order

Path
idintegerrequired

Order ID

Bodyapplication/jsonrequired
warehouse_idintegerrequired

ID of the warehouse to assign to the order

Example: 123
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/orders/{id}/update_warehouse' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "warehouse_id": 123
  }'

Responses

Order warehouse updated successfully

Bodyapplication/json
orderobjectrequired
order.​idintegerrequired
order.​amount_in_basestring
Example: "10.0"
order.​base_to_currency_ratestring or null
Example: "1.35"
order.​currency_symbolstringrequired
order.​currency_codestring
order.​external_idstring or null
order.​order_numberstring
order.​tokenstring
order.​notestring or null
order.​company_logo_urlstring or null
order.​created_atstring
order.​customerstring or null
order.​emailstring or null
order.​totalstringrequired
order.​total_in_currencystring
order.​subtotalstring
Example: "90.00"
order.​subtotal_after_discountsstring
Example: "87.00"
order.​sub_totalstring
Example: "90.00"
order.​sub_total_in_currencystring
Example: "$90.00"
order.​taxstring
Example: "2.00"
order.​tax_in_currencystring
Example: "$2.00"
order.​transaction_feenumber or string
Example: "1.90"
order.​transaction_fee_in_currencystring
Example: "$1.00"
order.​discountstring
Example: "3.00"
order.​discount_in_currencystring
Example: "$3.00"
order.​warehouse_idinteger or null
Example: 1
order.​warehouseWarehouse (object) or null
One of:
order.​shippingstring
Example: "$11.00"
order.​shipping_in_currencyobject or null
order.​refundable_amountnumber or string(float)
Example: 10.5
order.​payment_statusstringrequired
order.​enrollment_tokenstring or null
order.​enrollment_packobject or null
order.​fulfillment_statusstringrequired
order.​order_statusstring
order.​financial_statusstring
order.​delivery_statusstringrequired
order.​delivery_methodstringrequired
order.​delivery_datestring or null
Example: "2023-07-29"
order.​channelstringrequired
order.​tagsstringrequired
order.​items_countintegerrequired
order.​quantity_countinteger
order.​itemsArray of objectsrequired
order.​items[].​idinteger
Example: 101
order.​items[].​pricenumber or string
Example: 43.41
order.​items[].​price_in_currencystring
Example: "$43.41"
order.​items[].​taxstring
Example: "2.99"
order.​items[].​tax_in_currencystring
Example: "$2.99"
order.​items[].​discount_amountstring
Example: "0.0"
order.​items[].​discount_amount_in_currencystring
Example: "$0.00"
order.​items[].​cvinteger
Example: 5
order.​items[].​cv_in_currencystring
Example: "$5.00"
order.​items[].​qvinteger
Example: 7
order.​items[].​qv_in_currencystring
Example: "$7.00"
order.​items[].​product_titlestring
Example: "Sample Product"
order.​items[].​variant_titlestring or null
Example: "Sample Variant"
order.​items[].​variant_imagestring or null
Example: "https://example.com/image.png"
order.​items[].​variant_idinteger
Example: 202
order.​items[].​quantityinteger
Example: 3
order.​items[].​titlestring
order.​items[].​totalnumber or string
order.​items[].​image_urlstring or null
order.​items[].​skustring or null
order.​items[].​display_pricestring
order.​items[].​display_totalstring
order.​items[].​refundable_amountnumber or string(float)
Example: 10.5
order.​items[].​enrollment_pack_idinteger or null
order.​items[].​display_to_customerboolean or null
Example: true
order.​items[].​bundled_itemsArray of objects
order.​items[].​ordered_variantArray of objects
order.​items[].​productobject
order.​items[].​variantobject
order.​activitiesArray of objects
order.​shipping_methodobject or object
One of:
order.​payment_detailsobject or nullrequired
order.​payment_details.​payment_typestring
order.​payment_details.​detailsobject
order.​primary_domain_hostnamestring or null
Example: "fluid.com"
order.​company_subdomainstring or null
Example: "myco"
order.​shipping_totalstring
Example: "0.0"
order.​shipping_total_for_displaystring
Example: "Free"
order.​ship_toobjectrequired
order.​ship_to.​idinteger
Example: 1
order.​ship_to.​namestring or null
Example: "John Doe"
order.​ship_to.​first_namestring or null
Example: "John"
order.​ship_to.​last_namestring or null
Example: "Doe"
order.​ship_to.​address1string
Example: "123 Main St"
order.​ship_to.​address2string or null
Example: "Apt 4B"
order.​ship_to.​address3string or null
Example: "Building 5"
order.​ship_to.​citystring
Example: "New York"
order.​ship_to.​statestring
Example: "NY"
order.​ship_to.​postal_codestring
Example: "10001"
order.​ship_to.​country_codestring

country_id takes precedence if both country_id and country_code provided.

Example: "US"
order.​ship_to.​subdivision_codestring or null
Example: "NY"
order.​ship_to.​defaultboolean
Example: true
order.​bill_toobject
order.​shipping_addressobject or null
order.​billing_addressobject or null
order.​companyobject
order.​order_on_behalf_ofboolean
Example: true
order.​volume_repobject or null
order.​metadataobject or null
order.​metafieldsArray of objects(LegacyMetafield)
order.​free_shippingboolean

Whether the order has free shipping

Example: false
order.​discount_codesArray of strings

Discount codes applied to the order

Example: ["DISCOUNT1","DISCOUNT2"]
order.​points_appliedinteger

Total points used for this order

Example: 500
order.​points_applied_amount_in_currencynumber

Total points in currency amount used for this order

Example: 5
order.​order_total_after_points_redemptionnumber

The order total (actual card payment) after points redemption

Example: 95
order.​split_paymentobject or null
order.​sourcestring
Enum"mobile""web""admin""backoffice""subscription"
Example: "web"
order.​price_inclusive_of_taxboolean
Example: false
order.​price_inclusive_tax_namestring or null
Example: null
metaobjectrequired
meta.​request_idstring
meta.​timestampstring
meta.​shop_urlstring
Response
application/json
{
  "order": {
    "id": 0,
    "amount_in_base": "10.0",
    "base_to_currency_rate": "1.35",
    "currency_symbol": "string",
    "currency_code": "string",
    "external_id": "string",
    "order_number": "string",
    "token": "string",
    "note": "string",
    "company_logo_url": "string",
    "created_at": "string",
    "customer": "string",
    "email": "string",
    "total": "string",
    "total_in_currency": "string",
    "subtotal": "90.00",
    "subtotal_after_discounts": "87.00",
    "sub_total": "90.00",
    "sub_total_in_currency": "$90.00",
    "tax": "2.00",
    "tax_in_currency": "$2.00",
    "transaction_fee": "1.90",
    "transaction_fee_in_currency": "$1.00",
    "discount": "3.00",
    "discount_in_currency": "$3.00",
    "warehouse_id": 1,
    "warehouse": { … },
    "shipping": "$11.00",
    "shipping_in_currency": { … },
    "refundable_amount": 10.5,
    "payment_status": "string",
    "enrollment_token": "string",
    "enrollment_pack": { … },
    "fulfillment_status": "string",
    "order_status": "string",
    "financial_status": "string",
    "delivery_status": "string",
    "delivery_method": "string",
    "delivery_date": "2023-07-29",
    "channel": "string",
    "tags": "string",
    "items_count": 0,
    "quantity_count": 0,
    "items": [ … ],
    "activities": [ … ],
    "shipping_method": { … },
    "payment_details": { … },
    "primary_domain_hostname": "fluid.com",
    "company_subdomain": "myco",
    "shipping_total": "0.0",
    "shipping_total_for_display": "Free",
    "ship_to": { … },
    "bill_to": { … },
    "shipping_address": { … },
    "billing_address": { … },
    "company": { … },
    "order_on_behalf_of": true,
    "volume_rep": { … },
    "metadata": {},
    "metafields": [ … ],
    "free_shipping": false,
    "discount_codes": [ … ],
    "points_applied": 500,
    "points_applied_amount_in_currency": 5,
    "order_total_after_points_redemption": 95,
    "split_payment": { … },
    "source": "web",
    "price_inclusive_of_tax": false,
    "price_inclusive_tax_name": null
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string",
    "shop_url": "string"
  }
}

Export Commerce Orders to CSV

Request

Export orders to CSV file (async or sync)

Query
within_daysinteger

Limit results to within the last N days

Example: within_days=30
report_typestring

Type of report to generate

Enum"orders""shipping""subscription"
Example: report_type=orders
send_emailboolean

Send export result via email

asyncboolean

Process export asynchronously

Example: async=true
start_datestring

Start date for filtering orders (MM/DD/YYYY)

Example: start_date=01/01/2025
end_datestring

End date for filtering orders (MM/DD/YYYY)

Example: end_date=01/31/2025
statusstring

Filter by order status

Example: status=processing
countriesstring

Filter by country codes (comma-separated)

Example: countries=US,CA
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v202506/orders/export_csv?async=true&countries=string&end_date=string&report_type=orders&send_email=true&start_date=string&status=string&within_days=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

sync export completed

Bodyapplication/json
job_idstring
Example: "12345abcde"
statusstring
Example: "processing"
metaobjectrequired
meta.​request_idstringrequired
Example: "5d72c7cd-54c5-449d-93f5-6da4631cd267"
meta.​timestampstringrequired
Example: "2025-04-25T09:13:38Z"
urlstringrequired
Example: "https://cdn.example.com/exports/orders_2025-01-15.csv"
Response
application/json
{
  "job_id": "12345abcde",
  "status": "processing",
  "meta": {
    "request_id": "5d72c7cd-54c5-449d-93f5-6da4631cd267",
    "timestamp": "2025-04-25T09:13:38Z"
  },
  "url": "https://cdn.example.com/exports/orders_2025-01-15.csv"
}

Find orders by email

Request

Query
emailstringrequired

Email to find orders by

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/orders/find_by_email?email=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

orders found by customer email

List Orders

Request

Get all orders with optional filters

Query
customer_idinteger

Filter orders by customer

user_company_idinteger

Filter orders by user company

unfulfilledboolean

Filter unfulfilled orders

unpaidboolean

Filter unpaid orders

search_querystring

Search by order id, number, email, phone, first name, last name, order number, external id, product title, product sku, contact first name, contact last name, customer id, customer first name, customer last name

within_daysinteger

Filter orders created within the last number of days

datestring

Filter orders by date range (format: MM/DD/YYYY-MM/DD/YYYY)

pageinteger

Page number for pagination

Default 1
per_pageinteger

Number of records per page

Default 10
by_metadatastring(json)

Search JSON meta data

Default "{}"
sorted_bystring

Sort orders by specified field and direction. Available sort fields: id, created_at, order_number, amount, country, buyer, product_title.

Sort field should be followed by '_{direction}'; eg. id_asc, amount_desc, etc.

Example: sorted_by=created_at_desc
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/orders?by_metadata={}&customer_id=0&date=string&page=1&per_page=10&search_query=string&sorted_by=string&unfulfilled=true&unpaid=true&user_company_id=0&within_days=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Stats remain consistent across pagination

Bodyapplication/json
ordersArray of objectsrequired
orders[].​idinteger
Example: 1
orders[].​order_numberstring
Example: "F1248177316463"
orders[].​currency_codestring
Example: "USD"
orders[].​currency_symbolstring
Example: "$"
orders[].​customer_idinteger
Example: 1
orders[].​customerstring
Example: "John Doe"
orders[].​channelstring
Example: "Channel 2"
orders[].​payment_statusstring
Example: "Paid"
orders[].​is_cancellableboolean
Example: true
orders[].​statusstring
Example: "awaiting_payment"
orders[].​fulfillment_statusstring
Example: "Fulfilled"
orders[].​financial_statusstring
Example: "Paid"
orders[].​order_statusstring
Example: "Completed"
orders[].​totalstring
Example: "100.00"
orders[].​total_in_currencystring
Example: "$100.00 USD"
orders[].​subtotalstring
Example: "90.00"
orders[].​sub_totalstring
Example: "90.00"
orders[].​sub_total_in_currencystring
Example: "90.00"
orders[].​taxstring
Example: "2.00"
orders[].​tax_in_currencystring
Example: "$2.00 USD"
orders[].​discountstring
Example: "3.00"
orders[].​discount_in_currencystring
Example: "$3.00 USD"
orders[].​shippingstring
Example: "11.00"
orders[].​shipping_discountnumber
Example: 10.45
orders[].​notestring or null
Example: "Order note"
orders[].​cvinteger
Example: 100
orders[].​qvinteger
Example: 100
orders[].​external_idstring or null
Example: "1234567890"
orders[].​cart_idstring or null
Example: 1
orders[].​cart_tokenstring or null
Example: "CART_TOKEN"
orders[].​metadataobject
Example: {"level":"gold","tags":["Tag1","Tag2"],"camapaign":{"id":1,"name":"Winter 2025"}}
orders[].​shipping_in_currencyobject or null
orders[].​buyerobject or null
Example: {"share_guid":"f6b4c9"}
orders[].​delivery_methodstring
Example: "Courier"
orders[].​delivery_statusstring
Example: "In Transit"
orders[].​delivery_datestring or null
Example: "2023-07-29"
orders[].​tagsstring
Example: "Tag 1"
orders[].​created_atstring
Example: "2023-07-24T10:00:00.000Z"
orders[].​items_countinteger
Example: 2
orders[].​enrollment_tokenstring or null
Example: "et_12ad8jjhuxhtv4qlmn6poz"
orders[].​enrollment_pack_idinteger or null
Example: 1
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[].​ship_toobject or null
orders[].​bill_toobject or null
orders[].​activitiesArray of objects
orders[].​itemsArray of objects
orders[].​metafields_collectionArray of objects
orders[].​companyobject
orders[].​sourcestring
Enum"mobile""web""admin""backoffice""subscription"
Example: "web"
metaobjectrequired
meta.​request_idstringrequired
Example: "84eadc2f-4e51-4e3f-9f96-e8d7ba35cea4"
meta.​timestampstringrequired
Example: "2025-05-07T08:25:35Z"
meta.​current_pageinteger
meta.​next_pageinteger or null
meta.​prev_pageinteger or null
meta.​total_pagesinteger
meta.​total_countintegerrequired
meta.​average_cvinteger or number
Example: 20
meta.​total_cvinteger or number
Example: 60
meta.​average_amount_baseinteger or number
Example: 200
meta.​total_amount_baseinteger or number
Example: 600
meta.​fulfilled_orders_countinteger
Example: 2
meta.​stats_calculatedboolean
Example: false
meta.​messagestring
Example: "Stats calculation skipped for large dataset"
Response
application/json
{
  "orders": [
    { … }
  ],
  "meta": {
    "request_id": "84eadc2f-4e51-4e3f-9f96-e8d7ba35cea4",
    "timestamp": "2025-05-07T08:25:35Z",
    "current_page": 0,
    "next_page": 0,
    "prev_page": 0,
    "total_pages": 0,
    "total_count": 0,
    "average_cv": 20,
    "total_cv": 60,
    "average_amount_base": 200,
    "total_amount_base": 600,
    "fulfilled_orders_count": 2,
    "stats_calculated": false,
    "message": "Stats calculation skipped for large dataset"
  }
}

Orders' stats

Request

Get statistics for orders

curl -i -X GET \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/orders/stats \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
total_ordersintegerrequired
Example: 10
total_cancelled_ordersintegerrequired
Example: 2
total_shipped_ordersintegerrequired
Example: 8
metaobjectrequired
meta.​request_idstring
Example: "f5473a8c-8a86-4e0e-b3e8-95392003921b"
meta.​timestampstring
Example: "2024-12-10T08:04:10Z"
Response
application/json
{
  "total_orders": 10,
  "total_cancelled_orders": 2,
  "total_shipped_orders": 8,
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Show Order

Request

Show Order Information

Path
idintegerrequired

Order ID

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/orders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
orderobject
metaobject
Response
application/json
{
  "order": {
    "id": 0,
    "order_number": "F1248177316463",
    "currency_code": "USD",
    "currency_symbol": "$",
    "created_at": "2023-07-24T10:00:00.000Z",
    "customer": {},
    "fulfillment_status": "Fulfilled",
    "financial_status": "Paid",
    "order_status": "Completed",
    "payment_status": "Paid",
    "is_cancellable": true,
    "note": "Order notes",
    "notes": [ … ],
    "rep": { … },
    "company": { … },
    "refunds": [ … ],
    "activities": [ … ],
    "payment_method": { … },
    "total": "100.00",
    "total_in_currency": "$100.00 USD",
    "sub_total": "90.00",
    "subtotal": "90.00",
    "sub_total_in_currency": "$90.00 USD",
    "shipping": { … },
    "shipping_discount": 10.45,
    "items_count": 10,
    "metadata": { … },
    "metafields_collection": [ … ],
    "metafields": [ … ],
    "transaction_fee": 3,
    "transaction_fee_in_currency": "$3.00 USD",
    "enrollment_fee": 3,
    "enrollment_fee_in_currency": "$3.00 USD",
    "discount": "10.00",
    "tax": "8.00",
    "dynamic_charges": { … },
    "dynamic_charges_in_currency": { … },
    "buyer": { … },
    "shipping_address": { … },
    "billing_address": { … },
    "items": [ … ],
    "discount_in_currency": "$10.00 USD",
    "tax_in_currency": "$8.00 USD",
    "cv": 100,
    "qv": 100,
    "status": "awaiting_payment",
    "external_id": "1234567890",
    "cart_id": 1,
    "cart_token": "CART_TOKEN",
    "source": "web"
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Cancel an Order

Request

Cancel an order

Path
idstringrequired

Order ID

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/orders/{id}/cancel' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
statusstring
Example: "success"
dataobject
Response
application/json
{
  "status": "success",
  "data": {
    "message": "Order cancelled successfully"
  }
}

Charge an Order

Request

Charge an order. Order must be in awaiting_payment status

Path
idstringrequired

Order ID

curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/orders/{id}/charge' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
statusstring
Example: "success"
dataobject
Response
application/json
{
  "status": "success",
  "data": {
    "message": "Order charged successfully"
  }
}

Append metadata field

Request

Path
idintegerrequired

Orders's Id

Bodyapplication/json
metadataobjectrequired

A JSON object that can store any custom data structure. When provided, merges with existing metadata data.

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/orders/{id}/append_metadata' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": {}
  }'

Responses

success

Bodyapplication/json
orderobject
metaobject
Response
application/json
{
  "order": {
    "id": 0,
    "order_number": "F1248177316463",
    "currency_code": "USD",
    "currency_symbol": "$",
    "created_at": "2023-07-24T10:00:00.000Z",
    "customer": {},
    "fulfillment_status": "Fulfilled",
    "financial_status": "Paid",
    "order_status": "Completed",
    "payment_status": "Paid",
    "is_cancellable": true,
    "note": "Order notes",
    "notes": [ … ],
    "rep": { … },
    "company": { … },
    "refunds": [ … ],
    "activities": [ … ],
    "payment_method": { … },
    "total": "100.00",
    "total_in_currency": "$100.00 USD",
    "sub_total": "90.00",
    "subtotal": "90.00",
    "sub_total_in_currency": "$90.00 USD",
    "shipping": { … },
    "shipping_discount": 10.45,
    "items_count": 10,
    "metadata": { … },
    "metafields_collection": [ … ],
    "metafields": [ … ],
    "transaction_fee": 3,
    "transaction_fee_in_currency": "$3.00 USD",
    "enrollment_fee": 3,
    "enrollment_fee_in_currency": "$3.00 USD",
    "discount": "10.00",
    "tax": "8.00",
    "dynamic_charges": { … },
    "dynamic_charges_in_currency": { … },
    "buyer": { … },
    "shipping_address": { … },
    "billing_address": { … },
    "items": [ … ],
    "discount_in_currency": "$10.00 USD",
    "tax_in_currency": "$8.00 USD",
    "cv": 100,
    "qv": 100,
    "status": "awaiting_payment",
    "external_id": "1234567890",
    "cart_id": 1,
    "cart_token": "CART_TOKEN",
    "source": "web"
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Remove metadata field(s)

Request

Path
idintegerrequired

Order ID

Bodyapplication/json
metadataArray of stringsrequired

Array of metadata keys to remove. Supports dot notation for nested keys.

Example: ["level","referred_by.user.id","location_ids"]
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/orders/{id}/remove_metadata' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": [
      "level",
      "referred_by.user.id",
      "location_ids"
    ]
  }'

Responses

successful

Bodyapplication/json
orderobject
metaobject
Response
application/json
{
  "order": {
    "id": 0,
    "order_number": "F1248177316463",
    "currency_code": "USD",
    "currency_symbol": "$",
    "created_at": "2023-07-24T10:00:00.000Z",
    "customer": {},
    "fulfillment_status": "Fulfilled",
    "financial_status": "Paid",
    "order_status": "Completed",
    "payment_status": "Paid",
    "is_cancellable": true,
    "note": "Order notes",
    "notes": [ … ],
    "rep": { … },
    "company": { … },
    "refunds": [ … ],
    "activities": [ … ],
    "payment_method": { … },
    "total": "100.00",
    "total_in_currency": "$100.00 USD",
    "sub_total": "90.00",
    "subtotal": "90.00",
    "sub_total_in_currency": "$90.00 USD",
    "shipping": { … },
    "shipping_discount": 10.45,
    "items_count": 10,
    "metadata": { … },
    "metafields_collection": [ … ],
    "metafields": [ … ],
    "transaction_fee": 3,
    "transaction_fee_in_currency": "$3.00 USD",
    "enrollment_fee": 3,
    "enrollment_fee_in_currency": "$3.00 USD",
    "discount": "10.00",
    "tax": "8.00",
    "dynamic_charges": { … },
    "dynamic_charges_in_currency": { … },
    "buyer": { … },
    "shipping_address": { … },
    "billing_address": { … },
    "items": [ … ],
    "discount_in_currency": "$10.00 USD",
    "tax_in_currency": "$8.00 USD",
    "cv": 100,
    "qv": 100,
    "status": "awaiting_payment",
    "external_id": "1234567890",
    "cart_id": 1,
    "cart_token": "CART_TOKEN",
    "source": "web"
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Update Order Sponsor

Request

Update the sponsor (user_company) of an order

Path
idintegerrequired

Order ID

Bodyapplication/jsonrequired
orderobjectrequired
order.​user_company_idintegerrequired

ID of the UserCompany (sponsor)

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/orders/{id}/update_sponsor' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order": {
      "user_company_id": 0
    }
  }'

Responses

successful

Response
application/json
{
  "status": "fail",
  "data": {
    "error": "Sponsor not found"
  }
}

Archive an Order

Request

Archive an order

Path
idintegerrequired

Order ID

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/orders/{id}/archive' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful - order archived

Bodyapplication/json
statusstring
Example: "success"
dataobject
Response
application/json
{
  "status": "success",
  "data": {
    "message": "Order archived successfully"
  }
}

Unarchive an Order

Request

Unarchive an order

Path
idintegerrequired

Order ID

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/orders/{id}/unarchive' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful - order unarchived

Bodyapplication/json
statusstring
Example: "success"
dataobject
Response
application/json
{
  "status": "success",
  "data": {
    "message": "Order unarchived successfully"
  }
}

Update Order External ID

Request

Update the external_id of an order

Path
idintegerrequired

Order ID

Bodyapplication/jsonrequired
orderobjectrequired
order.​external_idstringrequired

External ID for the order

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/orders/{id}/update_external_id' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order": {
      "external_id": "string"
    }
  }'

Responses

successful

Response
application/json
{
  "status": "fail",
  "data": {
    "error": "Order not found."
  }
}

Send order invoice email

Request

Send an order invoice email

Bodyapplication/json

Invoice email parameters

cart_tokenstringrequired
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/orders/send_invoice_email \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cart_token": "string"
  }'

Responses

success

Bodyapplication/json
cart_tokenstringrequired
Example: "ct_ABC123"
metaobject
Response
application/json
{
  "cart_token": "ct_ABC123",
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Owners

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments Reports

Operations

Paypal

Operations

Points Ledgers

Operations

Points Values

Operations

Posts

Operations

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Assets

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Root Themes

Operations

Search

Operations

Shares

Operations

Shop

Operations

Sitemap

Operations

Social Media

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Theme Region Rules

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

VariantImages

Operations

VariantInventoryLevels

Operations

Variants

Operations

Warehouses

Operations

Webhook Events

Operations

Webhook Schemas

Operations

Webhooks

Operations

Webhooks Resources

Operations

Get a specific media

Request

Path
idintegerrequired

Media ID

Example: 1
Query
language_isostring

Language code for translations (e.g., 'en', 'es', 'de')

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/media/{id}?language_iso=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Media retrieved successfully

Bodyapplication/json
idintegerrequired
user_idinteger or null
titlestringrequired
descriptionobject or null
strippedstring or null
media_typestringrequired
Enum"share""update""training""upload"
media_formatstring or null
image_urlstring or null
video_urlstring or null
pdf_urlstring or null
kindstring or null
activebooleanrequired
visibilityinteger or null
share_linkstring or null
preview_linkstring or null
viewsintegerrequired
leadsintegerrequired
watchobject or null
video_statusstring or null
durationinteger or null
cta_urlstring or null
cta_button_textstring or null
cta_enabledbooleanrequired
cta_action_typestring or null
video_shopping_enabledbooleanrequired
prompts_enabledbooleanrequired
ranksArray of strings
settingsobject or null
application_theme_template_idinteger or null
created_atstring(date-time)required
subtitlesobject or null

Hash of language ISO codes to subtitle text

countriesArray of objects
tagsArray of objects
slugstring or null

URL-friendly slug for the media item

custom_slugboolean

Whether the slug was customized by the user

promptsArray of objects

Only included if media_type is 'share' or 'upload'

attached_shareablesArray of objects
commentsArray of objects

Only included if video_shopping_enabled is true and display_comments is true

labelobject or null

Label object from LabelConcern

display_tagstring or null

Display tag from LabelConcern

Response
application/json
{
  "id": 0,
  "user_id": 0,
  "title": "string",
  "description": {},
  "stripped": "string",
  "media_type": "share",
  "media_format": "string",
  "image_url": "string",
  "video_url": "string",
  "pdf_url": "string",
  "kind": "string",
  "active": true,
  "visibility": 0,
  "share_link": "string",
  "preview_link": "string",
  "views": 0,
  "leads": 0,
  "watch": {},
  "video_status": "string",
  "duration": 0,
  "cta_url": "string",
  "cta_button_text": "string",
  "cta_enabled": true,
  "cta_action_type": "string",
  "video_shopping_enabled": true,
  "prompts_enabled": true,
  "ranks": [
    "string"
  ],
  "settings": {},
  "application_theme_template_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "subtitles": {
    "property1": "string",
    "property2": "string"
  },
  "countries": [
    { … }
  ],
  "tags": [
    { … }
  ],
  "slug": "string",
  "custom_slug": true,
  "prompts": [
    {}
  ],
  "attached_shareables": [
    {}
  ],
  "comments": [
    {}
  ],
  "label": {},
  "display_tag": "string"
}