Remove metadata field(s)

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

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}/

Agreements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Droplets

Operations

Company Pages

Operations

Company Popups

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Warehouses

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

Fluid Pay

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Order Fulfillments

Operations

Orders

Operations

List Commerce Orders

Request

List all commerce orders

Query

pageinteger

Page number

Example: page=1

per_pageinteger

Number of orders per page

Example: per_page=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

unfulfilledboolean

Filter for unfulfilled records

Example: unfulfilled=true

unpaidboolean

Filter for unpaid records

Example: unpaid=true

search_querystring

Search keyword

Example: search_query=john doe

within_daysinteger

Limit results to within the last N days

Example: within_days=30

metadatastring

Metadata filter in JSON format

Example: metadata={"some_key": "some_value"}

subscription_idinteger

Subscription ID

Example: subscription_id=123

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v202506/orders?customer_id=0&end_date=string&metadata=string&page=0&per_page=0&search_query=string&start_date=string&subscription_id=0&unfulfilled=true&unpaid=true&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[].amountstring

Example: "0.0"

orders[].bill_toobject

orders[].created_atstring

Example: "2025-04-25T08:54:27Z"

orders[].currency_codestring

Example: "USD"

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[].shippingstring

Example: "0.0"

orders[].statusstring

Example: "awaiting_payment"

orders[].taxstring

Example: "0.0"

orders[].tokenstring

Example: "fo_5gczy7wuboaugpn0hemvec"

orders[].updated_atstring

Example: "2025-04-25T08:54:27Z"

metaobjectrequired

meta.request_idstring

Example: "5d72c7cd-54c5-449d-93f5-6da4631cd267"

meta.timestampstring

Example: "2025-04-25T09:13:38Z"

meta.paginationobject

Response

application/json

{
  "orders": [
    { … }
  ],
  "meta": {
    "request_id": "5d72c7cd-54c5-449d-93f5-6da4631cd267",
    "timestamp": "2025-04-25T09:13:38Z",
    "pagination": { … }
  }
}

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.amountstring

Example: "0.0"

order.bill_toobject

order.created_atstring

Example: "2025-04-25T08:54:27Z"

order.currency_codestring

Example: "USD"

order.customerobject

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.shippingstring

Example: "0.0"

order.statusstring

Example: "awaiting_payment"

order.taxstring

Example: "0.0"

order.tokenstring

Example: "fo_5gczy7wuboaugpn0hemvec"

order.updated_atstring

Example: "2025-04-25T08:54:27Z"

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,
    "amount": "0.0",
    "bill_to": { … },
    "created_at": "2025-04-25T08:54:27Z",
    "currency_code": "USD",
    "customer": { … },
    "email": "john.doe1@fluid.app",
    "first_name": "Morgan",
    "items": [ … ],
    "last_name": "Olson",
    "note": "Order notes",
    "order_number": "1001",
    "ship_to": { … },
    "shipping": "0.0",
    "status": "awaiting_payment",
    "tax": "0.0",
    "token": "fo_5gczy7wuboaugpn0hemvec",
    "updated_at": "2025-04-25T08:54:27Z"
  },
  "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

emailstring

Example: "customer@example.com"

statusstring

Example: "draft"

payment_statusstring

Example: "marked_paid/free"

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 '{
    "email": "customer@example.com",
    "status": "draft",
    "payment_status": "marked_paid/free"
  }'

Responses

successful

Bodyapplication/json

orderobjectrequired

order.idintegerrequired

order.currency_symbolstringrequired

order.currency_codestring

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.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.discountstring

Example: "3.00"

order.discount_in_currencystring

Example: "$3.00"

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.delivery_statusstringrequired

order.delivery_methodstringrequired

order.delivery_datestring or null

Example: "2023-07-29"

order.channelstringrequired

order.tagsstringrequired

order.items_countintegerrequired

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[].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[].ordered_variantArray of objects

order.items[].productobject

order.items[].variantobject

order.activitiesArray of objects

order.shipping_methodobject or null

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

Example: "US"

order.ship_to.subdivision_codestring or null

Example: "NY"

order.ship_to.defaultboolean

Example: true

order.bill_toobject

order.companyobject

order.metadataobject or null

metaobjectrequired

meta.request_idstring

meta.timestampstring

meta.shop_urlstring

Response

application/json

{
  "order": {
    "id": 0,
    "currency_symbol": "string",
    "currency_code": "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",
    "sub_total": "90.00",
    "sub_total_in_currency": "$90.00",
    "tax": "2.00",
    "tax_in_currency": "$2.00",
    "discount": "3.00",
    "discount_in_currency": "$3.00",
    "shipping": "$11.00",
    "shipping_in_currency": { … },
    "refundable_amount": 10.5,
    "payment_status": "string",
    "enrollment_token": "string",
    "enrollment_pack": { … },
    "fulfillment_status": "string",
    "delivery_status": "string",
    "delivery_method": "string",
    "delivery_date": "2023-07-29",
    "channel": "string",
    "tags": "string",
    "items_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": { … },
    "company": { … },
    "metadata": {}
  },
  "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",
    "items": [ … ],
    "bill_to": {},
    "ship_to": {},
    "customer": { … }
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string"
  }
}

List Orders

Request

Returns a page of orders with stats that reflect the entire dataset, not just the current page

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 product SKU

within_daysinteger

Filter orders created within the last number of days

pageinteger

Page number for pagination

Default 1

per_pageinteger

Number of records per page

Default 10

by_metadatastring(json)

Search JSON meta data

Default "{}"

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v2/orders?by_metadata={}&customer_id=0&page=1&per_page=10&search_query=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[].statusstring

Example: "awaiting_payment"

orders[].fulfillment_statusstring

Example: "Fulfilled"

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[].notestring or null

Example: "Order note"

orders[].cvinteger

Example: 100

orders[].qvinteger

Example: 100

orders[].external_idstring or null

Example: "1234567890"

orders[].metadataobject

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

orders[].shipping_in_currencyobject or null

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[].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[].companyobject

metaobjectrequired

meta.request_idstring

Example: "84eadc2f-4e51-4e3f-9f96-e8d7ba35cea4"

meta.timestampstring

Example: "2025-05-07T08:25:35Z"

meta.current_pageinteger

Example: 2

meta.next_pageinteger or null

meta.prev_pageinteger or null

meta.total_pagesinteger

Example: 4

meta.total_countinteger

Example: 10

meta.average_cvnumber(float)

Example: 55

meta.total_cvinteger

Example: 550

meta.average_amount_basenumber(float)

Example: 550

meta.total_amount_baseinteger

Example: 5500

meta.fulfilled_orders_countinteger

Example: 10

Response

application/json

{
  "orders": [
    { … }
  ],
  "meta": {
    "request_id": "84eadc2f-4e51-4e3f-9f96-e8d7ba35cea4",
    "timestamp": "2025-05-07T08:25:35Z",
    "current_page": 2,
    "next_page": 0,
    "prev_page": 0,
    "total_pages": 4,
    "total_count": 10,
    "average_cv": 55,
    "total_cv": 550,
    "average_amount_base": 550,
    "total_amount_base": 5500,
    "fulfilled_orders_count": 10
  }
}

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_ordersinteger

Example: 10

total_cancelled_ordersinteger

Example: 5

total_shipped_ordersinteger

Example: 5

metaobject

Response

application/json

{
  "total_orders": 10,
  "total_cancelled_orders": 5,
  "total_shipped_orders": 5,
  "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",
    "payment_status": "Paid",
    "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": { … },
    "items_count": 10,
    "metadata": { … },
    "transaction_fee": 3,
    "transaction_fee_in_currency": "$3.00 USD",
    "discount": "10.00",
    "tax": "8.00",
    "dynamic_charges": { … },
    "dynamic_charges_in_currency": { … },
    "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"
  },
  "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",
    "payment_status": "Paid",
    "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": { … },
    "items_count": 10,
    "metadata": { … },
    "transaction_fee": 3,
    "transaction_fee_in_currency": "$3.00 USD",
    "discount": "10.00",
    "tax": "8.00",
    "dynamic_charges": { … },
    "dynamic_charges_in_currency": { … },
    "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"
  },
  "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

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": [
      "string"
    ]
  }'

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",
    "payment_status": "Paid",
    "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": { … },
    "items_count": 10,
    "metadata": { … },
    "transaction_fee": 3,
    "transaction_fee_in_currency": "$3.00 USD",
    "discount": "10.00",
    "tax": "8.00",
    "dynamic_charges": { … },
    "dynamic_charges_in_currency": { … },
    "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"
  },
  "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"
  }
}

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Public Companies

Operations

Redirects

Operations

Refunds

Operations

Roles

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Webhooks

Operations

returns a list of all droplet categories

Request

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

Responses

returns a list of droplet categories

Bodyapplication/json

droplet_categoriesArray of objects(DropletCategory)

metaobject

Response

application/json

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

Fluid Commerce APIs (1.0)

Agreements

ApplePay

Application Themes

ApplicationThemeTemplates

Authentication

Callback Definitions

Callback Registrations

Carts

Company Custom Catch Ups

Company Discounts

Company Droplets

Company Pages

Company Popups

Company Settings - Checkout

Company Settings - Countries

Company Settings - Languages

Company Settings - Social Media

Company Settings - Warehouses

Contacts

Currencies

Customer Orders

CustomerNotes

Customers

Domains

Drop Zones

Droplets

Enrollment Packs

Enrollments

Fantasy Points

Fluid Pay

GlobalEmbeds

Inventory Levels

Multi-Factor Authentications

Notifications

Order Fulfillments

Orders

List Commerce Orders

Request

Responses

Was this helpful?

Retrieve Commerce Order

Request

Responses

Was this helpful?

Create Order

Request

Responses

Was this helpful?

Transfer an order to a different customer

Request

Responses

Was this helpful?

List Orders

Request

Responses

Was this helpful?

Orders' stats

Request

Responses

Was this helpful?

Show Order

Request

Responses

Was this helpful?

Cancel an Order

Request

Responses

Was this helpful?

Charge an Order

Request

Responses

Was this helpful?

Append metadata field

Request

Responses

Was this helpful?

Remove metadata field(s)

Request

Responses

Request