Orders

Fluid SDK API Documentation (0.0.6)

OpenAPI documentation for Fluid's SDK API

Download OpenAPI description
public.json
public.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/public/
Production API server
https://api.fluid.app/
Local development server
https://api.fluid.test/

Orders

Operations

Retrieves an order with points redemption

Request

Path
tokenstringrequired
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/public/api/public/v2025-06/orders/{token}'

Responses

order with points found

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.​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.​subtotal_after_discountsstring
Example: "90.00"
order.​taxstring
Example: "2.00"
order.​tax_in_currencystring
Example: "$2.00"
order.​tokenstring
Example: "fo_abcdefgh1234"
order.​transaction_feestring
Example: "1.00"
order.​transaction_fee_in_currencystring
Example: "$1.00"
order.​discountstring
Example: "3.00"
order.​discount_in_currencystring
Example: "$3.00"
order.​refundable_amountnumber or string(float)
Example: 10.5
order.​shippingstring
Example: "$11.00"
order.​shipping_in_currencyobject or null
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 null
order.​payment_detailsobject or nullrequired
order.​payment_details.​sourcestring
Example: "card"
order.​payment_details.​payment_typestring
order.​payment_details.​payment_titlestring
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.​warehouse_idinteger or null
Example: 1
order.​warehouseWarehouse (object) or null
One of:
order.​companyobject
order.​order_on_behalf_ofboolean
Example: true
order.​volume_repobject or null
order.​metadataobject or null
order.​metafieldsArray of objects(LegacyMetafield)
order.​sourcestring
Enum"mobile""web""admin""backoffice""subscription"
Example: "web"
order.​split_paymentobject or null

Details about split payment if points were used

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.​price_inclusive_of_taxboolean

Whether the price includes tax

Example: true
order.​price_inclusive_tax_namestring or null

Name of the tax if price is inclusive, e.g. VAT, GST

Example: "GST"
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"]
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",
    "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",
    "subtotal_after_discounts": "90.00",
    "tax": "2.00",
    "tax_in_currency": "$2.00",
    "token": "fo_abcdefgh1234",
    "transaction_fee": "1.00",
    "transaction_fee_in_currency": "$1.00",
    "discount": "3.00",
    "discount_in_currency": "$3.00",
    "refundable_amount": 10.5,
    "shipping": "$11.00",
    "shipping_in_currency": { … },
    "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": { … },
    "warehouse_id": 1,
    "warehouse": { … },
    "company": { … },
    "order_on_behalf_of": true,
    "volume_rep": { … },
    "metadata": {},
    "metafields": [ … ],
    "source": "web",
    "split_payment": {},
    "points_applied": 500,
    "points_applied_amount_in_currency": 5,
    "order_total_after_points_redemption": 95,
    "price_inclusive_of_tax": true,
    "price_inclusive_tax_name": "GST",
    "free_shipping": false,
    "discount_codes": [ … ]
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string",
    "shop_url": "string"
  }
}

affiliate

Operations

carts

Operations

checkout

Operations

commerce

Operations

enrollment-packs

Operations

events

Operations

lead

Operations

page

Operations

url

Operations

fingerprint

Operations

media

Operations

playlist

Operations

product

Operations

session

Operations

settings

Operations

widgets

Operations