Company Discounts
/
Delete a 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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Admins

Operations

Agreements

Operations

ApplePay

Operations

Application Theme Templates

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Categories

Operations

Collections

Operations

Companies

Operations

Company Admins

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

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

sorted_bystring

Sort the records by one of the supported attributes:

  • created_at
  • used
  • code
  • active
  • price_discount_type
  • automatic The sort attribute should be followed by one of the order directives: '_asc', '_desc'
curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/discounts?active=true&page=1&per_page=10&search_query=string&sorted_by=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

discounts retrieved

Bodyapplication/json
discountsArray of objects
metaobject
Response
application/json
{
  "discounts": [
    { … }
  ],
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z",
    "pagination": { … }
  }
}

Create a new company discount

Request

Create a new company discount

Bodyapplication/json
discountobject
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/discounts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "discount": {
      "code": "SUMMER20",
      "apply_type": "product_discount",
      "price_discount_type": "free_product",
      "percentage_value": 10.15,
      "flat_value": 10.15,
      "free_product_ids": [
        1,
        2
      ],
      "automatic": true,
      "applicable_for": "everything",
      "product_ids": [
        1,
        2
      ],
      "applicable_collection_ids": [
        1,
        2
      ],
      "apply_only_once": true,
      "apply_to_subscriptions": true,
      "country_filter": "apply_all",
      "country_ids": [
        1,
        2
      ],
      "purchase_requirement": "no_minimum_required",
      "minimum_purchase_requirement_amount": 10.15,
      "minimum_purchase_requirement_quantity": 2,
      "purchase_requirement_applies_to_whole_cart": true,
      "customer_filter": "all_customers",
      "eligible_customer_ids": [
        1,
        2
      ],
      "eligible_customer_segments": [
        "user guest"
      ],
      "limit_usage_of_code": true,
      "use_limit": 3,
      "limit_usage_per_customer": true,
      "guest_shopper_type": true,
      "member_shopper_type": true,
      "other_shipping_discounts": true,
      "other_product_discounts": true,
      "active": true,
      "start_date": "2025-07-02",
      "start_time": "14:30 PM",
      "has_end_date": true,
      "end_date": "2025-07-03",
      "end_time": "14:30 AM",
      "time_zone": "Europe/London"
    }
  }'

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"
start_datestring or null(date)
Example: "2023-06-01"
start_timestring or null(time)
Example: "16:00"
end_date_timestring or null(date_time)
Example: "2023-08-31T23:59:59Z"
end_datestring or null(date)
Example: "2023-06-01"
end_timestring or null(time)
Example: "03:00"
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
automaticboolean
Example: true
percentage_valuestring or null
Example: "10.21"
applicable_forstring
Example: "everything"
apply_only_onceboolean or null
Example: true
apply_to_subscriptionsboolean
Example: true
country_filterstring
Example: "apply_all"
purchase_requirementstring
Example: "no_minimum_required"
purchase_requirement_applies_to_whole_cartboolean
Example: true
customer_filterstring
Example: "all_customer"
has_end_dateboolean or null
Example: true
time_zonestring or null
Example: "UK"
free_product_idsArray of integers
Example: [4,5,6]
applicable_product_idsArray of integers
Example: [4,5,6]
inapplicable_product_idsArray of integers
Example: [4,5,6]
applicable_collection_idsArray of integers
Example: [4,5,6]
eligible_customer_idsArray of integers
Example: [4,5,6]
eligible_country_idsArray of integers
Example: [4,5,6]
ineligible_country_idsArray of integers
Example: [4,5,6]
minimum_purchase_requirement_amountnumber(float)
Example: 10.15
minimum_purchase_requirement_quantityinteger
Example: 2
eligible_customer_segmentsArray of strings
Example: ["user"]
limit_usage_of_codeboolean
Example: true
limit_usage_per_customerboolean
Example: true
guest_shopper_typeboolean
Example: true
member_shopper_typeboolean
Example: true
other_shipping_discountsboolean
Example: true
other_product_discountsboolean
Example: true
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",
  "start_date": "2023-06-01",
  "start_time": "16:00",
  "end_date_time": "2023-08-31T23:59:59Z",
  "end_date": "2023-06-01",
  "end_time": "03:00",
  "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,
  "automatic": true,
  "percentage_value": "10.21",
  "applicable_for": "everything",
  "apply_only_once": true,
  "apply_to_subscriptions": true,
  "country_filter": "apply_all",
  "purchase_requirement": "no_minimum_required",
  "purchase_requirement_applies_to_whole_cart": true,
  "customer_filter": "all_customer",
  "has_end_date": true,
  "time_zone": "UK",
  "free_product_ids": [
    4,
    5,
    6
  ],
  "applicable_product_ids": [
    4,
    5,
    6
  ],
  "inapplicable_product_ids": [
    4,
    5,
    6
  ],
  "applicable_collection_ids": [
    4,
    5,
    6
  ],
  "eligible_customer_ids": [
    4,
    5,
    6
  ],
  "eligible_country_ids": [
    4,
    5,
    6
  ],
  "ineligible_country_ids": [
    4,
    5,
    6
  ],
  "minimum_purchase_requirement_amount": 10.15,
  "minimum_purchase_requirement_quantity": 2,
  "eligible_customer_segments": [
    "user"
  ],
  "limit_usage_of_code": true,
  "limit_usage_per_customer": true,
  "guest_shopper_type": true,
  "member_shopper_type": true,
  "other_shipping_discounts": true,
  "other_product_discounts": true,
  "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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/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"
start_datestring or null(date)
Example: "2023-06-01"
start_timestring or null(time)
Example: "16:00"
end_date_timestring or null(date_time)
Example: "2023-08-31T23:59:59Z"
end_datestring or null(date)
Example: "2023-06-01"
end_timestring or null(time)
Example: "03:00"
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
automaticboolean
Example: true
percentage_valuestring or null
Example: "10.21"
applicable_forstring
Example: "everything"
apply_only_onceboolean or null
Example: true
apply_to_subscriptionsboolean
Example: true
country_filterstring
Example: "apply_all"
purchase_requirementstring
Example: "no_minimum_required"
purchase_requirement_applies_to_whole_cartboolean
Example: true
customer_filterstring
Example: "all_customer"
has_end_dateboolean or null
Example: true
time_zonestring or null
Example: "UK"
free_product_idsArray of integers
Example: [4,5,6]
applicable_product_idsArray of integers
Example: [4,5,6]
inapplicable_product_idsArray of integers
Example: [4,5,6]
applicable_collection_idsArray of integers
Example: [4,5,6]
eligible_customer_idsArray of integers
Example: [4,5,6]
eligible_country_idsArray of integers
Example: [4,5,6]
ineligible_country_idsArray of integers
Example: [4,5,6]
minimum_purchase_requirement_amountnumber(float)
Example: 10.15
minimum_purchase_requirement_quantityinteger
Example: 2
eligible_customer_segmentsArray of strings
Example: ["user"]
limit_usage_of_codeboolean
Example: true
limit_usage_per_customerboolean
Example: true
guest_shopper_typeboolean
Example: true
member_shopper_typeboolean
Example: true
other_shipping_discountsboolean
Example: true
other_product_discountsboolean
Example: true
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",
  "start_date": "2023-06-01",
  "start_time": "16:00",
  "end_date_time": "2023-08-31T23:59:59Z",
  "end_date": "2023-06-01",
  "end_time": "03:00",
  "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,
  "automatic": true,
  "percentage_value": "10.21",
  "applicable_for": "everything",
  "apply_only_once": true,
  "apply_to_subscriptions": true,
  "country_filter": "apply_all",
  "purchase_requirement": "no_minimum_required",
  "purchase_requirement_applies_to_whole_cart": true,
  "customer_filter": "all_customer",
  "has_end_date": true,
  "time_zone": "UK",
  "free_product_ids": [
    4,
    5,
    6
  ],
  "applicable_product_ids": [
    4,
    5,
    6
  ],
  "inapplicable_product_ids": [
    4,
    5,
    6
  ],
  "applicable_collection_ids": [
    4,
    5,
    6
  ],
  "eligible_customer_ids": [
    4,
    5,
    6
  ],
  "eligible_country_ids": [
    4,
    5,
    6
  ],
  "ineligible_country_ids": [
    4,
    5,
    6
  ],
  "minimum_purchase_requirement_amount": 10.15,
  "minimum_purchase_requirement_quantity": 2,
  "eligible_customer_segments": [
    "user"
  ],
  "limit_usage_of_code": true,
  "limit_usage_per_customer": true,
  "guest_shopper_type": true,
  "member_shopper_type": true,
  "other_shipping_discounts": true,
  "other_product_discounts": true,
  "meta": {}
}

Update a company discount

Request

Update the details of a specific company discount.

Path
idintegerrequired

Discount's Id

Bodyapplication/json
idinteger
Example: 123
discountobject
curl -i -X PUT \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/discounts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 123,
    "discount": {
      "code": "SUMMER20",
      "price_discount_type": "free_product",
      "percentage_value": 10.15,
      "flat_value": 10.15,
      "free_product_ids": [
        1,
        2
      ],
      "automatic": true,
      "applicable_for": "everything",
      "product_ids": [
        1,
        2
      ],
      "applicable_collection_ids": [
        1,
        2
      ],
      "apply_only_once": true,
      "apply_to_subscriptions": true,
      "country_filter": "apply_all",
      "country_ids": [
        1,
        2
      ],
      "purchase_requirement": "no_minimum_required",
      "minimum_purchase_requirement_amount": 10.15,
      "minimum_purchase_requirement_quantity": 2,
      "purchase_requirement_applies_to_whole_cart": true,
      "customer_filter": "all_customers",
      "eligible_customer_ids": [
        1,
        2
      ],
      "eligible_customer_segments": [
        "user guest"
      ],
      "limit_usage_of_code": true,
      "use_limit": 3,
      "limit_usage_per_customer": true,
      "guest_shopper_type": true,
      "member_shopper_type": true,
      "other_shipping_discounts": true,
      "other_product_discounts": true,
      "active": true,
      "start_date": "2025-07-02",
      "start_time": "14:30 PM",
      "has_end_date": true,
      "end_date": "2025-07-03",
      "end_time": "14:30 AM",
      "time_zone": "Europe/London"
    }
  }'

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"
start_datestring or null(date)
Example: "2023-06-01"
start_timestring or null(time)
Example: "16:00"
end_date_timestring or null(date_time)
Example: "2023-08-31T23:59:59Z"
end_datestring or null(date)
Example: "2023-06-01"
end_timestring or null(time)
Example: "03:00"
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
automaticboolean
Example: true
percentage_valuestring or null
Example: "10.21"
applicable_forstring
Example: "everything"
apply_only_onceboolean or null
Example: true
apply_to_subscriptionsboolean
Example: true
country_filterstring
Example: "apply_all"
purchase_requirementstring
Example: "no_minimum_required"
purchase_requirement_applies_to_whole_cartboolean
Example: true
customer_filterstring
Example: "all_customer"
has_end_dateboolean or null
Example: true
time_zonestring or null
Example: "UK"
free_product_idsArray of integers
Example: [4,5,6]
applicable_product_idsArray of integers
Example: [4,5,6]
inapplicable_product_idsArray of integers
Example: [4,5,6]
applicable_collection_idsArray of integers
Example: [4,5,6]
eligible_customer_idsArray of integers
Example: [4,5,6]
eligible_country_idsArray of integers
Example: [4,5,6]
ineligible_country_idsArray of integers
Example: [4,5,6]
minimum_purchase_requirement_amountnumber(float)
Example: 10.15
minimum_purchase_requirement_quantityinteger
Example: 2
eligible_customer_segmentsArray of strings
Example: ["user"]
limit_usage_of_codeboolean
Example: true
limit_usage_per_customerboolean
Example: true
guest_shopper_typeboolean
Example: true
member_shopper_typeboolean
Example: true
other_shipping_discountsboolean
Example: true
other_product_discountsboolean
Example: true
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",
  "start_date": "2023-06-01",
  "start_time": "16:00",
  "end_date_time": "2023-08-31T23:59:59Z",
  "end_date": "2023-06-01",
  "end_time": "03:00",
  "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,
  "automatic": true,
  "percentage_value": "10.21",
  "applicable_for": "everything",
  "apply_only_once": true,
  "apply_to_subscriptions": true,
  "country_filter": "apply_all",
  "purchase_requirement": "no_minimum_required",
  "purchase_requirement_applies_to_whole_cart": true,
  "customer_filter": "all_customer",
  "has_end_date": true,
  "time_zone": "UK",
  "free_product_ids": [
    4,
    5,
    6
  ],
  "applicable_product_ids": [
    4,
    5,
    6
  ],
  "inapplicable_product_ids": [
    4,
    5,
    6
  ],
  "applicable_collection_ids": [
    4,
    5,
    6
  ],
  "eligible_customer_ids": [
    4,
    5,
    6
  ],
  "eligible_country_ids": [
    4,
    5,
    6
  ],
  "ineligible_country_ids": [
    4,
    5,
    6
  ],
  "minimum_purchase_requirement_amount": 10.15,
  "minimum_purchase_requirement_quantity": 2,
  "eligible_customer_segments": [
    "user"
  ],
  "limit_usage_of_code": true,
  "limit_usage_per_customer": true,
  "guest_shopper_type": true,
  "member_shopper_type": true,
  "other_shipping_discounts": true,
  "other_product_discounts": true,
  "meta": {}
}

Delete a company discount

Request

Delete a specific discount for the current company.

Path
idintegerrequired

Discount's Id

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

Responses

discount deleted

Clones a discount

Request

Path
idintegerrequired

Discount Id

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

Responses

discount cloned

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"
start_datestring or null(date)
Example: "2023-06-01"
start_timestring or null(time)
Example: "16:00"
end_date_timestring or null(date_time)
Example: "2023-08-31T23:59:59Z"
end_datestring or null(date)
Example: "2023-06-01"
end_timestring or null(time)
Example: "03:00"
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
automaticboolean
Example: true
percentage_valuestring or null
Example: "10.21"
applicable_forstring
Example: "everything"
apply_only_onceboolean or null
Example: true
apply_to_subscriptionsboolean
Example: true
country_filterstring
Example: "apply_all"
purchase_requirementstring
Example: "no_minimum_required"
purchase_requirement_applies_to_whole_cartboolean
Example: true
customer_filterstring
Example: "all_customer"
has_end_dateboolean or null
Example: true
time_zonestring or null
Example: "UK"
free_product_idsArray of integers
Example: [4,5,6]
applicable_product_idsArray of integers
Example: [4,5,6]
inapplicable_product_idsArray of integers
Example: [4,5,6]
applicable_collection_idsArray of integers
Example: [4,5,6]
eligible_customer_idsArray of integers
Example: [4,5,6]
eligible_country_idsArray of integers
Example: [4,5,6]
ineligible_country_idsArray of integers
Example: [4,5,6]
minimum_purchase_requirement_amountnumber(float)
Example: 10.15
minimum_purchase_requirement_quantityinteger
Example: 2
eligible_customer_segmentsArray of strings
Example: ["user"]
limit_usage_of_codeboolean
Example: true
limit_usage_per_customerboolean
Example: true
guest_shopper_typeboolean
Example: true
member_shopper_typeboolean
Example: true
other_shipping_discountsboolean
Example: true
other_product_discountsboolean
Example: true
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",
  "start_date": "2023-06-01",
  "start_time": "16:00",
  "end_date_time": "2023-08-31T23:59:59Z",
  "end_date": "2023-06-01",
  "end_time": "03:00",
  "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,
  "automatic": true,
  "percentage_value": "10.21",
  "applicable_for": "everything",
  "apply_only_once": true,
  "apply_to_subscriptions": true,
  "country_filter": "apply_all",
  "purchase_requirement": "no_minimum_required",
  "purchase_requirement_applies_to_whole_cart": true,
  "customer_filter": "all_customer",
  "has_end_date": true,
  "time_zone": "UK",
  "free_product_ids": [
    4,
    5,
    6
  ],
  "applicable_product_ids": [
    4,
    5,
    6
  ],
  "inapplicable_product_ids": [
    4,
    5,
    6
  ],
  "applicable_collection_ids": [
    4,
    5,
    6
  ],
  "eligible_customer_ids": [
    4,
    5,
    6
  ],
  "eligible_country_ids": [
    4,
    5,
    6
  ],
  "ineligible_country_ids": [
    4,
    5,
    6
  ],
  "minimum_purchase_requirement_amount": 10.15,
  "minimum_purchase_requirement_quantity": 2,
  "eligible_customer_segments": [
    "user"
  ],
  "limit_usage_of_code": true,
  "limit_usage_per_customer": true,
  "guest_shopper_type": true,
  "member_shopper_type": true,
  "other_shipping_discounts": true,
  "other_product_discounts": true,
  "meta": {}
}

Bulk deletes discounts

Request

Bodyapplication/jsonrequired
discount_idsArray of integersrequired
Example: [1,2]
curl -i -X DELETE \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/discounts/bulk_delete \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "discount_ids": [
      1,
      2
    ]
  }'

Responses

success

Bodyapplication/json
discount_idsArray of integers
Example: [1,2]
metaobject
Response
application/json
{
  "discount_ids": [
    1,
    2
  ]
}

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

Operations

Company Popups

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Social Media

Operations

Company Settings - Warehouses

Operations

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Menus

Operations

Metafield Definitions

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Order Fulfillments

Operations

Orders

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Settings

Operations

Settings - Companies

Operations

Shares

Operations

Shop

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations