Skip to main content
POST
Create a new company discount

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
discount
object
required

Response

Success

id
integer
name
string
code
string
price_discount_type
enum<string>
Available options:
flat,
percentage,
free_product,
free_shipping,
free_enrollment_pack
price_discount_amount
integer
price_discount_percent
number
percentage_value
string | null
source
enum<string>
Available options:
promo,
manual,
droplet
value_managed_by_droplet
boolean
reason
string | null
created_by
object | null
active
boolean
automatic
boolean
applicable_for
enum<string> | null
Available options:
everything,
specific_products,
specific_collections,
except_specific_products,
specific_enrollment_packs,
except_specific_enrollment_packs,
null
apply_only_once
boolean | null
apply_to_subscriptions
boolean
apply_to_recurring_subscription_orders
boolean
apply_to_volume
boolean
country_filter
string | null
customer_filter
string | null
shipping_method_filter
string | null
purchase_requirement
string | null
purchase_requirement_applies_to_whole_cart
boolean
has_end_date
boolean | null
start_date_time
string<date-time> | null
end_date_time
string<date-time> | null
start_date
string | null
start_time
string | null
end_date
string | null
end_time
string | null
time_zone
string | null
discount_type
enum<string>
Available options:
product_discount,
shipping_discount
description
string | null

Merchant-only note about the promo code. Never shown to shoppers.

Maximum string length: 1000
total_usage
integer
free_variant_ids
integer[]
free_enrollment_pack_ids
integer[]
waive_enrollment_fee
boolean
applicable_product_ids
integer[]
inapplicable_product_ids
integer[]
applicable_collection_ids
integer[]
applicable_enrollment_pack_ids
integer[]
inapplicable_enrollment_pack_ids
integer[]
collection_ids
integer[]
product_ids
integer[]
customer_ids
integer[]
country_codes
string[]
eligible_customer_ids
integer[]
csv_uploaded_customer_emails
string[]
eligible_country_ids
integer[]
ineligible_country_ids
integer[]
eligible_shipping_method_ids
integer[]
eligible_customer_segments
string[]
minimum_purchase_requirement_amount
number
minimum_purchase_requirement_amount_max
number | null
minimum_purchase_requirement_quantity
integer
minimum_cv
integer | null
maximum_cv
integer | null
customer_usage_limit
integer
minimum_amount_cents
integer
limit_usage_of_code
boolean
limit_usage_per_customer
boolean
other_shipping_discounts
boolean
other_product_discounts
boolean
created_at
string<date-time>
updated_at
string<date-time>
meta
object