Company Discounts
/
Create a new company discount

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

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

Retrieve a list of company discounts

Request

Get all company discounts for the current company.

Query
pageinteger

Page number for pagination

Default 1
per_pageinteger

Number of records per page

Default 10
search_querystring

Search term to filter discounts

activeboolean

Filter by active status

apply_typestring

Filter by discount type

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/discounts?active=true&apply_type=string&page=1&per_page=10&search_query=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

discounts retrieved

Bodyapplication/json
discountsArray of objects
metaobject
Response
application/json
{
  "discounts": [
    { … }
  ],
  "meta": {}
}

Create a new company discount

Request

Create a new company discount

Bodyapplication/json
discountobject
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/company/discounts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "discount": {
      "name": "Summer Sale",
      "code": "SUMMER20",
      "apply_type": "product_discount",
      "price_discount_type": "percentage",
      "price_discount_amount": 0,
      "price_discount_percent": 20,
      "application_rule": "everything",
      "description": "20% off your entire order",
      "active": true
    }
  }'

Responses

discount created

Bodyapplication/json
idinteger
Example: 1
namestring
Example: "Summer Sale"
codestring
Example: "SUMMER20"
price_discount_typestring
Example: "percentage"
price_discount_amountinteger
Example: 0
price_discount_percentnumber
Example: 20
start_date_timestring or null(date_time)
Example: "2023-06-01T00:00:00Z"
end_date_timestring or null(date_time)
Example: "2023-08-31T23:59:59Z"
customer_usage_limitinteger
Example: 1
minimum_amount_centsinteger
Example: 1000
collection_idsArray of integers
Example: [1,2,3]
product_idsArray of integers
Example: [4,5,6]
activeboolean
Example: true
customer_idsArray of integers
Example: [7,8,9]
country_codesArray of strings
Example: ["US","CA"]
created_atstring(date_time)
Example: "2023-06-01T00:00:00Z"
updated_atstring(date_time)
Example: "2023-06-01T00:00:00Z"
discount_typestring
Example: "product_discount"
descriptionstring or null
Example: "20% off your entire order"
total_usageinteger
Example: 42
metaobject
Response
application/json
{
  "id": 1,
  "name": "Summer Sale",
  "code": "SUMMER20",
  "price_discount_type": "percentage",
  "price_discount_amount": 0,
  "price_discount_percent": 20,
  "start_date_time": "2023-06-01T00:00:00Z",
  "end_date_time": "2023-08-31T23:59:59Z",
  "customer_usage_limit": 1,
  "minimum_amount_cents": 1000,
  "collection_ids": [
    1,
    2,
    3
  ],
  "product_ids": [
    4,
    5,
    6
  ],
  "active": true,
  "customer_ids": [
    7,
    8,
    9
  ],
  "country_codes": [
    "US",
    "CA"
  ],
  "created_at": "2023-06-01T00:00:00Z",
  "updated_at": "2023-06-01T00:00:00Z",
  "discount_type": "product_discount",
  "description": "20% off your entire order",
  "total_usage": 42,
  "meta": {}
}

Retrieve a single company discount

Request

Fetch a specific discount by its ID for the current company.

Path
idintegerrequired

Discount's Id

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

Responses

discount retrieved

Bodyapplication/json
idinteger
Example: 1
namestring
Example: "Summer Sale"
codestring
Example: "SUMMER20"
price_discount_typestring
Example: "percentage"
price_discount_amountinteger
Example: 0
price_discount_percentnumber
Example: 20
start_date_timestring or null(date_time)
Example: "2023-06-01T00:00:00Z"
end_date_timestring or null(date_time)
Example: "2023-08-31T23:59:59Z"
customer_usage_limitinteger
Example: 1
minimum_amount_centsinteger
Example: 1000
collection_idsArray of integers
Example: [1,2,3]
product_idsArray of integers
Example: [4,5,6]
activeboolean
Example: true
customer_idsArray of integers
Example: [7,8,9]
country_codesArray of strings
Example: ["US","CA"]
created_atstring(date_time)
Example: "2023-06-01T00:00:00Z"
updated_atstring(date_time)
Example: "2023-06-01T00:00:00Z"
discount_typestring
Example: "product_discount"
descriptionstring or null
Example: "20% off your entire order"
total_usageinteger
Example: 42
metaobject
Response
application/json
{
  "id": 1,
  "name": "Summer Sale",
  "code": "SUMMER20",
  "price_discount_type": "percentage",
  "price_discount_amount": 0,
  "price_discount_percent": 20,
  "start_date_time": "2023-06-01T00:00:00Z",
  "end_date_time": "2023-08-31T23:59:59Z",
  "customer_usage_limit": 1,
  "minimum_amount_cents": 1000,
  "collection_ids": [
    1,
    2,
    3
  ],
  "product_ids": [
    4,
    5,
    6
  ],
  "active": true,
  "customer_ids": [
    7,
    8,
    9
  ],
  "country_codes": [
    "US",
    "CA"
  ],
  "created_at": "2023-06-01T00:00:00Z",
  "updated_at": "2023-06-01T00:00:00Z",
  "discount_type": "product_discount",
  "description": "20% off your entire order",
  "total_usage": 42,
  "meta": {}
}

Update a company discount

Request

Update the details of a specific company discount.

Path
idintegerrequired

Discount's Id

Bodyapplication/json
discountobject
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/discounts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "discount": {
      "name": "Updated Sale",
      "code": "UPDATED20",
      "active": false
    }
  }'

Responses

discount updated

Bodyapplication/json
idinteger
Example: 1
namestring
Example: "Summer Sale"
codestring
Example: "SUMMER20"
price_discount_typestring
Example: "percentage"
price_discount_amountinteger
Example: 0
price_discount_percentnumber
Example: 20
start_date_timestring or null(date_time)
Example: "2023-06-01T00:00:00Z"
end_date_timestring or null(date_time)
Example: "2023-08-31T23:59:59Z"
customer_usage_limitinteger
Example: 1
minimum_amount_centsinteger
Example: 1000
collection_idsArray of integers
Example: [1,2,3]
product_idsArray of integers
Example: [4,5,6]
activeboolean
Example: true
customer_idsArray of integers
Example: [7,8,9]
country_codesArray of strings
Example: ["US","CA"]
created_atstring(date_time)
Example: "2023-06-01T00:00:00Z"
updated_atstring(date_time)
Example: "2023-06-01T00:00:00Z"
discount_typestring
Example: "product_discount"
descriptionstring or null
Example: "20% off your entire order"
total_usageinteger
Example: 42
metaobject
Response
application/json
{
  "id": 1,
  "name": "Summer Sale",
  "code": "SUMMER20",
  "price_discount_type": "percentage",
  "price_discount_amount": 0,
  "price_discount_percent": 20,
  "start_date_time": "2023-06-01T00:00:00Z",
  "end_date_time": "2023-08-31T23:59:59Z",
  "customer_usage_limit": 1,
  "minimum_amount_cents": 1000,
  "collection_ids": [
    1,
    2,
    3
  ],
  "product_ids": [
    4,
    5,
    6
  ],
  "active": true,
  "customer_ids": [
    7,
    8,
    9
  ],
  "country_codes": [
    "US",
    "CA"
  ],
  "created_at": "2023-06-01T00:00:00Z",
  "updated_at": "2023-06-01T00:00:00Z",
  "discount_type": "product_discount",
  "description": "20% off your entire order",
  "total_usage": 42,
  "meta": {}
}

Delete a company discount

Request

Delete a specific discount for the current company.

Path
idintegerrequired

Discount's Id

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

Responses

discount deleted

Company Droplets

Operations

Company Pages

Operations

Company Popups

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Social Media

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

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Public Companies

Operations

Redirects

Operations

Refunds

Operations

Roles

Operations

Shares

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