DocsAdminCatalog and InventoryPromotionsExamples

Order Promotion Code Samples

$X off when you purchase two of X product or one of X product (OR operator)

Example request
{
  "name": "$50 off when you buy two tiered wire baskets or a small purple towel",
  "redemption_type": "AUTOMATIC",
  "rules": [
    {
      "condition": {
        "or": [
          {
            "cart": {
              "items": {
                "products": [
                  118
                ]
              },
              "minimum_quantity": 2
            }
          },
          {
            "cart": {
              "items": {
                "variants": [
                  134
                ]
              },
              "minimum_quantity": 1
            }
          }
        ]
      },
      "action": {
        "cart_value": {
          "discount": {
            "fixed_amount": "50"
          }
        }
      },
      "apply_once": true
    }
  ]
}

Spend XandgetX and get X off order

Example request
{
  "name": "Spend $X and get $X off order",
  "redemption_type": "AUTOMATIC",
  "rules": [
    {
      "action": {
        "cart_value": {
          "discount": {
            "fixed_amount": "20"
          }
        }
      },
      "apply_once": true,
      "stop": true,
      "condition": {
        "cart": {
          "minimum_spend": "200"
        }
      }
    }
  ],
  "notifications": [
    {
      "type": "UPSELL",
      "content": "<div>&nbsp;</div>",
      "locations": [
        "CART_PAGE"
      ]
    },
    {
      "type": "ELIGIBLE",
      "content": "<div>&nbsp;</div>",
      "locations": [
        "CART_PAGE"
      ]
    },
    {
      "type": "APPLIED",
      "content": "<div>&nbsp;</div>",
      "locations": [
        "CART_PAGE"
      ]
    }
  ],
  "stop": false,
  "currency_code": "USD",
  "status": "ENABLED"
}

Order at least $X and get X item free

Example request
{
  "name": "Order at least $X and get X item free",
  "redemption_type": "AUTOMATIC",
  "rules": [
    {
      "action": {
        "gift_item": {
          "product_id": 130,
          "quantity": 1
        }
      },
      "apply_once": true,
      "stop": false,
      "currency_code": "AUD",
      "condition": {
        "cart": {
          "minimum_spend": "200"
        }
      }
    }
  ],
  "notifications": [
    {
      "type": "UPSELL",
      "content": "<div>&nbsp;</div>",
      "locations": [
        "CART_PAGE"
      ]
    },
    {
      "type": "ELIGIBLE",
      "content": "<div>&nbsp;</div>",
      "locations": [
        "CART_PAGE"
      ]
    },
    {
      "type": "APPLIED",
      "content": "<div>&nbsp;</div>",
      "locations": [
        "CART_PAGE"
      ]
    }
  ],
  "stop": false,
  "status": "ENABLED"
}

Take X% off items storewide except for X category (NOT operator)

Example request
{
  "name": "15% off store except sale",
  "redemption_type": "AUTOMATIC",
  "rules": [
    {
      "action": {
        "cart_items": {
          "discount": {
            "percentage_amount": "15"
          },
          "items": {
            "not": {
              "categories": [
                24
              ]
            }
          }
        }
      },
      "apply_once": true,
      "stop": true
    }
  ],
  "notifications": [
    {
      "type": "UPSELL",
      "content": "15% off store except sale",
      "locations": [
        "HOME_PAGE",
        "PRODUCT_PAGE",
        "CART_PAGE"
      ]
    },
    {
      "type": "ELIGIBLE",
      "content": "15% off store except sale",
      "locations": [
        "CART_PAGE"
      ]
    },
    {
      "type": "APPLIED",
      "content": "15% off store except sale",
      "locations": [
        "CART_PAGE"
      ]
    }
  ]
}

Get 10% off order subtotal up to $25 (limited discount maximum)

Example request
{
  "can_be_used_with_other_promotions": true,
  "channels": [],
  "coupon_overrides_automatic_when_offering_higher_discounts": false,
  "currency_code": "USD",
  "current_uses": 0,
  "created_from": "api",
  "customer": {
    "group_ids": [],
    "minimum_order_count": 0,
    "segments": null,
    "excluded_group_ids": []
  },
  "end_date": null,
  "max_uses": null,
  "name": "Discount on order subtotal - percent",
  "notifications": [],
  "redemption_type": "AUTOMATIC",
  "rules": [
    {
      "action": {
        "cart_value": {
          "discount": {
            "percentage_amount": "10"
          },
          "maximum_allowed_discount_amount": "25"
        }
      },
      "apply_once": true,
      "stop": false
    }
  ],
  "schedule": null,
  "shipping_address": null,
  "start_date": "2025-10-15T00:00:00-05:00",
  "status": "ENABLED",
  "display_name": "Get 10% off order subtotal upto $25"
}